API docs by Redocly

Processing Service API (1.120.2)

Download OpenAPI specification:

Rapaydo: hello@rapaydo.com URL: https://www.rapaydo.com

Service to process any type of transaction.

Decrypt and Decode POS Card Data

Decrypt and Decode POS Card details.

Request Body schema: application/json
encryptionKey
required
string non-empty

The Key Serial Number (KSN) used in the DUKPT encryption process. This is a hexadecimal string uniquely identifying the encryption key.

encryptedData
required
string non-empty

The encrypted payload containing sensitive transaction details. This is a hexadecimal string produced using the encryptionKey.

dataType
required
string (PosCardDataType)
Enum: "TLV" "TRACK2"

Details:

  • TLV - TLV (Tag-Length-Value format)
  • TRACK2 - Track2Data (magnetic stripe data).
object (PosCardDataMetaData)

Additional metadata about the transaction for tracking and processing purposes.

Responses

Request samples

Content type
application/json
{
  • "encryptionKey": "string",
  • "encryptedData": "string",
  • "dataType": "TLV",
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "pan": "string",
  • "decryptedData": "string",
  • "metaData": {
    }
}

Lookup a transaction status

Lookup the status of a processed transaction request.

query Parameters
tid
string

The identity of the terminal utilized in the transaction that the status is being requested for.

tnxId
string

The unique identifier returned in a Payment response to use for looking up the processing status of the transaction.

fiEntityId
string

The entityId of the Financial Institution, this field is required if using a 'main' token.

Responses

Response samples

Content type
application/json
{
  • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
  • "retrievalReferenceNumber": "410200005773",
  • "timestampSubmitted": "2024-04-11T19:41:06",
  • "systemTraceAuditNumber": "638922",
  • "amount": {
    },
  • "outcome": {
    },
  • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
  • "additionalData": [
    ],
  • "counterPartyTransactionRetrievalReferenceNumber": "410200005783",
  • "uniqueTransactionReferenceNumber": "4102000054545181515156",
  • "recurringResult": {
    }
}

Financial Transactions

Charge a Fee

Process a Fee transaction request.

header Parameters
X-Idempotency-Key
string
Request Body schema: application/json
terminalIdentifier
string or null

The identity of the terminal to charge the fee.

entityId
string or null

The entityId of the level the fee is being charged on. (Contract or Teminal)

feeReference
string or null <= 32 characters

A unique identifier or reference number associated with the collection of fees or payments.

feeType
required
string (FeeType)
Enum: "AcquirerArbitrationFee" "ArbitrationSchemeFee" "ChargebackFee" "DeclineFee" "MDF" "MastercardArbitrationSchemeFee" "MastercardArbitrationFee" "MastercardCollaborationRequestFeeTier1" "MastercardCollaborationRequestFeeTier2D" "MastercardDisputeAdministrationFee" "MastercardPreArbitrationSchemeFee" "PreComplianceFee" "RepresentmentFee" "RetrievalFee" "SchemeComplianceFee" "VisaArbitrationSchemeFee" "VisaIncomingArbitrationFee" "VisaOutgoingArbitrationFee" "VisaRapidDisputeResolutionFee" "AcquirerComplianceFee" "AnnualDormancyFee" "BalanceConfirmationFee" "ExcessiveChargebackDocFee" "ExcessiveMastercardChargebackValue" "MastercardCollaborationRequestFeeTier2" "MonthlyFee" "OtherFee" "PayoutFee" "PayoutInvestigationFee" "StartupFee" "VisaCnpUnsecureChargebackFee" "ChargebackTier2Visa" "ChargebackTier2MC" "PreArbitrationFee" "ExcessiveFraudFeeDisp"

The type of fee to charge.

Details:

  • AcquirerArbitrationFee - Acquirer Arbitration Fee (No amount needed)
  • ArbitrationSchemeFee - Arbitration Scheme Fee (No amount needed)
  • ChargebackFee - Chargeback Fee (No amount needed)
  • DeclineFee - Decline Fee (No amount needed)
  • MDF - Manual Decline Fee (DEPRICATED, Please use DeclineFee) (No amount needed)
  • MastercardArbitrationSchemeFee - Mastercard Arbitration Scheme Fee (No amount needed)
  • MastercardArbitrationFee - Mastercard Arbitration Fee (No amount needed)
  • MastercardCollaborationRequestFeeTier1 - Mastercard Collaboration Request Fee Tier 1 (No amount needed)
  • MastercardCollaborationRequestFeeTier2D - Mastercard Collaboration Request Fee Tier 2 D (No amount needed)
  • MastercardDisputeAdministrationFee - Mastercard Dispute Administration Fee (No amount needed)
  • MastercardPreArbitrationSchemeFee - Mastercard Pre-Arbitration Scheme Fee (No amount needed)
  • PreComplianceFee - Pre-compliance Fee (No amount needed)
  • RepresentmentFee - Representment Fee (No amount needed)
  • RetrievalFee - Retrieval Fee (No amount needed)
  • SchemeComplianceFee - Scheme Compliance Fee (No amount needed)
  • VisaArbitrationSchemeFee - Visa Arbitration Scheme Fee (No amount needed)
  • VisaIncomingArbitrationFee - Visa Incoming Arbitration Fee (No amount needed)
  • VisaOutgoingArbitrationFee - Visa Outgoing Arbitration Fee (No amount needed)
  • VisaRapidDisputeResolutionFee - Visa Rapid Dispute Resolution Fee (No amount needed)
  • AcquirerComplianceFee - Acquirer Compliance Fee (No amount needed)
  • AnnualDormancyFee - Annual Dormancy Fee (No amount needed)
  • BalanceConfirmationFee - Balance Confirmation Fee (No amount needed)
  • ExcessiveChargebackDocFee - Excessive Chargeback Doc Fee (No amount needed)
  • ExcessiveMastercardChargebackValue - Excessive MasterCard Chargeback Value (No amount needed)
  • MastercardCollaborationRequestFeeTier2 - Mastercard Collaboration Request Fee Tier 2 (No amount needed)
  • MonthlyFee - Monthly Fee (No amount needed)
  • OtherFee - Other Fee (No amount needed)
  • PayoutFee - Payout/Withdrawal Fee (No amount needed)
  • PayoutInvestigationFee - Payout Investigation Fee (No amount needed)
  • StartupFee - Startup Fee (No amount needed)
  • VisaCnpUnsecureChargebackFee - Visa Card-Not-Present Unsecure Chargeback Fee (No amount needed)
  • ChargebackTier2Visa - Excessive Chargeback Fee Visa
  • ChargebackTier2MC - Excessive Chargeback Fee Mastercard
  • PreArbitrationFee - Pre-arbitration Fee
  • ExcessiveFraudFeeDisp - Excessive Fraud Fee

amount
number or null <double>

The amount of the fee to be charged.

currencyAlphaCode
string or null

The ISO 4217 currency alpha code of the fee amount.

description
string or null <= 255 characters

A description of the fee being charged

gatewaySourceId
string or null

An id to uniquely identify the request from the gateways calling it

fiEntityId
string or null

The EntityId of the Financial Institution that the specific user belongs to. If X-Entity-Id header is 'main', this field is required.

Responses

Request samples

Content type
application/json
{
  • "terminalIdentifier": "00868661",
  • "entityId": "00456789",
  • "feeReference": "FCCN-20230918-123456",
  • "feeType": "AcquirerArbitrationFee",
  • "amount": 5.51,
  • "currencyAlphaCode": "EUR",
  • "description": "This is a fee that gets charged when a limit is reached.",
  • "gatewaySourceId": "2469a1b0-25b3-449a-bd54-7150a755a226",
  • "fiEntityId": "string"
}

Response samples

Content type
application/json
{
  • "feeUniqueIdentifier": "FEE-02-A09",
  • "timestampSubmitted": "2023-11-02T14:09:54",
  • "transactionType": "Retail Decline Fee",
  • "transactionReference": "REF-123",
  • "outcome": {
    },
  • "gatewaySourceId": "2469a1b0-25b3-449a-bd54-7150a755a226"
}

Get the Balance

Get the balance.

path Parameters
terminalIdentifier
required
string

The identity of the terminal to retrieve the balance for.

query Parameters
includeSubSettlementLevel
boolean
Default: false

Indicates if the response should include the balances of a hierarchy’s subordinate level defined as the settlement level.

Responses

Response samples

Content type
application/json
{
  • "timestampSubmitted": "2023-11-02T14:09:54",
  • "outcome": {
    },
  • "balances": [
    ]
}

Charge a Manual Adjustment (Credit / Debit)

Process a Manual Adjustment transaction request.

header Parameters
X-Idempotency-Key
string
Request Body schema: application/json
reference
string or null <= 32 characters

A unique identifier or source reference number associated with the manual adjustment.

manualAdjustmentType
required
string (ManualAdjustmentType)
Enum: "CardSchemePenalty" "InwardPayment_OCT" "InwardPayment_FixedReserves" "ManualPayout" "ReturnedPayout" "Arbitration" "ChargebackDebit" "DisputeRefund" "DisputeOct" "PreArbitrationCredit" "PreArbitrationLiability" "PreComplianceLiability" "RepresentmentCredit" "BalanceSettlement" "DeclineFeeAdjustment" "MonthlyFeeAdjustment" "OtherFeeAdjustment" "StartupFeeAdjustment" "AcquirerComplianceFeeAdjustment" "WriteOff" "ChargebackDebitAdjustment" "ChargebackFeeAdjustment" "FeeCollection" "FundsDisbursement" "PreArbitrationCreditAdjustment" "PreArbitrationLiabilityAdjustment" "PreComplianceLiabilityAdjustment" "RepresentmentCreditAdjustment" "AcquirerArbitrationFeeAdjustment" "DisputeBlockFunds" "PayoutFeeAdjustment"

Details:

  • CardSchemePenalty - Card Scheme Penalty
  • InwardPayment_OCT - Inward Payment (OCT)
  • InwardPayment_FixedReserves - Inward Payment (Fixed Reserves)
  • ManualPayout - Manual Payout
  • ReturnedPayout - Returned Payout
  • Arbitration - Arbitration (Please choose a direction)
  • ChargebackDebit - Chargeback Debit
  • DisputeRefund - Dispute on a Refund
  • DisputeOct - Dispute on OCT
  • PreArbitrationCredit - Pre-arbitration Credit
  • PreArbitrationLiability - Pre-arbitration Liability
  • PreComplianceLiability - Pre-compliance Liability
  • RepresentmentCredit - Representment Credit
  • BalanceSettlement - Balance Settlement (Please choose a direction)
  • DeclineFeeAdjustment - Decline Fee Adjustment (Please choose a direction)
  • MonthlyFeeAdjustment - Monthly Fee Adjustment (Please choose a direction)
  • OtherFeeAdjustment - Other Fee Adjustment (Please choose a direction)
  • StartupFeeAdjustment - Startup Fee Adjustment (Please choose a direction)
  • AcquirerComplianceFeeAdjustment - Acquirer Compliance Fee Adjustment (Please choose a direction)
  • WriteOff - Write Off (Please choose a direction)
  • ChargebackDebitAdjustment - Chargeback Debit Adjustment (Please choose a direction)
  • ChargebackFeeAdjustment - Chargeback Fee Adjustment (Please choose a direction)
  • FeeCollection - Fee Collection (Please choose a direction)
  • FundsDisbursement - Funds Disbursement (Please choose a direction)
  • PreArbitrationCreditAdjustment - Pre-arbitration Credit Adjustment (Please choose a direction)
  • PreArbitrationLiabilityAdjustment - Pre-arbitration liability Adjustment (Please choose a direction)
  • PreComplianceLiabilityAdjustment - Pre-compliance liability Adjustment (Please choose a direction)
  • RepresentmentCreditAdjustment - Representment Credit Adjustment (Please choose a direction)
  • AcquirerArbitrationFeeAdjustment - Acquirer Arbitration Fee Adjustment (Please choose a direction)
  • DisputeBlockFunds - Blocking/Unblocking of Dispute Funds (Please choose a direction)
  • PayoutFeeAdjustment - Payout Fee Adjustment (Please choose a direction)
manualAdjustmentDirection
string (ManualAdjustmentDirection)
Enum: "CREDIT" "DEBIT"

Details:

    amount
    required
    number <double>

    The amount of the manual adjustment to be performed.

    currencyAlphaCode
    required
    string non-empty

    The ISO 4217 currency alpha code of the manual adjustment amount.

    contractNumber
    string or null

    The contract number to Credit/Debit (Also known as the EntityId)

    terminalIdentifier
    string or null

    The identity of the terminal to Credit/Debit.

    description
    string or null <= 255 characters

    A description of the manual adjustment

    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    fiEntityId
    string or null

    The EntityId of the Financial Institution that the specific user belongs to. If X-Entity-Id header is 'main', this field is required.

    Responses

    Request samples

    Content type
    application/json
    {
    • "reference": "CRED-20230918-123456",
    • "manualAdjustmentType": "CardSchemePenalty",
    • "manualAdjustmentDirection": "CREDIT",
    • "amount": 10.84,
    • "currencyAlphaCode": "EUR",
    • "contractNumber": "00456789",
    • "terminalIdentifier": "00456789",
    • "description": "This is a credit transaction for reason x.",
    • "gatewaySourceId": "2469a1b0-25b3-449a-bd54-7150a755a226",
    • "fiEntityId": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "adjustmentUniqueIdentifier": "ADJ-01-C00",
    • "timestampSubmitted": "2023-11-02T14:09:54",
    • "transactionType": "CardSchemePenalty",
    • "direction": "CREDIT",
    • "transactionReference": "CRED-123",
    • "outcome": {
      },
    • "gatewaySourceId": "2469a1b0-25b3-449a-bd54-7150a755a226"
    }

    Funds Transfer (Payment) Transactions

    Process a Funds Transfer Payment request

    Process a Payment transaction request.

    Request Body schema: application/json
    required
    object (TransactionFundsTransferPayment)
    required
    object (MerchantFundsTransfer)
    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    Array of objects or null (AdditionalDataItem)
    object (CardSimple)
    object (SenderPayment)
    required
    object (ReceiverPayment)
    object (LanguageDescription)

    Details about the language

    Responses

    Request samples

    Content type
    application/json
    {
    • "transaction": {
      },
    • "merchant": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "card": {
      },
    • "sender": {
      },
    • "receiver": {
      },
    • "language": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
    • "retrievalReferenceNumber": "410200005773",
    • "timestampSubmitted": "2024-04-11T19:41:06",
    • "systemTraceAuditNumber": "638922",
    • "amount": {
      },
    • "outcome": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "counterPartyTransactionRetrievalReferenceNumber": "410200005783",
    • "uniqueTransactionReferenceNumber": "4102000054545181515156",
    • "recurringResult": {
      }
    }

    Process a Funds Transfer Payment Authorisation request

    Process a Funds Transfer Payment Authorisation transaction request.

    Request Body schema: application/json
    required
    object (TransactionFundsTransferPayment)
    required
    object (MerchantFundsTransfer)
    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    Array of objects or null (AdditionalDataItem)
    object (CardSimple)
    object (SenderPayment)
    required
    object (ReceiverPayment)
    object (LanguageDescription)

    Details about the language

    Responses

    Request samples

    Content type
    application/json
    {
    • "transaction": {
      },
    • "merchant": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "card": {
      },
    • "sender": {
      },
    • "receiver": {
      },
    • "language": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
    • "retrievalReferenceNumber": "410200005773",
    • "timestampSubmitted": "2024-04-11T19:41:06",
    • "systemTraceAuditNumber": "638922",
    • "amount": {
      },
    • "outcome": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "counterPartyTransactionRetrievalReferenceNumber": "410200005783",
    • "uniqueTransactionReferenceNumber": "4102000054545181515156",
    • "recurringResult": {
      }
    }

    Funds Transfer Transactions

    Process a Funds Inquiry request

    Process a Funds Inquiry transaction request.

    Request Body schema: application/json
    required
    object (TransactionSimple)

    Details specific to the transaction being processed.

    required
    object (MerchantSimple)
    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    Array of objects or null (AdditionalDataItem)
    required
    object (CardSimple)

    Responses

    Request samples

    Content type
    application/json
    {
    • "transaction": {
      },
    • "merchant": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "card": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
    • "retrievalReferenceNumber": "410200005773",
    • "timestampSubmitted": "2024-04-11T19:41:06",
    • "systemTraceAuditNumber": "638922",
    • "amount": {
      },
    • "outcome": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ]
    }

    Process a Funds Transfer request

    Process a Payment transaction request.

    Request Body schema: application/json
    required
    object (TransactionFundsTransfer)
    required
    object (MerchantFundsTransfer)
    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    Array of objects or null (AdditionalDataItem)
    object (CardSimpleFundsTransfer)
    object (SecureEcommerce)

    Details required for a 3DS payment

    object (SenderFund)
    object (ReceiverFund)
    object (LanguageDescription)

    Details about the language

    Responses

    Request samples

    Content type
    application/json
    {
    • "transaction": {
      },
    • "merchant": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "card": {
      },
    • "secureEcommerce": {
      },
    • "sender": {
      },
    • "receiver": {
      },
    • "language": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
    • "retrievalReferenceNumber": "410200005773",
    • "timestampSubmitted": "2024-04-11T19:41:06",
    • "systemTraceAuditNumber": "638922",
    • "amount": {
      },
    • "outcome": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "counterPartyTransactionRetrievalReferenceNumber": "410200005783",
    • "uniqueTransactionReferenceNumber": "4102000054545181515156",
    • "recurringResult": {
      }
    }

    Process a Funds Transfer Authorisation request

    Process a Funds Transfer Authorisation transaction request.

    Request Body schema: application/json
    required
    object (TransactionFundsTransfer)
    required
    object (MerchantFundsTransfer)
    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    Array of objects or null (AdditionalDataItem)
    object (CardSimpleFundsTransfer)
    object (SecureEcommerce)

    Details required for a 3DS payment

    object (SenderFund)
    object (ReceiverFund)
    object (LanguageDescription)

    Details about the language

    Responses

    Request samples

    Content type
    application/json
    {
    • "transaction": {
      },
    • "merchant": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "card": {
      },
    • "secureEcommerce": {
      },
    • "sender": {
      },
    • "receiver": {
      },
    • "language": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
    • "retrievalReferenceNumber": "410200005773",
    • "timestampSubmitted": "2024-04-11T19:41:06",
    • "systemTraceAuditNumber": "638922",
    • "amount": {
      },
    • "outcome": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "counterPartyTransactionRetrievalReferenceNumber": "410200005783",
    • "uniqueTransactionReferenceNumber": "4102000054545181515156",
    • "recurringResult": {
      }
    }

    Internal Configurations

    Reload pos device configuration information

    Responses

    Reload Hsm host details

    Responses

    Payment Transactions

    Process a Zero Amount Authorisation

    Process a Zero Amount Authorisation transaction (Account Verification) request.

    Request Body schema: application/json
    required
    object (TransactionSimple)

    Details specific to the transaction being processed.

    required
    object (Merchant)
    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    Array of objects or null (AdditionalDataItem)
    required
    object (Card)
    object (Terminal)
    required
    object (AccountVerificationReceiverNames)

    Details specific to the account holder of the account being verified.

    Responses

    Request samples

    Content type
    application/json
    {
    • "transaction": {
      },
    • "merchant": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "card": {
      },
    • "terminal": {
      },
    • "accountHolder": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
    • "retrievalReferenceNumber": "410200005773",
    • "timestampSubmitted": "2024-04-11T19:41:06",
    • "systemTraceAuditNumber": "638922",
    • "amount": {
      },
    • "outcome": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "counterPartyTransactionRetrievalReferenceNumber": "410200005783",
    • "uniqueTransactionReferenceNumber": "4102000054545181515156",
    • "recurringResult": {
      }
    }

    Process an Authorisation

    Process an Authorisation transaction request.

    Request Body schema: application/json
    required
    object (Transaction)

    Details specific to the transaction being processed.

    required
    object (Merchant)
    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    Array of objects or null (AdditionalDataItem)
    required
    object (Card)
    object (SecureEcommerce)

    Details required for a 3DS payment

    object (Recurring)

    Details related to the recurring transaction.

    object (ScaExemption)
    object (Terminal)

    Responses

    Request samples

    Content type
    application/json
    {
    • "transaction": {
      },
    • "merchant": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "card": {
      },
    • "secureEcommerce": {
      },
    • "recurring": {
      },
    • "scaExemption": {
      },
    • "terminal": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
    • "retrievalReferenceNumber": "410200005773",
    • "timestampSubmitted": "2024-04-11T19:41:06",
    • "systemTraceAuditNumber": "638922",
    • "amount": {
      },
    • "outcome": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "counterPartyTransactionRetrievalReferenceNumber": "410200005783",
    • "uniqueTransactionReferenceNumber": "4102000054545181515156",
    • "recurringResult": {
      }
    }

    Process a Purchase

    Process a Purchase transaction request.

    Request Body schema: application/json
    required
    object (Transaction)

    Details specific to the transaction being processed.

    required
    object (Merchant)
    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    Array of objects or null (AdditionalDataItem)
    required
    object (Card)
    object (SecureEcommerce)

    Details required for a 3DS payment

    object (Recurring)

    Details related to the recurring transaction.

    object (ScaExemption)
    object (Terminal)

    Responses

    Request samples

    Content type
    application/json
    {
    • "transaction": {
      },
    • "merchant": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "card": {
      },
    • "secureEcommerce": {
      },
    • "recurring": {
      },
    • "scaExemption": {
      },
    • "terminal": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
    • "retrievalReferenceNumber": "410200005773",
    • "timestampSubmitted": "2024-04-11T19:41:06",
    • "systemTraceAuditNumber": "638922",
    • "amount": {
      },
    • "outcome": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "counterPartyTransactionRetrievalReferenceNumber": "410200005783",
    • "uniqueTransactionReferenceNumber": "4102000054545181515156",
    • "recurringResult": {
      }
    }

    Process a Standalone Refund

    Process a Standalone Refund transaction request.

    Request Body schema: application/json
    required
    object (TransactionRefundStandalone)
    object (Card)
    required
    object (Merchant)
    object (ScaExemption)
    object (Terminal)
    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    Array of objects or null (AdditionalDataItem)

    Responses

    Request samples

    Content type
    application/json
    {
    • "transaction": {
      },
    • "card": {
      },
    • "merchant": {
      },
    • "scaExemption": {
      },
    • "terminal": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
    • "retrievalReferenceNumber": "410200005773",
    • "timestampSubmitted": "2024-04-11T19:41:06",
    • "systemTraceAuditNumber": "638922",
    • "amount": {
      },
    • "outcome": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ]
    }

    Subsequent Transactions

    Process an Authorisation Confirmation

    Process an Authorisation Confirmation transaction request.

    Request Body schema: application/json
    required
    object (TransactionAuthorisationConfirmation)
    object (MerchantSubsequent)

    Details specific to the merchant processing the transaction that should not be inferred from the original transaction.

    required
    object (OriginalTransactionAuthorisationConfirmation)

    Details specific to referenced transaction.

    object (ScaExemption)
    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    Array of objects or null (AdditionalDataItem)

    Responses

    Request samples

    Content type
    application/json
    {
    • "transaction": {
      },
    • "merchant": {
      },
    • "originalTransaction": {
      },
    • "scaExemption": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
    • "retrievalReferenceNumber": "410200005773",
    • "timestampSubmitted": "2024-04-11T19:41:06",
    • "systemTraceAuditNumber": "638922",
    • "amount": {
      },
    • "outcome": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ],
    • "counterPartyTransactionRetrievalReferenceNumber": "410200005783",
    • "uniqueTransactionReferenceNumber": "4102000054545181515156",
    • "recurringResult": {
      }
    }

    Process a Linked Refund

    Process a Linked Refund transaction request.

    Request Body schema: application/json
    object (TransactionRefund)
    object (MerchantSubsequent)

    Details specific to the merchant processing the transaction that should not be inferred from the original transaction.

    required
    object (OriginalTransactionRefund)

    Details specific to referenced transaction.

    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    Array of objects or null (AdditionalDataItem)

    Responses

    Request samples

    Content type
    application/json
    {
    • "transaction": {
      },
    • "merchant": {
      },
    • "originalTransaction": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
    • "retrievalReferenceNumber": "410200005773",
    • "timestampSubmitted": "2024-04-11T19:41:06",
    • "systemTraceAuditNumber": "638922",
    • "amount": {
      },
    • "outcome": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ]
    }

    Process a Reversal

    Process a Reversal transaction request.

    Request Body schema: application/json
    required
    object (TransactionReversal)
    object (MerchantSubsequent)

    Details specific to the merchant processing the transaction that should not be inferred from the original transaction.

    required
    object (OriginalTransactionReversal)

    Details specific to referenced transaction.

    object (ScaExemption)
    gatewaySourceId
    string or null

    An id to uniquely identify the request from the gateways calling it

    Array of objects or null (AdditionalDataItem)

    Responses

    Request samples

    Content type
    application/json
    {
    • "transaction": {
      },
    • "merchant": {
      },
    • "originalTransaction": {
      },
    • "scaExemption": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "transactionUniqueIdentifier": "a06cc214-7c33-41c0-991f-069139db07ed",
    • "retrievalReferenceNumber": "410200005773",
    • "timestampSubmitted": "2024-04-11T19:41:06",
    • "systemTraceAuditNumber": "638922",
    • "amount": {
      },
    • "outcome": {
      },
    • "gatewaySourceId": "3143db8d-4d14-4e6c-88a6-a0952770e4e9",
    • "additionalData": [
      ]
    }

    Verifications

    Verify a purchase transaction link based on specific request parameters

    Lookup a transactions link details.

    Request Body schema: application/json
    terminalIdentifier
    required
    string non-empty
    merchantIdentifier
    string or null
    pan
    required
    string non-empty

    Responses

    Request samples

    Content type
    application/json
    {
    • "terminalIdentifier": "string",
    • "merchantIdentifier": "string",
    • "pan": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "hasLinkedPurchase": true
    }