List Transactions

GET 
https://api.immersve.com/api/accounts/:accountId/transactions

List card purchase transactions by account

This API uses cursor-based pagination. Start by making a request without a cursor to get the first page. Use the nextCursor from the pageInfo in the response as the cursor for subsequent requests to retrieve further pages. Continue until nextCursor is undefined, indicating no more data.

Request

Path Parameters

accountId stringrequired

accountId linked to transactions

Query Parameters

limit number

amount of records to return (max 1000)

cursor string

cursor to retrieve the next page

fromUTC string

Filter for transactions from this date (inclusive). Value should be a ISO 8601 string or RFC 2822 string

toUTC string

Filter for transactions up to this date (inclusive). Value should be a ISO 8601 string or RFC 2822 string

statuses string

Possible values: [all]

Filter for transaction status groups. By default the endpoint will return "holding" and "cleared" transactions. Passing "all" includes all statuses.

Responses

200

Successful operation

application/json

Schema

Schema

items

object[]

Array [

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, reversed]

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

feeAmount stringrequired

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

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

paymentType stringrequired

Possible values: [purchase, refund, adjustment]

The type of payment

relatedPaymentId string

The ID of the related payment transaction, if applicable

]

pageInfo

object

Page info for paginated results, undefined if no page info

nextCursor string

Cursor for next page, undefined if no more pages

Example (from schema)

{
  "items": [
    {
      "id": "1000000178145",
      "description": "Air NZ Online Auckland",
      "accountId": "225d85e65495722bf6517ea0ba0d6f56",
      "status": "init",
      "cardId": "6c474aa7a5dc45bff721b5a207cf0f47",
      "amount": "31412",
      "currency": "USD",
      "acquirerAmount": "31412",
      "acquirerCurrency": "NZD",
      "feeAmount": "12",
      "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",
      "paymentType": "purchase",
      "relatedPaymentId": "b297658d0cbac11"
    }
  ],
  "pageInfo": {
    "nextCursor": "dGhlIG5leHQgY3Vyc29yIGdvZXMgaGVyZQ=="
  }
}

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired

errors

object[]

Array [

message string

path string

The location of the invalid path param, query param or payload attribute.

]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

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"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://api.immersve.com/api/accounts/:accountId/transactions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://api.immersve.com

Auth

Security Scheme

Access TokenAccess Token and Target AccountApi Key and Api SecretApi Key and Api Secret and Target Account

Bearer Token

Parameters

accountId — pathrequired

limit — query

cursor — query

fromUTC — query

toUTC — query

statuses — query

---all

ResponseClear

Click the Send API Request button above and see the response here!