Skip to main content

Get Payment Details

GET 
/api/crypto-purchase/v2/payments

This endpoint retrieves the details of payments based on a list of external reference IDs (partner transaction IDs),list of session IDs, time period, and list of transaction statuses. If no params are provided, the last 10 payments will be returned. Payment details will appear in descending order of the creation date. The endpoint supports pagination. The default page size is 10, and the maximum page size is 20. Maximum retrieval period is 84 months.

Request​

Query Parameters

    page integer

    Possible values: >= 1 and <= 10000

    Default value: 1

    Page number for pagination.

    size integer

    Possible values: >= 1 and <= 20

    Default value: 10

    Number of records per page (page size).

    sessionIds string[]

    List of unique identifiers of crypto purchase session

    Example: 341b1fae-f62a-41f7-b7f2-5403ff2fddd9,bbcc4621-d88f-4a94-ae2f-b38072bf5087
    externalReferenceIds string[]

    List of unique external reference IDs for the payment (transaction ID from the partner's system)

    Example: bbcc4621-d88f-4a94-ae2f-b38072bf5087,341b1fae-f62a-41f7-b7f2-5403ff2fddd9
    statuses PaymentStatus[]

    Possible values: [PENDING, PAYABLE, CRYPTO_TRANSFER_PENDING, COMPLETED, FAILED]

    List of transaction statuses, based on which the partner transactions will be retrieved

    Example: PAYABLE,COMPLETED
    startDate date-time

    Start date and time of the transaction in ISO 8601 format (e.g., 2022-08-04T00:00:00+00:00 or 2022-08-04T00:00:00Z). Learn more

    endDate date-time

    End date and time of the transaction in ISO 8601 format (e.g., 2022-08-04T00:00:00+00:00 or 2022-08-04T00:00:00Z). Learn more

Responses​

OK

Schema

    content

    object[]

  • Array [

    • sessionId string

    Unique identifier of crypto purchase session

    externalReferenceId string

    External reference ID (transaction ID from the partner's system)

    sourceDetails

    object

    Source details - amount, currency and payment method

    amount number

    Source amount used for buying crypto

    currency string

    Source currency used for buying crypto

    paymentMethod PaymentMethod (string)

    Possible values: [CARD, BALANCE]

    The payment method used by the customer

    destinationDetails

    object

    amount number

    The amount of the purchased cryptocurrency

    currency string

    The cryptocurrency purchased

    network string

    The network used to process the cryptocurrency transaction

    walletAddress string

    Crypto wallet address that received the purchased funds

    walletAddressTag string

    Tag, memo, or any additional identifier of the wallet address

    totalSpend number

    Total amount spent for crypto after subtracting fees

    totalSpendCurrency string

    The currency of the crypto purchase

    destinationToSourceRate number

    The rate of the destination currency to the source currency.

    transactionHash string

    Id of the transaction on the blockchain.

    fees

    object[]

    Contains details on the fees for the payment - type, amount and currency of the fee

  • Array [

    • type string

    Possible values: [TRANSACTION, PARTNER, FX, NETWORK]

    Fee type:

    • FX - Applies when customer's fiat currency is not EUR
    • NETWORK - Goes to a blockchain network for transferring a digital asset on that network
    • TRANSACTION - Fee charged by Paysafe for the Transaction
    • PARTNER - Fee charged on top of the Transaction and FX fee, shared with the Skrill Referral Partner
    amount number

    Fee amount

    currency string

    Fee currency

  • ]

    • status PaymentStatus (string)

    Possible values: [PENDING, PAYABLE, CRYPTO_TRANSFER_PENDING, COMPLETED, FAILED]

    substatus PaymentSubStatus (string)

    Possible values: [WITHDRAWAL_FAILURE, RISK_FAILURE, RISK_SUCCESS, DEPOSIT_FAILURE, COUNTRY_NOT_ENABLED, EXPIRED]

  • ]

    • page integer
Loading...