Sign in
Exports

Export Payments

Exports a CSV file of payments.

get/exports/payments

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

Changed in 3 of the 12 revisions of this API.45

  • 7588d8d2a3c71See the full diff
    • ○

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

      new-optional-request-parameter

  • b6f8a6e6555943See the full diff
    • ▲

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

      request-parameter-default-value-changed

    • ▲

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

      request-parameter-default-value-changed

    • ▲

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

      response-media-type-removed

    • ▲

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

      response-media-type-removed

    • ○

      added the new optional query request parameter q

      new-optional-request-parameter

    • ○

      added the new optional query request parameter type

      new-optional-request-parameter

    • ○

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

      request-parameter-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dc42844e575d1See the full diff
    • ○

      endpoint added

      endpoint-added