v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
card-transaction

Get card transaction

Retrieve a card transaction by its ID.

Use in conjunction with the card transaction state change webhook for versions V2.1.0 and later.

{% admonition type="warning" %} Only transactions created in the past 90 days can be accessed. A 422 error code will be returned otherwise. {% /admonition %}

When a refund happens, a separate transaction will be added with a REFUND transaction type.

get/v4/spend/profiles/{profileId}/cards/transactions/{transactionId}

Path parameters

profileIdinteger required

The ID of the profile that owns the card.

transactionIdinteger required

The ID of the transaction.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

Card transaction retrieved successfully.

idinteger

ID of the transaction

cardTokenstring

Unique identifier of the card

type'ACCOUNT_CREDIT' | 'ACCOUNT_FUNDING' | 'CASH_ADVANCE' | 'CASH_WITHDRAWAL' | 'CHARGEBACK' | 'CREDIT_TRANSACTION' | 'ECOM_PURCHASE' | 'POS_PURCHASE' | 'REFUND'

Type of the transaction. One of:

  • ACCOUNT_CREDIT
  • ACCOUNT_FUNDING
  • CASH_ADVANCE
  • CASH_WITHDRAWAL
  • CHARGEBACK
  • CREDIT_TRANSACTION
  • ECOM_PURCHASE
  • POS_PURCHASE
  • REFUND
state'IN_PROGRESS' | 'COMPLETED' | 'DECLINED' | 'CANCELLED' | 'UNKNOWN'

The current state of the transaction. One of:

  • IN_PROGRESS
  • COMPLETED
  • DECLINED
  • CANCELLED
  • UNKNOWN
declineReasonstring nullable

Code of the decline reason if applicable

detailedDeclineReasonstring nullable

Code of the detailed decline reason if applicable

creationTimestring date-time

When the transaction was created

modificationTimestring date-time

When the transaction was last updated

purgeTimestring date-time nullable

Time at which reserved funds will be released after the authorisation hold expires

authorisationMethodstring

Authorisation method

approvalCodestring nullable

Also called authorization code. This can be used to prove ownership of a customer's card/account to a merchant

arnstring nullable

Acquirer reference number

pinValidationResult'ONLINE_PIN_VALIDATED' | 'ONLINE_PIN_INVALID' | 'OFFLINE_PIN_VALIDATED' | 'OFFLINE_PIN_INVALID' | 'NOT_RECEIVED' nullable

PIN validation result. One of:

  • ONLINE_PIN_VALIDATED
  • ONLINE_PIN_INVALID
  • OFFLINE_PIN_VALIDATED
  • OFFLINE_PIN_INVALID
  • NOT_RECEIVED
balanceChannelReferenceIdstring nullable

Balance channel reference ID associated with the card transaction

Example response

{
  "id": 342671,
  "cardToken": "59123122-223d-45f9-b840-0ad4a4f80937",
  "type": "ECOM_PURCHASE",
  "state": "IN_PROGRESS",
  "creationTime": "2022-11-28T08:17:54.241Z",
  "modificationTime": "2022-11-28T08:17:54.241Z",
  "purgeTime": "2022-11-28T08:17:54.241Z",
  "transactionAmount": {
    "amount": 1.4,
    "currency": "SGD"
  },
  "fees": [
    {
      "amount": 0.1,
      "currency": "SGD",
      "fee_type": "ATM_ACQUIRER"
    }
  ],
  "transactionAmountWithFees": {
    "amount": 1.5,
    "currency": "SGD"
  },
  "merchant": {
    "name": "Test Payment",
    "location": {
      "country": "France",
      "city": "Rouen",
      "zipCode": "00000"
    },
    "category": {
      "name": "MISCELLANEOUS_FOOD_STORES_CONVEN",
      "code": "5999",
      "description": "5999 R Miscellaneous and Special"
    }
  },
  "authorisationMethod": "MANUAL_ENTRY",
  "approvalCode": "913647",
  "billingAmount": {
    "amount": 1.1,
    "currency": "EUR"
  },
  "arn": "04300014127798385983852",
  "pinValidationResult": "ONLINE_PIN_VALIDATED",
  "balanceChannelReferenceId": "6e71018d-2f4d-4fc3-6711-f517f4664712",
  "debits": [
    {
      "balanceId": 52832,
      "debitedAmount": {
        "amount": 1.1,
        "currency": "EUR"
      },
      "forAmount": {
        "amount": 1.5,
        "currency": "SGD"
      },
      "rate": 1.36363636364,
      "fee": {
        "amount": 0.04,
        "currency": "EUR"
      },
      "creationTime": "2022-11-28T08:17:54.241Z"
    }
  ],
  "credits": [
    {
      "balanceId": 52832,
      "creditedAmount": {
        "amount": 1.5,
        "currency": "SGD"
      },
      "creationTime": "2022-11-28T08:17:54.241Z"
    }
  ],
  "relayAuthorisationData": {
    "responseCode": "APPROVED",
    "fallback": true
  }
}