Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Carry1st Payments API

Create payment requests and query their status.

Carry1st Payments API is one of 4 APIs that Carry1st publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 4.0.

Requests are made against 2 base URLs: https://api-gateway.carry1st.com, https://api-gateway.platform.stage.carry1st.com.

2 operations 2 paths 7 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0
Base URL
https://api-gateway.carry1st.com
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

Carry1st Payments API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as AccessToken (accessToken).

  • basicAuth — Base64(APIKEY:APISECRET) used only on the auth/token and auth/refresh endpoints.
  • accessToken — Bearer issued by generateAccessToken; required on all Gateway API requests.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 2

Create payment requests and query their status.

POST
/api/pay1st/payments/create
Create Payment Request
createPaymentRequest 2 params body → 201400401
GET
/api/pay1st/payments
Query Payment Status
queryPaymentStatus 1 param → 200400401403429

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are CreatePaymentRequest (11 properties), PaymentResponse (6 properties), Product (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Metadata
object
2 properties
PaymentDetail
PaymentStatus
string
Payment lifecycle status.
PaymentResponse
object
6 properties
Product
object
5 properties
CreatePaymentRequest
object
11 properties 6 required
Error
object
Standard Pay1st error envelope.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

carry1st-payments-api-openapi.yml Raw ↑

Other APIs Carry1st publishes across the network.

Carry1st Authentication API
Carry1st Payment Methods API
Carry1st Refunds API