STstellar
Payments

List All Payments

Changed on

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

get/payments

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Query parameters

pagenumber

The page requested.

qstring

Search payments by ID, external_payment_id, receiver wallet address, or disbursement name.

type'DIRECT' | 'DISBURSEMENT'

Type of payments

page_limitnumber

Define how many results will be returned in the response.

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

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'updated_at' | 'created_at'

Field used to sort payments

direction'asc' | 'desc'

Direction for sorting payments.

Headers

X-Wallet-Idstring

Optional. Narrows the results to a single distribution account. Omit it to cover every account you have access to.

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_transaction_id": "74a68b6a-3f67-424b-b8b0-e593a19d7463",
      "circle_transaction_type": "TRANSFER",
      "source_wallet_id": "4c379f5e-09b5-4472-a286-b84e249a1512",
      "status_history": [
        {
          "timestamp": "2023-02-03T10:45:51Z"
        }
      ],
      "disbursement": {
        "id": "c51ba1d5-52d3-412f-a59c-6ef32d59ab43",
        "name": "disbursement-june-29",
        "receiver_registration_message_template": "You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.",
        "status_history": [
          {
            "user_id": "3f351b9e-ed0f-40fa-a314-14757b42dab1",
            "timestamp": "2023-02-03T10:45:51Z"
          }
        ],
        "file_name": "disbursement-feb-03-2023.csv",
        "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",
          "sep_10_client_domain": "api-dev.vibrantapp.com",
          "deep_link_schema": "https://vibrantapp.com/sdp-dev",
          "enabled": true
        },
        "stellar_address": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
        "created_at": "2023-02-03T10:45:51.000Z",
        "updated_at": "2023-02-03T10:45:51.000Z",
        "invitation_sent_at": "2023-02-09T10:45:51.000Z",
        "status_history": [
          {
            "timestamp": "2023-02-10T10:45:51Z"
          }
        ],
        "otp_confirmed_at": "2023-02-10T10:45:51Z"
      },
      "external_payment_id": "payment-001",
      "created_at": "2023-02-03T10:45:51Z",
      "updated_at": "2023-02-03T10:45:51Z"
    }
  ]
}

Changes

  • 7588d8d2a3c7Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      added the new CANCELED enum value to the /// response property for the response status

    • warning

      added the new CANCELED enum value to the ///// response property for the response status

    • info

      added the new optional header request parameter X-Wallet-Id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • b6f8a6e65559Revision changes
    • breaking

      for the query request parameter direction, default value was changed from asc to desc

    • breaking

      for the query request parameter sort, default value was changed from created_at to updated_at

    • breaking

      removed the enum value direct from the query request parameter type

    • breaking

      removed the enum value disbursement from the query request parameter type

    • info

      added the new optional query request parameter q

    • info

      added the new enum value CANCELED to the query request parameter status

    • info

      added the new enum value DIRECT to the query request parameter type

    • info

      added the new enum value DISBURSEMENT to the query request parameter type

    • info

      added the new enum value updated_at to the query request parameter sort

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status