Saltar al contenido principal

GetPaymentHistoryResponse

successbooleanrequired

It is true when Basilic read the payment history.

Example: true
data objectrequired

Payment history of the temporary payment link.

tempLinkIdintegerrequired

Identifier of the temporary payment link that holds these payments.

Example: 123
payments object[]required

Payments of the temporary payment link, from the most recent to the oldest.

  • Array [
  • iduuidrequired

    Unique identifier of the payment.

    Example: 3f2b7c1e-0a4d-4f9b-9c6a-8d1e2f3a4b5c
    amountdecimalrequired

    Amount of the payment, in the currency of currency.

    Example: 150
    currencystringrequired

    Currency of the amount of the payment, as an ISO 4217 code.

    Example: USD
    statusstringrequired

    Status of the payment.

    Example: completed
    paymentMethodstringrequired

    Family of the method that paid. crypto is a payment on a blockchain. bank_transfer is a transfer through an international rail. argentine_bank is a transfer in Argentine pesos into a CVU. Read paymentRail for the rail that carried the money.

    Possible values: [crypto, bank_transfer, credit_card, argentine_bank]

    Example: bank_transfer
    paymentRailstringnullablerequired

    Rail that carried the money. It is null for a payment on a blockchain, and it is null when the rail of a transfer is unknown. cvu is the rail of an Argentine peso transfer, and the other values are the rails of an international transfer.

    Possible values: [ach, wire, pix, spei, transfers, pse, cvu]

    Example: spei
    transactionHashstringnullablerequired

    Blockchain transaction hash (for crypto payments)

    Example: 0x1234567890abcdef...
    approvedQuoteAmountdecimalnullablerequired

    Amount of the token that the client approved for the payment. It is null when the payment holds no approved quote.

    Example: 150.25
    approvedQuoteTokenstringnullablerequired

    Symbol of the token of approvedQuoteAmount. It is null when the payment holds no approved quote.

    Example: USDT
    createdAtdate-timerequired

    Time at which Basilic created the payment.

    Example: 2025-01-01T12:00:00.000Z
    updatedAtdate-timerequired

    Time of the last change of the payment. A payment that never changed after its creation keeps the value of createdAt.

    Example: 2025-01-01T12:30:00.000Z
  • ]
  • totalPaymentsintegerrequired

    Number of payments in payments. The endpoint returns every payment, thus it does not paginate.

    Example: 2
    GetPaymentHistoryResponse
    {
    "success": true,
    "data": {
    "tempLinkId": 123,
    "payments": [
    {
    "id": "3f2b7c1e-0a4d-4f9b-9c6a-8d1e2f3a4b5c",
    "amount": 150,
    "currency": "USD",
    "status": "completed",
    "paymentMethod": "bank_transfer",
    "paymentRail": "spei",
    "transactionHash": "0x1234567890abcdef...",
    "approvedQuoteAmount": 150.25,
    "approvedQuoteToken": "USDT",
    "createdAt": "2025-01-01T12:00:00.000Z",
    "updatedAt": "2025-01-01T12:30:00.000Z"
    }
    ],
    "totalPayments": 2
    }
    }