UPP Docs
Card

Get a card transaction

GET
/card-transactions/{transactionId}

Authorization

merchantApiKeymerchantTimestampmerchantNoncemerchantSignature
headerX-API-KEY<token>

Merchant API key (starts with upk_, also accepts api-key); signing headers are also required

headerX-Timestamp<token>

Unix timestamp in seconds, within 300 seconds of server time

headerX-Nonce<token>

Unique per request; cannot be reused with the same credential during the timestamp validity window

headerX-Signature<token>

Hex HMAC-SHA256 signature (either letter case) of the method, full path, timestamp, nonce and body digest

Path Parameters

transactionId*string

Response Body

Card transaction

application/json
  1. response
id*string

Card transaction ID (starts with ctx_), shared by the authorization, settlement, reversals, refunds and fees of one purchase

card_id*string|null
original_transaction_id*|

The original transaction of a reversal, refund or additional fee when the issuer reports it as a separate transaction; null when the original was not recorded or the issuer does not identify it (such as a standalone refund; refunds are never matched to a purchase by amount or time). When the issuer identifies the purchase, reversals and refunds are merged into it; see reversed_amount, refunded_amount and events

type*CardTransactionType
  • purchase: purchase
  • verification: card verification (usually a zero-amount authorization)
  • refund: refund (including returns, chargebacks and FX differences returned)
  • reversal: authorization reversal
  • maintenance_fee: card maintenance fee charged by the issuer
  • transaction_fee: per-transaction fee charged by the issuer
  • cross_border_fee: cross-border / FX fee
  • fx_adjustment: FX adjustment
Value in"purchase""verification""refund""reversal""maintenance_fee""transaction_fee""cross_border_fee""fx_adjustment"
status*CardTransactionStatus
  • pending: being processed by the issuer
  • authorized: authorized; the amount is held on the card
  • settled: settled (fee transactions are settled once charged)
  • reversed: authorization reversed
  • refunded: refunded (can be refunded several times; see refunded_amount for the total)
  • declined: authorization declined
  • failed: failed at the issuer
Value in"pending""authorized""settled""reversed""refunded""declined""failed"
revision*integer

Version number, up by 1 each time an update changes the status, amounts or fees

transaction_amount*|

Amount at the point of sale (the acquirer's currency)

transaction_currency*string|null
billing_currency*|

Currency charged to the card; the amounts and fee below are in this currency

authorized_amount*|

Latest authorized amount; an authorization arriving after settlement does not replace it. Can differ from the settled amount (hotel pre-authorizations, for example)

settled_amount*|

Latest settled amount, for reference only. The card is charged at authorization and credited on reversal; settlement (including one that differs from the authorization, or several settlements) does not change the card balance

reversed_amount*|

Total reversed amount

refunded_amount*|

Total refunded amount

fee*|

Total fees the issuer charged the card on this transaction, including cross-border and other fees merged into the purchase; see events for the breakdown

merchant*
authorization_code*string|null
wallet_type*|

Such as ApplePay or GooglePay

description*string|null
events*array<>

Each update received from the issuer for this transaction, in the order received

occurred_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X GET 'https://sandbox.getupp.net/api/v1/card-transactions/string'
Example Response
{  "id": "string",  "card_id": "string",  "original_transaction_id": "string",  "type": "purchase",  "status": "pending",  "revision": 0,  "transaction_amount": "string",  "transaction_currency": "string",  "billing_currency": "string",  "authorized_amount": "string",  "settled_amount": "string",  "reversed_amount": "string",  "refunded_amount": "string",  "fee": "string",  "merchant": {    "name": "string",    "category_code": "string",    "country": "string",    "city": "string"  },  "authorization_code": "string",  "wallet_type": "string",  "description": "string",  "events": [    {      "id": "string",      "type": "authorization",      "status": "pending",      "revision": 0,      "transaction_amount": "string",      "transaction_currency": "string",      "billing_amount": "string",      "billing_currency": "string",      "fee": "string",      "occurred_at": "2019-08-24T14:15:22Z"    }  ],  "occurred_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}