CHcheckout
Transactions

Get a single transaction

<span style="font-size: 12px; font-weight: 500; color: rgb(0, 0, 0); background-color: rgb(255, 176, 97); border-radius: 4px; padding: 2px 6px" >Beta</span><p></p> Get the details of a transaction using its ID.

get/issuing/transactions/{transactionId}

Request

Path parameters

transactionIdstring required

The transaction's unique identifier.

Example:trx_aayhhfwbdyxwcaeyhhfwbd4xga

Response

Issuing transaction retrieved successfully

idstring

The transaction's unique identifier.

created_onstring date-time

The date/time the transaction was created.

status'authorized' | 'declined' | 'canceled' | 'cleared' | 'refunded' | 'disputed'

The high-level status indicating the stage of the transaction lifecycle.

transaction_type'account_funding' | 'account_transfer' | 'atm_installment' | 'balance_inquiry' | 'bill_payment' | 'cash_advance' | 'cashback' | 'credit_adjustment' | 'debit_adjustment' | 'original_credit' | 'payment_account_inquiry' | 'payment' | 'pin_change' | 'pin_unblock' | 'purchase_account_inquiry' | 'purchase' | 'quasi_cash' | 'remittance_funding' | 'remittance_payment' | 'unknown' | 'withdrawal' | 'refund'

The high-level nature of the transaction.

Example response

{
  "id": "trx_aayhhfwbdyxwcaeyhhfwbd4xga",
  "status": "authorized",
  "transaction_type": "purchase",
  "client": {
    "id": "cli_vkuhvk4vjn2edkps7dfsq6emqm"
  },
  "entity": {
    "id": "ent_fa6psq242dcd6fdn5gifcq1491"
  },
  "card": {
    "id": "crd_fa6psq242dcd6fdn5gifcq1491",
    "network": "mastercard"
  },
  "digital_card": {
    "id": "dcr_5ngxzsynm2me3oxf73esbhda6q"
  },
  "cardholder": {
    "id": "crh_d3ozhf43pcq2xbldn2g45qnb44"
  },
  "amounts": {
    "total_held": {
      "amount": 100,
      "currency": "USD"
    },
    "total_authorized": {
      "amount": 100,
      "currency": "USD"
    },
    "total_reversed": {
      "amount": 100,
      "currency": "USD"
    },
    "total_cleared": {
      "amount": 100,
      "currency": "USD"
    },
    "total_refunded": {
      "amount": 100,
      "currency": "USD"
    }
  },
  "merchant": {
    "id": "(*)123456789",
    "name": "My Merchant",
    "city": "Paris",
    "country_code": "FR",
    "category_code": "5331"
  },
  "reference_transaction": {
    "transaction_id": "trx_aayhhfwbdyxwcaeyhhfwbd4xga"
  },
  "messages": [
    {
      "id": "msg_fa6psq242dcd6fdn5gifcq1491",
      "result": "declined",
      "is_relayed": true,
      "decline_reason": "expiry_date_invalid",
      "authorization_code": "03C0C0",
      "billing_amount": 100,
      "billing_currency": "USD",
      "transaction_amount": 100,
      "transaction_currency": "USD",
      "created_on": "2019-09-10T10:11:12.0000000+00:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.