Sign in
Payments

List All Payments

Returns all individual payments matching the request criteria. This endpoint supports pagination and filtering on payment status, receiver ID, and timestamp. Each payment has details on the transaction itself, receiver, disbursement, asset, status history, and blockchain information.

get/payments

Query parameters

pagenumber

The page requested.

page_limitnumber

Define how many results will be returned in the response.

status'DRAFT' | 'READY' | 'PENDING' | 'PAUSED' | 'SUCCESS' | 'FAILED'

Exact match on the status of the payment.

receiver_idstring

UUID that represents a receiver in the database

created_at_afterstring

Only return payments that are created after this date. Format: YYYY-MM-DD

created_at_beforestring

Only return payments that are created before this date. Format: YYYY-MM-DD

sort'created_at'

Field used to sort payments

direction'asc' | 'desc'

Direction for sorting payments.

Response

A paginated list of payments

Example response

{
  "pagination": {
    "next": "?page=3&page_limit=2",
    "prev": "?page=1&page_limit=2",
    "pages": 8,
    "total": 16
  },
  "data": [
    {
      "id": "ddf22f55-3259-4822-a4e2-ce01334997f4",
      "amount": "100.00",
      "stellar_transaction_id": "0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b",
      "circle_transfer_request_id": "74a68b6a-3f67-424b-b8b0-e593a19d7463",
      "status_history": [
        {
          "timestamp": "2023-02-03T10:45:51Z"
        }
      ],
      "disbursement": {
        "id": "c51ba1d5-52d3-412f-a59c-6ef32d59ab43",
        "name": "disbursement-june-29",
        "created_at": "2023-06-30T01:22:57.831975Z",
        "updated_at": "2023-06-30T01:22:58.316511Z"
      },
      "asset": {
        "id": "ffaec4b3-46b0-4db4-a4c4-6c3508057705",
        "code": "USDC",
        "issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
        "created_at": "2023-02-03T10:45:51Z",
        "updated_at": "2023-02-03T10:45:51Z",
        "deleted_at": "2023-06-03T10:55:51Z"
      },
      "receiver_wallet": {
        "id": "803031d4-1d04-4879-b6d9-dc5641f9988e",
        "receiver": {
          "id": "029e2ed0-feb6-4c40-8b47-0836a85741a2"
        },
        "wallet": {
          "id": "5ada9ed5-455a-4782-a0ee-160767e0deb1",
          "name": "Vibrant Assist",
          "homepage": "https://vibrantapp.com"
        },
        "stellar_address": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
        "created_at": "2023-02-03T10:45:51.000Z",
        "updated_at": "2023-02-03T10:45:51.000Z"
      },
      "created_at": "2023-02-03T10:45:51Z",
      "updated_at": "2023-02-03T10:45:51Z"
    }
  ]
}

Changes