CardTransaction

A card transaction.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

card_transactions, err := client.CardTransaction(nil).List(map[string]any{"card_token": "example", "profile_id": 1, "from_creation_time": "example", "to_creation_time": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(card_transactions)
card_transaction, err := client.CardTransaction(nil).Load(map[string]any{"id": 1, "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(card_transaction)

Lua

Construct client as shown in the Lua setup, then call the operations:

local card_transactions, err = client:CardTransaction():list({ card_token = "example", profile_id = 1, from_creation_time = "example", to_creation_time = "example" })
local card_transaction, err = client:CardTransaction():load({ id = 1, profile_id = 1 })

PHP

Construct client as shown in the PHP setup, then call the operations:

$card_transactions = $client->CardTransaction()->list(["card_token" => "example", "profile_id" => 1, "from_creation_time" => "example", "to_creation_time" => "example"]);
$card_transaction = $client->CardTransaction()->load(["id" => 1, "profile_id" => 1]);

Python

Construct client as shown in the Python setup, then call the operations:

card_transactions = client.CardTransaction().list({"card_token": "example", "profile_id": 1, "from_creation_time": "example", "to_creation_time": "example"})
card_transaction = client.CardTransaction().load({"id": 1, "profile_id": 1})

Ruby

Construct client as shown in the Ruby setup, then call the operations:

card_transactions = client.CardTransaction.list({ "card_token" => "example", "profile_id" => 1, "from_creation_time" => "example", "to_creation_time" => "example" })
card_transaction = client.CardTransaction.load({ "id" => 1, "profile_id" => 1 })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const card_transactions = await client.CardTransaction().list({ card_token: "example", profile_id: 1, from_creation_time: "example", to_creation_time: "example" })
const card_transaction = await client.CardTransaction().load({ id: 1, profile_id: 1 })

Fields

list

GET /spend/profiles/{profileId}/cards/{cardToken}/transactions

Operation ID: cardTransactionList.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Card transactions retrieved successfully

application/json

Example response:

{
  "transactions": [
    {
      "approvalCode": "913647",
      "arn": "04300014127798385983852",
      "authorisationMethod": "MANUAL_ENTRY",
      "balanceChannelReferenceId": "6e71018d-2f4d-4fc3-6711-f517f4664712",
      "billingAmount": {
        "amount": 1.1,
        "currency": "EUR"
      },
      "cardToken": "59123122-223d-45f9-b840-0ad4a4f80937",
      "creationTime": "2022-11-28T08:17:54.241Z",
      "declineReason": null,
      "fees": [
        {
          "amount": 0.1,
          "currency": "SGD",
          "fee_type": "ATM_MACHINE"
        }
      ],
      "id": 342671,
      "merchant": {
        "category": {
          "code": "5999",
          "description": "5999 R Miscellaneous and Special",
          "name": "MISCELLANEOUS_FOOD_STORES_CONVEN"
        },
        "location": {
          "city": "Rouen",
          "country": "France",
          "region": null,
          "state": null,
          "zipCode": "00000"
        },
        "name": "Test Payment"
      },
      "modificationTime": "2022-11-28T08:17:54.241Z",
      "pinValidationResult": "ONLINE_PIN_VALIDATED",
      "purgeTime": "2022-11-28T08:17:54.241Z",
      "state": "IN_PROGRESS",
      "transactionAmount": {
        "amount": 1.4,
        "currency": "SGD"
      },
      "transactionAmountWithFees": {
        "amount": 1.5,
        "currency": "SGD"
      },
      "type": "ECOM_PURCHASE"
    }
  ]
}

400: Invalid request

application/problem+json

422: Unprocessable request

application/problem+json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

load

GET /spend/profiles/{profileId}/cards/transactions/{transactionId}

Operation ID: cardTransactionGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Card transaction retrieved successfully

application/json

404: Not found

application/problem+json

422: Unprocessable request

application/problem+json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.