List All Payments

GET 
/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.

Request

Query Parameters

page number

Default value: 1

The page requested.

page_limit number

Default value: 20

Define how many results will be returned in the response.

status string
Possible values: [DRAFT, READY, PENDING, PAUSED, SUCCESS, FAILED]
Exact match on the status of the payment.
Example: DRAFT
receiver_id string
UUID that represents a receiver in the database
Example: b6b667ad-6cc2-46cf-9be7-561daace7d48
created_at_after string
Only return payments that are created after this date. Format: YYYY-MM-DD
Example: 2006-01-02
created_at_before string
Only return payments that are created before this date. Format: YYYY-MM-DD
Example: 2006-01-02
sort string

Possible values: [created_at]

Default value: created_at

Field used to sort payments

direction string

Possible values: [asc, desc]

Default value: asc

Direction for sorting payments.

Responses

200

A paginated list of payments

application/json

Schema

Schema

pagination object
next string
prev string
pages integer
total integer
data object[]
Array [
id string
amount string
stellar_transaction_id string
stellar_operation_id string
status string
Possible values: [DRAFT, READY, PENDING, PAUSED, SUCCESS, FAILED]
status_history object[]
Array [
status string
Possible values: [DRAFT, READY, PENDING, PAUSED, SUCCESS, FAILED]
status_message string
timestamp date-time
]
disbursement object
id uuid
The unique identifier of the disbursement
name string
The name of the disbursement
status string
Possible values: [DRAFT, READY, STARTED, PAUSED, COMPLETED]
created_at date-time
The creation timestamp of the disbursement
updated_at date-time
The last update timestamp of the disbursement
asset object
id string
code string
Asset code
issuer string
Asset issuer address
created_at date-time
updated_at date-time
deleted_at date-time
receiver_wallet object
id string
receiver object
id string
wallet object
id string
name string
homepage string
stellar_address string
created_at string
updated_at string
status string
Possible values: [DRAFT, READY, REGISTERED, FLAGGED]
created_at date-time
updated_at date-time
]

Example (from schema)

{
  "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",
      "stellar_operation_id": "string",
      "status": "DRAFT",
      "status_history": [
        {
          "status": "DRAFT",
          "status_message": "string",
          "timestamp": "2023-02-03T10:45:51.000Z"
        }
      ],
      "disbursement": {
        "id": "c51ba1d5-52d3-412f-a59c-6ef32d59ab43",
        "name": "disbursement-june-29",
        "status": "DRAFT",
        "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:51.000Z",
        "updated_at": "2023-02-03T10:45:51.000Z",
        "deleted_at": "2023-06-03T10:55:51.000Z"
      },
      "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",
        "status": "DRAFT"
      },
      "created_at": "2023-02-03T10:45:51.000Z",
      "updated_at": "2023-02-03T10:45:51.000Z"
    }
  ]
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

error string
extras object
status number
message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

response

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

403

Forbidden

Response Headers

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

response

{
  "error": "Forbidden"
}

Loading...