Payments

Payment objects represent your customer's payment transactions. You can use them in conjunction with Payment Intents to process payments, or store them on Customer objects to retain transaction details and track any future changes, such as status updates.

Get all payments

This method retrieves a list of all payment transactions, including those that are completed, failed, or still in the post-initiation stage, providing an overview of all payment statuses.

get

Authorizations

tokenAuthjwtAuth

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

pageintegerOptional

A page number within the paginated result set.

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

get

/v1/transaction/payment/

HTTPcURLJavaScriptPython

GET /v1/transaction/payment/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "currency": "text",
      "base_amount": "text",
      "base_currency": "text",
      "fee": "text",
      "refunded": "text",
      "status": "pending",
      "refund": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "amount": "text",
          "currency": "text",
          "payment": "123e4567-e89b-12d3-a456-426614174000",
          "gateway_id": "text",
          "created": "2026-03-02T17:01:55.318Z"
        }
      ],
      "created": "2026-03-02T17:01:55.318Z"
    }
  ]
}

Get payment

This method fetches detailed information about a specific payment transaction using its unique identifier, allowing you to retrieve the current status, amount, and other relevant details for that payment.

get

Authorizations

tokenAuthjwtAuth

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstringRequired

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

amountstring · decimalRequiredPattern: ^-?\d{0,6}(?:\.\d{0,2})?$

currencystringRead-onlyRequired

base_amountstring · decimalOptionalPattern: ^-?\d{0,6}(?:\.\d{0,2})?$

base_currencystringRead-onlyRequired

feestringRead-onlyRequired

refundedstring · decimalOptionalPattern: ^-?\d{0,6}(?:\.\d{0,2})?$

statusstring · enumOptional

• pending - Pending
• partial - Partially Paid
• success - Success
• failed - Failed
• canceled - Canceled
• expired - Expired
• authorized - Authorized
• refunded - Refunded
• partial_refunded - Partially Refunded
• disputed - Disputed
• disputed_won - Disputed - Won
• disputed_lost - Disputed - Lost
• disputed_close - Disputed - Closed

Possible values:

createdstring · date-timeRead-onlyRequired

get

/v1/transaction/payment/{id}/

HTTPcURLJavaScriptPython

GET /v1/transaction/payment/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": "text",
  "currency": "text",
  "base_amount": "text",
  "base_currency": "text",
  "fee": "text",
  "refunded": "text",
  "status": "pending",
  "refund": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "currency": "text",
      "payment": "123e4567-e89b-12d3-a456-426614174000",
      "gateway_id": "text",
      "created": "2026-03-02T17:01:55.318Z"
    }
  ],
  "created": "2026-03-02T17:01:55.318Z"
}