Get a transaction

Returns a single transaction record. A record belonging to another association responds 404, identically to one that does not exist.

GET /transactions/{transactionId}

Get a transaction

cURL

curl --request GET \
  --url https://api.zeam.money/gw/v1/transactions/{transactionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-zeam-auth: <api-key>'

200

{
  "transactionRecordId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "idempotencyKey": "<string>",
  "type": "<string>",
  "failureReason": "<string>",
  "errorCode": "<string>",
  "sendAmount": 123,
  "originalSendAmount": 123,
  "sendCurrency": "<string>",
  "receiveAmount": 123,
  "receiveCurrency": "<string>",
  "fee": 123,
  "feeCurrency": "<string>",
  "exchangeRate": 123,
  "sendingAsset": "<string>",
  "walletPublicKey": "<string>",
  "isP2pTransfer": true,
  "destinationStellarAddress": "<string>",
  "beneficiaryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "beneficiaryFirstName": "<string>",
  "beneficiaryLastName": "<string>",
  "connectorId": "<string>",
  "connectorName": "<string>",
  "method": "<string>",
  "destinationCountryIso": "<string>",
  "quoteId": "<string>",
  "stellarTxHash": "<string>",
  "externalReference": "<string>",
  "intentId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "legs": [
    {
      "legIndex": 123,
      "walletPublicKey": "<string>",
      "destinationStellarAddress": "<string>",
      "sendingAsset": "<string>",
      "amount": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

Access token issued by POST /v1/auth/token.

x-zeam-auth · string · header · required

Application secret (the apiKey issued at registration), required on every request.

Path Parameters

transactionId · string<uuid> · required

Transaction record identifier.

Response

200

application/json

The transaction record.

A transaction record. sendAmount/sendCurrency are the settlement-side figures (off-ramps may restate them in the connector settlement currency); originalSendAmount is the amount actually debited, denominated in sendingAsset.

transactionRecordId · string<uuid> · required

status · string · required

Lifecycle status, e.g. initiated, completed, failed, refund_completed.

idempotencyKey · string

type · string

Transaction type, e.g. p2p, swap, offramp.

failureReason · string

errorCode · string

sendAmount · number

originalSendAmount · number

sendCurrency · string

receiveAmount · number

receiveCurrency · string

fee · number

feeCurrency · string

exchangeRate · number

sendingAsset · string

walletPublicKey · string

isP2pTransfer · boolean

destinationStellarAddress · string

beneficiaryId · string<uuid>

beneficiaryFirstName · string

beneficiaryLastName · string

connectorId · string

connectorName · string

method · string

destinationCountryIso · string

quoteId · string

stellarTxHash · string

Set once the transaction is on-chain.

externalReference · string

intentId · string

createdAt · string<date-time>

updatedAt · string<date-time>

completedAt · string<date-time>

Set on terminal success.

legs · object[]

Present only on records created by POST /v1/payments/p2p/own/multi, in submitted order. For those, sendAmount is the gross sum of all legs; reconcile per wallet from the legs.

Show child attributes