Skip to main content
TransactionsVersion: 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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:payments/transactions.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

transactionIdstringrequired

ID of the transaction that needs to be returned

Example:61dd0feac077f72010f78804

Query Parameters

locationIdstring

LocationId is the id of the sub-account.

Example:3SwdhCu3svxI8AKsPJt6
altIdstringrequired

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

Example:3SwdhCu3svxI8AKsPJt6
altTypestringrequired

AltType is the type of identifier.

Example:location

Response

Successful response

_idstringrequired

The unique identifier for the transaction.

Example:61dd0feac077f72010f78804
altTypestringrequired

AltType is the type of identifier.

Example:location
altIdstringrequired

AltId is the unique identifier eg: location id.

Example:3SwdhCu3svxI8AKsPJt6
contactIdstring

Contact id corresponding to the transaction.

Example:XPLSw2SVagl12LMDeTmQ
contactSnapshotobject

Contact details of the transaction.

Example:{ last_name: "Mcclain", type: "lead", first_name_lower_case: "rogan", email: "[email protected]", last_name_lower_case: "mcclain", location_id: "o6241QsiRwUIJHyjuhos", company_name: "Jordan and Cox Trading"}
currencystring

Currency in which transaction was made.

Example:USD
amountnumber

Transaction value.

Example:100
statusobject

Transaction status.

Example:succeeded
liveModeboolean

Transaction is in live / test mode.

Example:false
createdAtstring<date-time>required

The creation timestamp of the transaction.

Example:2023-11-20T10:23:36.515Z
updatedAtstring<date-time>required

The last update timestamp of the transaction.

Example:2024-01-23T09:57:04.846Z
entityTypestring

Entity type of transaction (eg: order).

Example:order
entityIdstring

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

Example:61dd0fe9c077f73e67f78803
entitySourceobject

Entity source details for the transaction.

chargeIdstring

Charge id for transaction.

Example:in_1KGcXDCScnf89tZohCsmImwE
chargeSnapshotobject

Charge snapshot of transaction.

Example:{ id: "in_1KGcXDCScnf89tZohCsmImwE", object: "invoice", account_country: "US", account_name: "GHL-Testing" }
invoiceIdstring

Invoice id for the transaction.

Example:in_1KGcXDCScnf89tZohCsmImwE
subscriptionIdstring

Subscription id for transaction.

Example:sub_1KGcXDCScnf89tZoVkoEMCEL
paymentProviderobject

Payment provider details of the transaction.

Example:{ type: "stripe", connectedAccount: { _id: "612ca676b484b241fef9d962", accountId: "acct_1Ihw53CScnf89tZo" } }
ipAddressstring

Ip address from where transaction was initiated.

Example:107.178.194.224
metaobject

Meta details of the transaction.

Example:{ stepId: "af7c731e-e36f-4152-bd1a-3f69a31d6d6d", pageId: "A8ltotc2jZxurJba4e3Y", pageUrl: "/v2/preview/A8ltotc2jZxurJba4e3Y" }
markAsTestboolean

Is test transaction.

Example:false
isParentboolean

Is parent transaction.

Example:false
amountRefundednumber

Transaction amount refunded.

Example:10
receiptIdstring

Receipt id for transaction.

Example:6492fbea489bc07892c6defb
qboSyncedboolean

Is transaction qbo synced.

Example:false
qboResponseobject

Qbo details of the transaction.

Example:{ domain: "QBO", sparse: false, Id: "180", SyncToken: "0", TotalAmt: 25 }
traceIdstring

Trace id of the transaction.

Example:d3b16a92-a8ed-4e6b-8467-844750f78ed5
mergedFromContactIdstring

ID of the contact that was merged from.

Example:XPLSw2SVagl12LMDeTmQ
createdBystring

User ID who created the transaction.

Example:user123