status

Retrieve status of a transaction

get/status/{apiKey}/getByMerchantTransactionId/{merchantTransactionId}

Request

Base URL
https://gateway.tillpayments.com/api/v3
Auth
HTTP basic
TypeScript
https://skmtc.dev/tillpayments/apis/till-payments-gateway/docs/status/:apiKey/getByMerchantTransactionId/:merchantTransactionId/get.ts
A function with typed inputs. Its response is checked against the schema.

apiKeystring required

API Key of Connector

merchantTransactionIdstring required

ID of merchant transaction

Status response

successboolean

transactionStatus'SUCCESS' | 'PENDING' | 'REDIRECT' | 'CANCELLED' | 'ERROR'

uuidstring

merchantTransactionIdstring

adapterMerchantTransactionIdstring

Adapter/PSP-side merchant transaction identifier recorded for transaction matching and reconciliation. Omitted when unavailable.

purchaseIdstring

transactionSubType'cb-resolved' | 'cb-reversal-resolved'

Only present if transaction has a subType

paymentMethodstring

amountstring

currencystring

surchargeAmountstring

totalAmountstring

schedulesobject

extraDataExtraData

merchantMetaDatastring

{
  "returnData": {
    "cardUpdatedAt": "2024-05-07 00:00:00",
    "cardUpdatePausedUntil": "2024-05-07"
  }
}