Skip to main content

Get a single transaction

GET 
/api/v1/transactions/:id

Retrieve a single transaction by id

Request​

Path Parameters

    id stringrequired

Header Parameters

    ApiKey stringrequired
    AccountId stringrequired

Responses​

OK

Schema
    walletId uuidrequired

    Wallet ID of the transaction

    id uuidrequired

    Unique ID of the transaction

    shortId stringrequired

    Short ID of the transaction

    externalId stringrequired

    External ID of the transaction

    type stringrequired

    Possible values: [PAYMENT, DEPOSIT, CHARGE, EXCHANGE, OTHER_CREDIT_DEBIT]

    Type of the transaction

    status objectrequired

    Status of the transaction

    state stringrequired

    Possible values: [FUNDS_REQUIRED, PENDING, AWAITING_APPROVAL, PROCESSING, SUCCESS, FAILED, REVERSED]

    State of the transaction

    reason string

    Reason for the transaction state

    complete boolean

    Completion status of the transaction

    amount objectrequired
    amount numberrequired

    The specific monetary value that is being converted from in the currency exchange

    currency stringrequired

    Possible values: Value must match regular expression [A-Z]{3}

    The type of currency that the money is being exchanged from

    deposit object

    Details of the deposit transaction

    senderAccountIdentifier stringrequired

    Sender's account identifier for the deposit

    senderName stringrequired

    Name of the sender for the deposit

    senderReference stringrequired

    Reference for the sender's deposit

    payment object

    Details of the payment transaction

    beneficiaryAccountIdentifier stringrequired

    Beneficiary's account identifier for the payment

    beneficiaryName stringrequired

    Name of the beneficiary for the payment

    paymentReference stringrequired

    Reference for the payment

    exchange object

    Details of the exchange transaction

    rate objectrequired

    Rate of the exchange

    price numberrequired
    currencyPair stringrequired
    type stringrequired

    Possible values: [BID, OFFER]

    from objectrequired
    amount numberrequired

    The specific monetary value that is being converted from in the currency exchange

    currency stringrequired

    Possible values: Value must match regular expression [A-Z]{3}

    The type of currency that the money is being exchanged from

    to objectrequired
    amount numberrequired

    The specific monetary value that is being converted from in the currency exchange

    currency stringrequired

    Possible values: Value must match regular expression [A-Z]{3}

    The type of currency that the money is being exchanged from

    charge object

    Details of the charge transaction

    chargeForTransactionId string

    Charge for the transaction ID

    createdAt date-timerequired

    Creation time of the transaction

    completedAt date-time

    Completion time of the transaction

Loading...