Retrieve Transaction

Retrieve transactions when you need to process them

Retrieve a previously created transaction using its id.

This returns the same response as a transaction verification except that the transaction id generated by SwitchApp is used in this case to retrieve the transaction record instead of your payment reference.

NOTE: Transactions provide a source of truth for reconciliations. As such, they cannot be deleted. But you may hide or archive them.

Retrieves a transaction with the specified id.

GET/v1/transactions/{id}

Path parameters

id*string

The id of the transaction to retrieve

Response

200400401404

Returns 200 and the requested transaction

Body

application/json

statusApiStatusResponse (enum)

successerror

messagenullable string

dataViewTransactionDto (object)

metaNoMeta (object)

errorsnullable object

is_errorboolean

Request

JavaScriptCurlPython

const response = await fetch('/v1/transactions/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "status": "success",
  "message": "text",
  "data": {
    "id": "text",
    "is_live": false,
    "gateway_code": "text",
    "tx_ref": "text",
    "dedicated_virtual_account_reference": "text",
    "currency": "text",
    "amount": 0,
    "charged_amount": 0,
    "amount_settled": 0,
    "app_fee": 0,
    "merchant_fee": 0,
    "bearer": "customer",
    "status": "successful",
    "metadata": "text",
    "redirect_url": "text",
    "payment_type": "text",
    "is_direct_card_charge": false,
    "is_virtual_account_checkout": false,
    "is_dedicated_virtual_account_checkout": false,
    "device_fingerprint": "text",
    "ip": "text",
    "narration": "text",
    "processor_response": "text",
    "auth_model": "text",
    "card_pan": "text",
    "card_issuer": "text",
    "card_country": "text",
    "card_type": "text",
    "card_expiry": "text",
    "bank_trsf_country": "text",
    "bank_trsf_bank_code": "text",
    "bank_trsf_bank_name": "text",
    "bank_trsf_account_number": "text",
    "bank_trsf_account_name": "text",
    "bank_trsf_swift": "text",
    "bank_trsf_iban": "text",
    "bank_trsf_session_id": "text",
    "title": "text",
    "logo_url": "text",
    "description": "text",
    "customer": {
      "id": "text",
      "full_name": "text",
      "email": "text",
      "phone_number": "text",
      "address": "text",
      "status": "active",
      "created_at": "2024-11-16T16:40:42.307Z",
      "edited_at": "2024-11-16T16:40:42.307Z"
    },
    "paid_at": "2024-11-16T16:40:42.307Z",
    "created_at": "2024-11-16T16:40:42.307Z",
    "edited_at": "2024-11-16T16:40:42.307Z",
    "transaction_payout_tags": [
      {
        "payout_tag": "text",
        "amount": 0,
        "description": "text",
        "metadata": "text"
      }
    ],
    "virtual_account_transfer_timeline_entries": [
      {
        "id": "text",
        "action_type": "awaitingProviderResponse",
        "action": "text",
        "description": "text",
        "gateway_code": "text",
        "is_live": false,
        "created_at": "2024-11-16T16:40:42.307Z",
        "edited_at": "2024-11-16T16:40:42.307Z"
      }
    ]
  },
  "is_error": false
}

curl

curl https://api.switchappgo.com/v1/transactions/:transactionId \
    -H "authorization: 'bearer sk_test_nTgS42KNdKr6Ts798DT'"
    -X GET

node

const switchapp = require('switchapp')('sk_test_nTgS42KNdKr6Ts798DT');

const newTx = await switchapp.transactions.verify({
    txRef: transactionId
})