Skip to main content

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.

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

A paginated list of payments


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
  • ]
Loading...