PApaycrest
Provider

List v2 payment orders (provider)

Changed on

Returns a paginated list of payment orders assigned to the authenticated provider, in the v2 response schema. Requires a currency query parameter. Supports optional direction (onramp / offramp), search, export=csv, from/to date filters, and ordering (asc/desc).

get/provider/orders

Request

  • Base URL
    https://api.paycrest.io/v2
  • URL
    https://api.paycrest.io/v2/provider/orders
  • Auth
    API key in header API-Key

Query parameters

currencystring required
Example:NGN

Fiat currency to filter orders by (e.g. NGN, KES).

pageinteger
pageSizeinteger
status'initiated' | 'deposited' | 'pending' | 'fulfilling' | 'fulfilled' | 'validated' | 'settling' | 'settled' | 'cancelled' | 'refunding' | 'refunded' | 'expired'
ordering'asc' | 'desc'
searchstring

Search by order ID, reference, or account identifier.

export'csv'

Pass export=csv with from and to to download a CSV export.

fromstring date

Start date for CSV export (YYYY-MM-DD). Required when export=csv.

tostring date

End date for CSV export (YYYY-MM-DD). Required when export=csv.

direction'onramp' | 'offramp'

Filter to on-ramp (fiat → crypto) or off-ramp (crypto → fiat). Omit to include both directions.

On stats endpoints, invalid values return 400 Bad Request. On list endpoints, values other than onramp or offramp are ignored (no direction filter).

HMAC (GET): the signed payload includes all query parameters—include direction when you send it (alongside timestamp, currency, etc.).

Response

Paginated list of orders

statusstring
messagestring

Changes

  • b2558cacb755Revision changes
    • breaking

      the //////// response's property type changed from object to no type for status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

      added the new tron enum value to the //////// response property for the response 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 write-only property data/orders/items/destination/oneOf[V2CryptoDestination]/kyc to the response with the status

    • info

      added the optional write-only property data/orders/items/destination/oneOf[V2CryptoDestination]/providerIds to the response with the status

    • info

      added the optional write-only property data/orders/items/destination/oneOf[V2FiatDestination]/providerIds to the response with the status

    • info

      added the optional write-only property data/orders/items/source/oneOf[V2CryptoSource]/kyc to the response with the status

    • info

      added to the //////// response property allOf list for the response status

    • info

      removed the lisk enum value from the ///////// response property for the response status

    • info

      removed the lisk enum value from the //////// response property for the response status

    • info

      removed the otc enum value from the /// response property for the response status

    • info

      removed the scroll enum value from the ///////// response property for the response status

    • info

      removed the scroll enum value from the //////// response property for the response status

    • info

      added the required write-only property data/orders/items/source/oneOf[V2FiatSource]/kyc to the response with the status