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/v1/transaction/payment/

Authorization

tokenAuthjwtAuth

Query parameters

Response

200

Body

application/json

count*integer

Example: 123

nextnullable string (uri)

Example: "http://api.example.org/accounts/?page=4"

previousnullable string (uri)

Example: "http://api.example.org/accounts/?page=2"

results*array of Payment (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1/transaction/payment/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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",
      "refunded": "text",
      "currency": "text",
      "status": "pending",
      "payment_intent": "123e4567-e89b-12d3-a456-426614174000",
      "created": "2025-01-22T19:04:50.778Z"
    }
  ]
}

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/v1/transaction/payment/{id}/

Authorization

tokenAuthjwtAuth

Path parameters

id*string

Response

200

Body

application/json

id*string (uuid)

amount*string (decimal)

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

refundedstring (decimal)

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

currency*string

statusStatusEnum (enum)

• pending - Pending
• partial - Partially Paid
• success - Success
• failed - Failed
• cancelled - Cancelled
• expired - Expired
• authorized - Authorized
• refunded - Refunded
• partial_refunded - Partially Refunded

pendingpartialsuccessfailedcancelledexpiredauthorizedrefundedpartial_refunded

payment_intent*string (uuid)

created*string (date-time)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1/transaction/payment/{id}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": "text",
  "refunded": "text",
  "currency": "text",
  "status": "pending",
  "payment_intent": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2025-01-22T19:04:50.778Z"
}