Skip to main content
Version: v3

Get Transaction by ID

GET 
/payments/transactions/:transactionId

The "Get Transaction by ID" API allows to retrieve information for a specific transaction using its unique identifier. Use this endpoint to fetch details for a single transaction based on the provided transaction ID.

Request​

Version stringrequired

API Version

Available optionsv3
transactionId stringrequired

ID of the transaction that needs to be returned

locationId string

LocationId is the id of the sub-account.

altId stringrequired

AltId is the unique identifier e.g: location id.

altType stringrequired

AltType is the type of identifier.

application/json

Successful response

Schema
    _idstringrequired

    The unique identifier for the transaction.

    altTypestringrequired

    AltType is the type of identifier.

    altIdstringrequired

    AltId is the unique identifier eg: location id.

    contactIdstring

    Contact id corresponding to the transaction.

    contactSnapshotobject

    Contact details of the transaction.

    currencystring

    Currency in which transaction was made.

    amountnumber

    Transaction value.

    statusobject

    Transaction status.

    liveModeboolean

    Transaction is in live / test mode.

    createdAtstring<date-time>required

    The creation timestamp of the transaction.

    updatedAtstring<date-time>required

    The last update timestamp of the transaction.

    entityTypestring

    Entity type of transaction (eg: order).

    entityIdstring

    Entity id for the transaction. e.g: order id

    entitySourceobject

    Entity source details for the transaction.

    chargeIdstring

    Charge id for transaction.

    chargeSnapshotobject

    Charge snapshot of transaction.

    invoiceIdstring

    Invoice id for the transaction.

    subscriptionIdstring

    Subscription id for transaction.

    paymentProviderobject

    Payment provider details of the transaction.

    ipAddressstring

    Ip address from where transaction was initiated.

    metaobject

    Meta details of the transaction.

    markAsTestboolean

    Is test transaction.

    isParentboolean

    Is parent transaction.

    amountRefundednumber

    Transaction amount refunded.

    receiptIdstring

    Receipt id for transaction.

    qboSyncedboolean

    Is transaction qbo synced.

    qboResponseobject

    Qbo details of the transaction.

    traceIdstring

    Trace id of the transaction.

    mergedFromContactIdstring

    ID of the contact that was merged from.

    createdBystring

    User ID who created the transaction.