STstellar
Exports

Export Payments

Changed on

Exports a CSV file of payments.

get/exports/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

qstring

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

type'DIRECT' | 'DISBURSEMENT'

Type of payments

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

The status of the payment

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

CSV file of payments

Changes

  • 7588d8d2a3c7Revision changes
    • info

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

  • 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 media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • info

      added the new optional query request parameter q

    • info

      added the new optional query request parameter type

    • info

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