1. Card Transactions
Vrtx Docs
  • Card Transactions
    • Perform a simulated card transaction
      POST
    • Perform a balance inquiry
      POST
    • Build a clearing message for settlement
      POST
    • Build and submit clearing to FAST
      POST
    • Send an advisement message
      POST
  • Cards Router Proxy
    • Proxy /fast/settlement to cards-router
      POST
    • Proxy /fast/customer-info to cards-router
      POST
    • Proxy /fast/authorisation to cards-router
      POST
  • Debug Fast
    • Look up clearing event by TID and ADD_REF_RID
      GET
    • Look up auth by TID and ADD_REF_RID
      GET
  • Card Sensitive Data
    • Get card sensitive data
      GET
  • Payouts
    • List payouts
      GET
  • Account Transactions
    • List account transactions (V2)
      GET
Open-Loop-v2Closed-loop V2Card Simulator
open-loop-test
Open-Loop-v2Closed-loop V2Card Simulator
open-loop-test
  1. Card Transactions

Build a clearing message for settlement

POST
https://api.staging.vrtx.sa/testhelpers/card-transactions/clearing
Last modified:2026-04-14 14:51:07
Builds a single Data Clearing and Settlement–style message from TID + ADD_REF_RID. Optionally populates SUMMARY from FAST's database when configured. Returns 404 TID_NOT_FOUND when simulate_tid_not_found=true, or when FAST DB is used and no auth exists. Caller must POST the returned object as a one-element array to FAST /fast/settlement for actual clearing.

Request

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Clearing message built; POST as [body] to FAST /fast/settlement
Body

đźź 400
đźź 404
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://api.staging.vrtx.sa/testhelpers/card-transactions/clearing?simulate_tid_not_found' \
--header 'Content-Type: application/json' \
--data-raw '{
    "TID": "319292099329392939293",
    "ADD_REF_RID": "7829103"
}'
Response Response Example
200 - Example 1
"string"
Modified at 2026-04-14 14:51:07
Previous
Perform a balance inquiry
Next
Build and submit clearing to FAST
Built with