Get a transaction

GET 
/api/transactions/:transactionId

This endpoint returns the details of a card purchase transaction by a given ID.

Request

Path Parameters

transactionId stringrequired

Primary identifier of the transaction to fetch

Responses

200

application/json

Schema

Schema

id stringrequired

The transaction ID

description stringrequired

A description of the transaction

accountId stringrequired

Which account this transaction belongs to

status stringrequired

Possible values: [init, holding, cleared, failed]

The status of the transaction

cardId stringrequired

Which card this transaction belongs to

amount stringrequired

The billing amount of the transaction, an integer in the smallest denomination for the given currency

currency stringrequired

The billing currency of the transaction

acquirerAmount stringrequired

The acquirer amount of the transaction, an integer in the smallest denomination for the given currency

acquirerCurrency stringrequired

The acquirer currency of the transaction

lockedFundCurrency stringrequired

The locked funds' currency of the transaction

feeAmount stringrequired

The fee amount of the transaction

chain stringrequired

The chain of the locked funds on

transactionDate date-timerequired

The created date formatted in ISO of the transactions

processedDate date-time

The cleared date formatted in ISO of the transactions

reference stringrequired

The reference used when making an enquiry through customer support

cardAcceptor

object

required

city stringrequired

The city of the card acceptor

countryCode stringrequired

The country code of the card acceptor

name stringrequired

The name of the card acceptor

creditDebitIndicator string

Possible values: [credit, debit]

Indicates if the transaction was a credit or debit

web3Transactions

object[]

required

Array [

type stringrequired

Possible values: [debit, credit]

The type of the web3 transaction:

• debit - The transaction is from the cardholders’ balance to Immersve balance
• credit - The transaction is from Immersve balance to cardholders’ balance

hash stringrequired

The hash of the web3 transaction

transactionId string

The associated credit card transaction ID

transactionType string

Possible values: [authorization, clearing, reversal]

The associated credit card transaction type

]

panFirst6 stringrequired

The first 6 digits of the card's PAN

panLast6 string

The last 4 digits of the card's PAN

Example (from schema)

{
  "id": "1000000178145",
  "description": "Air NZ Online Auckland",
  "accountId": "225d85e65495722bf6517ea0ba0d6f56",
  "status": "init",
  "cardId": "6c474aa7a5dc45bff721b5a207cf0f47",
  "amount": "31412",
  "currency": "USD",
  "acquirerAmount": "31412",
  "acquirerCurrency": "NZD",
  "lockedFundCurrency": "USDC",
  "feeAmount": "12",
  "chain": "Polygon",
  "transactionDate": "2022-11-09T03:24:15.182Z",
  "processedDate": "2022-11-09T03:24:15.182Z",
  "reference": "1000000178145",
  "cardAcceptor": {
    "city": "Auckland",
    "countryCode": "NZ",
    "name": "Air NZ Online"
  },
  "creditDebitIndicator": "credit",
  "web3Transactions": [
    {
      "type": "debit",
      "hash": "0x6f87ad90847828cb8575bd8f3c9a9cdde12a2e53e047604b6012f156495cce1e",
      "transactionId": "1000000178145",
      "transactionType": "authorization"
    }
  ],
  "panFirst6": "123456",
  "panLast6": "1234"
}

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
errors string[]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "BAD_REQUEST",
  "errors": [
    "Expected string, received number"
  ]
}

403

No Authorization to access resource.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...