Payments

Financial transactions, orders, refunds, and payment processing.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

paymentIdstringRequiredExample: 1d81ceb3-b04f-43e3-a4d2-f249fe537cd4

Responses

200

Returns a Payment

application/json

idstringRead-onlyRequired

typestring · enumRead-onlyRequiredPossible values:

currencystringRead-onlyRequired

A three letter code in upper case as described in https://www.iso.org/iso-4217-currency-codes.html

authorizedAmountnumberRead-onlyRequired

capturedAmountnumberRead-onlyRequired

refundAmountnumberRead-onlyRequired

refundVirtualCreditsnumberRead-onlyRequired

statusstring · enumRead-onlyRequiredPossible values:

createdDatestring · date-timeRead-onlyRequired

captureDatestring · date-timeRead-onlyRequired

_linksobjectRequired

get/payments/{paymentId}

GET /apis/v2/payments/{paymentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns a Payment

{
  "id": "text",
  "type": "CASH",
  "stripe": {
    "id": "text",
    "paymentId": "text",
    "failureCode": "text",
    "failureMessage": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "amount": 1,
    "description": "text",
    "statementDescriptor": "text",
    "status": "text",
    "outcome": {
      "status": "text",
      "networkStatus": "text",
      "reason": "text",
      "riskLevel": "text",
      "sellerMessage": "text",
      "type": "text"
    },
    "card": {
      "id": "text",
      "status": "text",
      "stripe": {
        "paymentMethodId": "text"
      },
      "brand": "text",
      "numberPreview": "text",
      "expirationMonth": 1,
      "expirationYear": 1,
      "funding": "text",
      "_links": {
        "self": {
          "href": "text"
        }
      }
    },
    "bankAccount": {
      "id": "text",
      "bankName": "text",
      "accountHolderType": "text",
      "last4": "text"
    },
    "paymentElement": {
      "id": "text"
    },
    "_links": {}
  },
  "currency": "text",
  "authorizedAmount": 1,
  "capturedAmount": 1,
  "refundAmount": 1,
  "refundVirtualCredits": 1,
  "status": "CAPTURED",
  "createdDate": "2026-01-01T00:00:00.000Z",
  "captureDate": "2026-01-01T00:00:00.000Z",
  "user": {
    "id": "text"
  },
  "_links": {}
}

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

paymentIdstringRequiredExample: 1d81ceb3-b04f-43e3-a4d2-f249fe537cd4

stripePaymentIdstringRequiredExample: pi_1I6t4v2eZvKYlo2CJq1tX3Zz

Responses

200

Returns a StripePayment

application/json

idstringRead-onlyRequired

typestring · enumRead-onlyRequiredPossible values:

currencystringRead-onlyRequired

A three letter code in upper case as described in https://www.iso.org/iso-4217-currency-codes.html

authorizedAmountnumberRead-onlyRequired

capturedAmountnumberRead-onlyRequired

refundAmountnumberRead-onlyRequired

refundVirtualCreditsnumberRead-onlyRequired

statusstring · enumRead-onlyRequiredPossible values:

createdDatestring · date-timeRead-onlyRequired

captureDatestring · date-timeRead-onlyRequired

_linksobjectRequired

get/payments/{paymentId}/stripe/{stripePaymentId}

GET /apis/v2/payments/{paymentId}/stripe/{stripePaymentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns a StripePayment

{
  "id": "text",
  "type": "CASH",
  "stripe": {
    "id": "text",
    "paymentId": "text",
    "failureCode": "text",
    "failureMessage": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "amount": 1,
    "description": "text",
    "statementDescriptor": "text",
    "status": "text",
    "outcome": {
      "status": "text",
      "networkStatus": "text",
      "reason": "text",
      "riskLevel": "text",
      "sellerMessage": "text",
      "type": "text"
    },
    "card": {
      "id": "text",
      "status": "text",
      "stripe": {
        "paymentMethodId": "text"
      },
      "brand": "text",
      "numberPreview": "text",
      "expirationMonth": 1,
      "expirationYear": 1,
      "funding": "text",
      "_links": {
        "self": {
          "href": "text"
        }
      }
    },
    "bankAccount": {
      "id": "text",
      "bankName": "text",
      "accountHolderType": "text",
      "last4": "text"
    },
    "paymentElement": {
      "id": "text"
    },
    "_links": {}
  },
  "currency": "text",
  "authorizedAmount": 1,
  "capturedAmount": 1,
  "refundAmount": 1,
  "refundVirtualCredits": 1,
  "status": "CAPTURED",
  "createdDate": "2026-01-01T00:00:00.000Z",
  "captureDate": "2026-01-01T00:00:00.000Z",
  "user": {
    "id": "text"
  },
  "_links": {}
}