{"info":{"_postman_id":"af9da361-3a3d-47df-af93-24a787b169cb","name":"Supercard TR API Documentation","description":"

Overview
The Supercard TR API provides endpoints for on-card transactions: balance enquiries, purchases, and deposits. All endpoints use HTTPS and require an API key in the x-api-key header.

Base URL
https://test.api.supercard.co.za

Authentication

Header: x-api-key

Common Request Body Fields

id (UUID): Unique identifier for this transaction.
\n
productId (integer): Product type code (usually 0).
\n
amount (decimal): Transaction amount in cents (e.g., 25.25 for R25.25).
\n
reference (string): Free-text reference or description.
\n
dateproccessedutc (ISO 8601 datetime): Timestamp when transaction was initiated.
\n
card (object): Card metadata (currently empty object).
\n
type (object):
\n
- id (integer): Transaction type code (see each endpoint).
  \n
- name (string): Human-readable type name.
  \n
\n
debit / credit (objects):
\n
- number (string): Card number or masked PAN.
\n
transmission (object): Contains POS details (stan, rrn, terminalcode, etc.).
\n

The outcome of the transaction. This value should be used to determine the outcome of the transaction.

Supported response codes for transaction/ advice response

00 - Approved or completed successfully
\n
12 - Invalid transaction
\n
15 - No such issuer / Invalid BIN
\n
25 - Unable to locate record on file
\n
36 – Community restriction
\n
46 – Maximum allowed balance exceeded
\n
50 – Transaction limits exceeded
\n
51 - Not sufficient funds
\n
55 – Incorrect PIN
\n
56 - No card record / Account not found / suspended or closed
\n
58 - Transaction not permitted on terminal
\n
63 - Security violation Channel not permitted to transact or Pinblock cannot be decrypted
\n
79 – Card not registered or suspended
\n
94 - Duplicate transaction
\n
96 – Internal system error
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33281579","collectionId":"af9da361-3a3d-47df-af93-24a787b169cb","publishedId":"2sB2qgcxFa","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-03-13T09:07:39.000Z"},"item":[{"name":"Balance Enquiry","id":"172d023a-4c13-42b5-ab9a-3d4c6dd91b78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"TempKey4"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"d85f13dd-fb9e-49f2-8c48-3750bca0d9d8\",\r\n \"productId\": 0,\r\n \"amount\": 0,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"type\": {\r\n \"id\": 5,\r\n \"name\": \"Balance Enquiry\"\r\n },\r\n \"debit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"credit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"transmission\": {\r\n \"id\": \"05644767-aa4b-45cf-adfc-2d89f3333084\",\r\n \"stan\": \"641\",\r\n \"rrn\": \"886\",\r\n \"transmissionutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"posentrymode\": \"1\",\r\n \"terminalcode\": \"oA1So\",\r\n \"entityid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"currencycode\": \"1\",\r\n \"track2data\": \"6094690000000000021\",\r\n \"pinblock\": \"13424982A205F947\",\r\n \"keydata\": \"\",\r\n \"keyX917\": \"\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"referenceid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/v1/transaction/dto","description":"

Balance Enquiry

This endpoint allows you to retrieve a current balance on a Supercard without altering its funds.

Request Body

id (string): Unique identifier for the transaction.
\n
productId (number): The ID of the product.
\n
amount (number): The amount of the transaction.
\n
reference (string): A reference for the transaction.
\n
dateproccessedutc (string): The date and time of the transaction in UTC format.
\n
card (object): Details of the card used for the transaction.
\n
type (object): Type of transaction with ID and name.
\n
debit (object): Details of the debit card.
\n
credit (object): Details of the credit card.
\n
transmission (object): Details of the transmission including ID, stan, rrn, transmission time, pos entry mode, terminal code, entity ID, currency code, track2 data, and other related information.
\n
currencycode (string): The currency code for the transaction.
\n
entityreference (string): Reference of the entity involved in the transaction.
\n

Response

The response schema includes the following fields:

id (string): Unique identifier for the transaction.
\n
sourcetransactionid (string): Identifier of the source transaction.
\n
dateproccessedutc (string): The date and time of the transaction in UTC format.
\n
processcode (number): Code related to the transaction process.
\n
authorizationid (null): ID for the authorization process, if available.
\n
balance (null): Balance related to the transaction, if available.
\n
amount (number): The amount of the transaction.
\n
details (null): Additional details related to the transaction.
\n

\n","urlObject":{"protocol":"https","path":["v1","transaction","dto"],"host":["test.api.supercard.co.za"],"query":[],"variable":[]}},"response":[{"id":"12f1d31d-63c3-4b41-a912-e9640f624c20","name":"Balance Enquiry pin","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"9698dd2e-cc03-4049-9a24-195075be2bd7\",\r\n \"productId\": 0,\r\n \"amount\": 0,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"type\": {\r\n \"id\": 5,\r\n \"name\": \"Balance Enquiry\"\r\n },\r\n \"debit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"credit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"transmission\": {\r\n \"id\": \"af9a54fd-3bf3-401e-997e-9ab1013b14b0\",\r\n \"stan\": \"488\",\r\n \"rrn\": \"926\",\r\n \"transmissionutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"posentrymode\": \"1\",\r\n \"terminalcode\": \"oA1So\",\r\n \"entityid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"currencycode\": \"1\",\r\n \"track2data\": \"6094690000000000021\",\r\n \"pinblock\": \"13424982A205F947\",\r\n \"keydata\": \"\",\r\n \"keyX917\": \"\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"referenceid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/v1/transaction/dto"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 21 Apr 2026 13:01:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"sourcetransactionid\": \"28c9b9a9-df5d-4eab-8521-90ab60c0791f\",\n \"dateprocessedutc\": \"2026-04-21T13:01:03.3172769Z\",\n \"processcode\": 0,\n \"responsecode\": \"00\",\n \"authorizationid\": 555188,\n \"balance\": 300000,\n \"amount\": 0,\n \"details\": null\n}"},{"id":"afc94c5a-6c86-4a66-938c-2226222657ef","name":"Balance Enquiry non pin","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"19c065e0-0da2-41cf-a28f-b07f7ed545d1\",\r\n \"productId\": 0,\r\n \"amount\": 0,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {\r\n \"number\": \"9710390100009438046\"\r\n },\r\n \"type\": {\r\n \"id\": 5,\r\n \"name\": \"Balance Enquiry\"\r\n },\r\n \"debit\": {\r\n \"number\": \"9710390100009438046\"\r\n },\r\n \"credit\": {\r\n \"number\": \"9710390100009438046\"\r\n },\r\n \"transmission\": {\r\n \"id\": \"cda31c45-a60a-4b35-82e3-d93c979f97e3\",\r\n \"stan\": \"918\",\r\n \"rrn\": \"178\",\r\n \"transmissionutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"posentrymode\": \"1\",\r\n \"terminalcode\": \"oA1So\",\r\n \"entityid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"currencycode\": \"1\",\r\n \"track2data\": \"9710390100009438046\",\r\n \"pinblock\": \"\",\r\n \"keydata\": \"\",\r\n \"keyX917\": \"\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"referenceid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/v1/transaction/dto"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 21 Apr 2026 13:04:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"sourcetransactionid\": \"5136c104-9cac-41a3-a88d-79659beedd57\",\n \"dateprocessedutc\": \"2026-04-21T13:04:08.8173329Z\",\n \"processcode\": 0,\n \"responsecode\": \"00\",\n \"authorizationid\": 555189,\n \"balance\": 410000,\n \"amount\": 0,\n \"details\": null\n}"}],"_postman_id":"172d023a-4c13-42b5-ab9a-3d4c6dd91b78"},{"name":"Purchase","id":"850ec03f-5208-449d-8481-f2a57b6fae72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"TempKey4"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"fac6a23a-0d67-4ed0-9589-4997dafe1061\",\r\n \"productId\": 0,\r\n \"amount\": 50,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"type\": {\r\n \"id\": 2,\r\n \"name\": \"Purchase\"\r\n },\r\n \"debit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"credit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"transmission\": {\r\n \"id\": \"66e5dd80-cf6a-4a21-94f0-1a3173e86b29\",\r\n \"stan\": \"683\",\r\n \"rrn\": \"528\",\r\n \"transmissionutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"posentrymode\": \"1\",\r\n \"terminalcode\": \"oA1So\",\r\n \"entityid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"currencycode\": \"1\",\r\n \"track2data\": \"6094690000000000021\",\r\n \"pinblock\": \"13424982A205F947\",\r\n \"keydata\": \"\",\r\n \"keyX917\": \"\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"referenceid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/v1/transaction/dto","description":"

Purchase Transaction

This endpoint allows you to debit a specified amount from a Supercard.

Request Body

id (string, required): The unique identifier for the transaction.
\n
productId (number, required): The ID of the product.
\n
amount (number, required): The amount of the transaction.
\n
reference (string, required): A reference for the transaction.
\n
dateproccessedutc (string, required): The date and time of the transaction in UTC format.
\n
card (object, required): Details of the card used for the transaction.
\n
- type (object, required): The type of transaction.
\n
debit (object, required): Details of the debit card.
\n
credit (object, required): Details of the credit card.
\n
transmission (object, required): Details of the transmission.
\n
provider (object, required): Details of the provider.
\n

Response

The response should include the following fields:

id (string): The unique identifier for the transaction.
\n
sourcetransactionid (string): The source transaction ID.
\n
dateproccessedutc (string): The date and time of the transaction in UTC format.
\n
processcode (number): The process code for the transaction.
\n
authorizationid (number): The authorization ID for the transaction.
\n
balance (number): The balance after the transaction.
\n
amount (number): The amount of the transaction.
\n
details (object): Additional details of the transaction.
\n

\n","urlObject":{"protocol":"https","path":["v1","transaction","dto"],"host":["test.api.supercard.co.za"],"query":[],"variable":[]}},"response":[{"id":"d1103b37-645f-4df7-9ca2-3ce2511326df","name":"Purchase pin","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"ad6d6312-0b3c-432b-8b87-894231b02e50\",\r\n \"productId\": 0,\r\n \"amount\": 500,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"type\": {\r\n \"id\": 2,\r\n \"name\": \"Purchase\"\r\n },\r\n \"debit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"credit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"transmission\": {\r\n \"id\": \"c44b9193-96a6-4c35-bf23-6d3eeb8941c8\",\r\n \"stan\": \"404\",\r\n \"rrn\": \"228\",\r\n \"transmissionutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"posentrymode\": \"1\",\r\n \"terminalcode\": \"oA1So\",\r\n \"entityid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"currencycode\": \"1\",\r\n \"track2data\": \"6094690000000000021\",\r\n \"pinblock\": \"13424982A205F947\",\r\n \"keydata\": \"\",\r\n \"keyX917\": \"\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"referenceid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/v1/transaction/dto"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 21 Apr 2026 13:06:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"df06bf3a-83f5-47fa-a96e-32f0d5dad816\",\n \"sourcetransactionid\": \"505a202e-7a01-454e-a974-1aa6da2ca5ba\",\n \"dateprocessedutc\": \"2026-04-21T13:06:40.8519734Z\",\n \"processcode\": 2300,\n \"responsecode\": \"00\",\n \"authorizationid\": 279414,\n \"balance\": 2500,\n \"amount\": 500,\n \"details\": \"Purchase approved\"\n}"},{"id":"5e2e39d1-1f36-4942-9714-49e225ec07d7","name":"Purchase non pin","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"687236c8-2784-4418-85b2-e58472792905\",\r\n \"productId\": 0,\r\n \"amount\": 150,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {\r\n \"number\": \"9710390100009438046\"\r\n },\r\n \"type\": {\r\n \"id\": 2,\r\n \"name\": \"Purchase\"\r\n },\r\n \"debit\": {\r\n \"number\": \"9710390100009438046\"\r\n },\r\n \"credit\": {\r\n \"number\": \"9710390100009438046\"\r\n },\r\n \"transmission\": {\r\n \"id\": \"83ae6bea-69de-4af7-bb81-d3cea687e76f\",\r\n \"stan\": \"610\",\r\n \"rrn\": \"865\",\r\n \"transmissionutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"posentrymode\": \"1\",\r\n \"terminalcode\": \"oA1So\",\r\n \"entityid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"currencycode\": \"1\",\r\n \"track2data\": \"9710390100009438046\",\r\n \"pinblock\": \"\",\r\n \"keydata\": \"\",\r\n \"keyX917\": \"\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"referenceid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/v1/transaction/dto"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 21 Apr 2026 13:07:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"c5b7a2dc-67f7-495b-9efd-0170b9196845\",\n \"sourcetransactionid\": \"1b7b8aa4-ce09-4851-b07d-2ce4bb4c9092\",\n \"dateprocessedutc\": \"2026-04-21T13:07:44.8523061Z\",\n \"processcode\": 2300,\n \"responsecode\": \"00\",\n \"authorizationid\": 895245,\n \"balance\": 3050,\n \"amount\": 150,\n \"details\": \"Purchase approved\"\n}"}],"_postman_id":"850ec03f-5208-449d-8481-f2a57b6fae72"},{"name":"Deposit","id":"cbdfa461-2a2e-41d9-ab4f-03c743a349b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"TempKey4"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"09bb2835-c176-4d62-be15-5a8956af110b\",\r\n \"productId\": 0,\r\n \"amount\": 500,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {\r\n \"number\": \"{{Card3}\"\r\n },\r\n \"type\": {\r\n \"id\": 1,\r\n \"name\": \"Deposit\"\r\n },\r\n \"debit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"credit\": {\r\n \"number\": \"9710390100009438046\"\r\n },\r\n \"transmission\": {\r\n \"id\": \"a3286152-8e64-4698-b36b-04625cf68409\",\r\n \"stan\": \"179\",\r\n \"rrn\": \"676\",\r\n \"transmissionutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"posentrymode\": \"1\",\r\n \"terminalcode\": \"oA1So\",\r\n \"entityid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"currencycode\": \"1\",\r\n \"track2data\": \"6094690000000000021\",\r\n \"pinblock\": \"13424982A205F947\",\r\n \"keydata\": \"\",\r\n \"keyX917\": \"\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"referenceid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/v1/transaction/dto","description":"

Deposit Transaction

This endpoint allows you to credit a specified amount to a Supercard. It processes a deposit transaction by sending the necessary details in the request body.

Request Body

The request body should be in JSON format and include the following parameters:

id (string, required): The unique identifier for the transaction.
\n
productId (number, required): The ID of the product associated with the transaction.
\n
amount (number, required): The amount of money to be credited in the transaction.
\n
reference (string, required): A reference string for tracking the transaction.
\n
dateproccessedutc (string, required): The date and time when the transaction was processed, formatted in UTC.
\n
card (object, required): An object containing details about the card used for the transaction.
\n
- type (object, required): An object specifying the type of transaction, which includes:
  \n
  - id (number, required): The identifier for the transaction type.
    \n
  - name (string, required): The name of the transaction type (e.g., Deposit).
    \n
  \n
\n
debit (object, required): An object containing details of the debit card or account used in the transaction, specifically:
\n
- number (string, required): The card number for the debit account.
\n
credit (object, required): An object containing details of the credit card or account involved in the transaction, specifically:
\n
- number (string, required): The card number for the credit account.
\n
transmission (object, required): An object with details about the transmission of the transaction, including:
\n
- id (string, required): The unique identifier for the transmission.
  \n
- stan (string, required): The system trace audit number.
  \n
- rrn (string, required): The retrieval reference number.
  \n
- transmissionutc (string, required): The UTC time of the transmission.
  \n
- posentrymode (string, required): The method used to enter the point of sale.
  \n
- terminalcode (string, required): The code for the terminal processing the transaction.
  \n
- entityid (string, required): The unique identifier for the entity involved in the transaction.
  \n
- currencycode (string, required): The code representing the currency of the transaction.
  \n
- track2data (string, required): The track 2 data from the card.
  \n
- pinblock (string, optional): The encrypted PIN block.
  \n
- keydata (string, optional): Additional key data.
  \n
- keyX917 (string, optional): Key data in X917 format.
  \n
- entityreference (string, required): A reference identifier for the entity.
  \n
- referenceid (string, required): A unique identifier for tracking the reference.
  \n
\n
provider (object, required): An object containing details about the provider handling the transaction.
\n

Response

The response will be in JSON format and may include the following fields:

id (string): The unique identifier for the transaction.
\n
sourcetransactionid (string): The source transaction identifier.
\n
dateproccessedutc (string): The date and time when the transaction was processed in UTC.
\n
processcode (number): The process code indicating the status of the transaction.
\n
authorizationid (string|null): The authorization identifier for the transaction, if applicable.
\n
balance (number|null): The balance after the transaction, if applicable.
\n
amount (number): The amount processed in the transaction.
\n
details (string|null): Additional details about the transaction, if any.
\n

\n","urlObject":{"protocol":"https","path":["v1","transaction","dto"],"host":["test.api.supercard.co.za"],"query":[],"variable":[]}},"response":[{"id":"6c25e52c-6f48-4e9c-ae7c-284fe30b5341","name":"Deposit Pin","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"7bb63208-7f3b-4b11-b4ef-2c797e0cad72\",\r\n \"productId\": 0,\r\n \"amount\": 500,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"type\": {\r\n \"id\": 1,\r\n \"name\": \"Deposit\"\r\n },\r\n \"debit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"credit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"transmission\": {\r\n \"id\": \"256c2c2c-4968-4c54-a0a7-6737eeb927c3\",\r\n \"stan\": \"575\",\r\n \"rrn\": \"657\",\r\n \"transmissionutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"posentrymode\": \"1\",\r\n \"terminalcode\": \"oA1So\",\r\n \"entityid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"currencycode\": \"1\",\r\n \"track2data\": \"6094690000000000021\",\r\n \"pinblock\": \"13424982A205F947\",\r\n \"keydata\": \"\",\r\n \"keyX917\": \"\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"referenceid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/v1/transaction/dto"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 12 Mar 2026 19:03:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"},{"key":"Request-Context","value":"appId=cid-v1:678a4c97-dae0-402e-8d6d-928caeb3af72"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"sourcetransactionid\": \"02ad00c7-ee38-4bc4-9012-089245b1caee\",\n \"dateproccessedutc\": \"2026-03-12T19:03:18.0793377Z\",\n \"processcode\": 0,\n \"authorizationid\": 554951,\n \"balance\": 50000,\n \"amount\": 50000,\n \"details\": null\n}"},{"id":"dbd4d12b-4031-4629-9ae1-269dbe76ed6e","name":"Deposit","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"2b6c65d6-7b79-4bb0-a810-cf18f5796e60\",\r\n \"productId\": 0,\r\n \"amount\": 500,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {\r\n \"number\": \"9710390100009438046\"\r\n },\r\n \"type\": {\r\n \"id\": 1,\r\n \"name\": \"Deposit\"\r\n },\r\n \"debit\": {\r\n \"number\": \"9710390100009438046\"\r\n },\r\n \"credit\": {\r\n \"number\": \"9710390100009438046\"\r\n },\r\n \"transmission\": {\r\n \"id\": \"82c7fa2e-6dc4-4c2c-9150-65c81db69cf0\",\r\n \"stan\": \"469\",\r\n \"rrn\": \"960\",\r\n \"transmissionutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"posentrymode\": \"1\",\r\n \"terminalcode\": \"oA1So\",\r\n \"entityid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"currencycode\": \"1\",\r\n \"track2data\": \"9710390100009438046\",\r\n \"pinblock\": \"\",\r\n \"keydata\": \"\",\r\n \"keyX917\": \"\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"referenceid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/v1/transaction/dto"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 21 Apr 2026 13:20:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"45d472e8-b94f-4daa-a93e-92ca255174cc\",\n \"sourcetransactionid\": \"9caca5d4-492a-4f6c-b1e7-404e30bee2f9\",\n \"dateprocessedutc\": \"2026-04-21T13:20:33.7511854Z\",\n \"processcode\": 2400,\n \"responsecode\": \"00\",\n \"authorizationid\": 397329,\n \"balance\": 3550,\n \"amount\": 500,\n \"details\": \"Deposit approved\"\n}"}],"_postman_id":"cbdfa461-2a2e-41d9-ab4f-03c743a349b5"},{"name":"Reversal","id":"d7d9d337-8039-47f0-915a-700763fefddd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"TempKey4"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"ad5c1bee-5ac2-4627-95fb-b0fc8ca119b1\",\r\n \"productId\": 0,\r\n \"amount\": 0.00,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"type\": {\r\n \"id\": 4,\r\n \"name\": \"Reversal\"\r\n },\r\n \"debit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"credit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"transmission\": {\r\n \"id\": \"5a0748c1-5ccb-4061-98cf-a9926625e152\",\r\n \"stan\": \"90\",\r\n \"rrn\": \"530\",\r\n \"transmissionutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"posentrymode\": \"1\",\r\n \"terminalcode\": \"oA1So\",\r\n \"entityid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"currencycode\": \"1\",\r\n \"track2data\": \"6094690000000000021\",\r\n \"pinblock\": \"13424982A205F947\",\r\n \"keydata\": \"\",\r\n \"keyX917\": \"\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"referenceid\": \"505a202e-7a01-454e-a974-1aa6da2ca5ba\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/v1/transaction/dto","urlObject":{"protocol":"https","path":["v1","transaction","dto"],"host":["test.api.supercard.co.za"],"query":[],"variable":[]}},"response":[],"_postman_id":"d7d9d337-8039-47f0-915a-700763fefddd"},{"name":"Preauth sms","id":"6ccda7b6-4515-438c-abc3-c4cc591d3f89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"TempKey4"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":" {\"id\": \"b48ca397-031c-453e-9793-2ff27cefe742\",\r\n \"card\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"type\": {\r\n \"id\": 50,\r\n \"name\": \"Preauth\",\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"debit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"credit\": {},\r\n \"transmission\": {\r\n \"id\": \"cfab77cf-d4f3-4612-a3e4-cde0316454da\",\r\n \"authchannel\": \"SMS\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/transaction/preauth/dto","description":"

Deposit Transaction

This endpoint allows you to credit a specified amount to a Supercard. It processes a deposit transaction by sending the necessary details in the request body.

Request Body

The request body should be in JSON format and include the following parameters:

id (string, required): The unique identifier for the transaction.
\n
productId (number, required): The ID of the product associated with the transaction.
\n
amount (number, required): The amount of money to be credited in the transaction.
\n
reference (string, required): A reference string for tracking the transaction.
\n
dateproccessedutc (string, required): The date and time when the transaction was processed, formatted in UTC.
\n
card (object, required): An object containing details about the card used for the transaction.
\n
- type (object, required): An object specifying the type of transaction, which includes:
  \n
  - id (number, required): The identifier for the transaction type.
    \n
  - name (string, required): The name of the transaction type (e.g., Deposit).
    \n
  \n
\n
debit (object, required): An object containing details of the debit card or account used in the transaction, specifically:
\n
- number (string, required): The card number for the debit account.
\n
credit (object, required): An object containing details of the credit card or account involved in the transaction, specifically:
\n
- number (string, required): The card number for the credit account.
\n
transmission (object, required): An object with details about the transmission of the transaction, including:
\n
- id (string, required): The unique identifier for the transmission.
  \n
- stan (string, required): The system trace audit number.
  \n
- rrn (string, required): The retrieval reference number.
  \n
- transmissionutc (string, required): The UTC time of the transmission.
  \n
- posentrymode (string, required): The method used to enter the point of sale.
  \n
- terminalcode (string, required): The code for the terminal processing the transaction.
  \n
- entityid (string, required): The unique identifier for the entity involved in the transaction.
  \n
- currencycode (string, required): The code representing the currency of the transaction.
  \n
- track2data (string, required): The track 2 data from the card.
  \n
- pinblock (string, optional): The encrypted PIN block.
  \n
- keydata (string, optional): Additional key data.
  \n
- keyX917 (string, optional): Key data in X917 format.
  \n
- entityreference (string, required): A reference identifier for the entity.
  \n
- referenceid (string, required): A unique identifier for tracking the reference.
  \n
\n
provider (object, required): An object containing details about the provider handling the transaction.
\n

Response

The response will be in JSON format and may include the following fields:

id (string): The unique identifier for the transaction.
\n
sourcetransactionid (string): The source transaction identifier.
\n
dateproccessedutc (string): The date and time when the transaction was processed in UTC.
\n
processcode (number): The process code indicating the status of the transaction.
\n
authorizationid (string|null): The authorization identifier for the transaction, if applicable.
\n
balance (number|null): The balance after the transaction, if applicable.
\n
amount (number): The amount processed in the transaction.
\n
details (string|null): Additional details about the transaction, if any.
\n

\n","urlObject":{"protocol":"https","path":["transaction","preauth","dto"],"host":["test.api.supercard.co.za"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ccda7b6-4515-438c-abc3-c4cc591d3f89"},{"name":"Deposit preauth required","id":"4abb0ee3-86d7-4fc7-887f-b8e99563ccbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"TempKey4"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"9fa75120-7ff9-44f8-969e-6a970dbf874a\",\r\n \"productId\": 0,\r\n \"amount\": 120,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2026-01-22T11:39:51.4950526Z\",\r\n \"card\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"type\": {\r\n \"id\": 1,\r\n \"name\": \"Deposit\"\r\n },\r\n \"debit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"credit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"transmission\": {\r\n \"id\": \"4e03d983-b80e-4b59-b751-1427c744b2fe\",\r\n \"stan\": \"650\",\r\n \"rrn\": \"664\",\r\n \"authchannel\": \"SMS\",\r\n \"transmissionutc\": \"2026-01-22T11:39:51.4950526Z\",\r\n \"posentrymode\": \"1\",\r\n \"terminalcode\": \"oA1So\",\r\n \"entityid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"currencycode\": \"1\",\r\n \"track2data\": \"6094690000000000021\",\r\n \"pinblock\": \"\",\r\n \"keydata\": \"230604\", \r\n \"keyX917\": \"\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"referenceid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/v1/transaction/dto","description":"

Deposit Transaction

This endpoint allows you to credit a specified amount to a Supercard. It processes a deposit transaction by sending the necessary details in the request body.

Request Body

The request body should be in JSON format and include the following parameters:

id (string, required): The unique identifier for the transaction.
\n
productId (number, required): The ID of the product associated with the transaction.
\n
amount (number, required): The amount of money to be credited in the transaction.
\n
reference (string, required): A reference string for tracking the transaction.
\n
dateproccessedutc (string, required): The date and time when the transaction was processed, formatted in UTC.
\n
card (object, required): An object containing details about the card used for the transaction.
\n
- type (object, required): An object specifying the type of transaction, which includes:
  \n
  - id (number, required): The identifier for the transaction type.
    \n
  - name (string, required): The name of the transaction type (e.g., Deposit).
    \n
  \n
\n
debit (object, required): An object containing details of the debit card or account used in the transaction, specifically:
\n
- number (string, required): The card number for the debit account.
\n
credit (object, required): An object containing details of the credit card or account involved in the transaction, specifically:
\n
- number (string, required): The card number for the credit account.
\n
transmission (object, required): An object with details about the transmission of the transaction, including:
\n
- id (string, required): The unique identifier for the transmission.
  \n
- stan (string, required): The system trace audit number.
  \n
- rrn (string, required): The retrieval reference number.
  \n
- transmissionutc (string, required): The UTC time of the transmission.
  \n
- posentrymode (string, required): The method used to enter the point of sale.
  \n
- terminalcode (string, required): The code for the terminal processing the transaction.
  \n
- entityid (string, required): The unique identifier for the entity involved in the transaction.
  \n
- currencycode (string, required): The code representing the currency of the transaction.
  \n
- track2data (string, required): The track 2 data from the card.
  \n
- pinblock (string, optional): The encrypted PIN block.
  \n
- keydata (string, optional): Additional key data.
  \n
- keyX917 (string, optional): Key data in X917 format.
  \n
- entityreference (string, required): A reference identifier for the entity.
  \n
- referenceid (string, required): A unique identifier for tracking the reference.
  \n
\n
provider (object, required): An object containing details about the provider handling the transaction.
\n

Response

The response will be in JSON format and may include the following fields:

id (string): The unique identifier for the transaction.
\n
sourcetransactionid (string): The source transaction identifier.
\n
dateproccessedutc (string): The date and time when the transaction was processed in UTC.
\n
processcode (number): The process code indicating the status of the transaction.
\n
authorizationid (string|null): The authorization identifier for the transaction, if applicable.
\n
balance (number|null): The balance after the transaction, if applicable.
\n
amount (number): The amount processed in the transaction.
\n
details (string|null): Additional details about the transaction, if any.
\n

\n","urlObject":{"protocol":"https","path":["v1","transaction","dto"],"host":["test.api.supercard.co.za"],"query":[],"variable":[]}},"response":[],"_postman_id":"4abb0ee3-86d7-4fc7-887f-b8e99563ccbe"},{"name":"Purchase preauth required","id":"2c0059ab-cc79-42cd-aed8-fdce5463e203","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"TempKey4"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"5c1f9033-3a58-4d75-9e54-baec1770184c\",\r\n \"productId\": 0,\r\n \"amount\": 200,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2026-01-22T11:39:51.4950526Z\",\r\n \"card\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"type\": {\r\n \"id\": 2,\r\n \"name\": \"Purchase\"\r\n },\r\n \"debit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"credit\": {\r\n \"number\": \"6094690000000000021\"\r\n },\r\n \"transmission\": {\r\n \"id\": \"44186922-a671-4b94-a836-bb48ec6b8dd0\",\r\n \"stan\": \"742\",\r\n \"rrn\": \"338\",\r\n \"authchannel\": \"SMS\",\r\n \"transmissionutc\": \"2026-01-22T11:39:51.4950526Z\",\r\n \"posentrymode\": \"1\",\r\n \"terminalcode\": \"oA1So\",\r\n \"entityid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"currencycode\": \"1\",\r\n \"track2data\": \"6094690000000000021\",\r\n \"pinblock\": \"\",\r\n \"keydata\": \"171082\", \r\n \"keyX917\": \"\",\r\n \"entityreference\": \"SCoA1SoK\",\r\n \"referenceid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"provider\": {\r\n \"Name\": \"Supercard\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.api.supercard.co.za/v1/transaction/dto","description":"

Deposit Transaction

This endpoint allows you to credit a specified amount to a Supercard. It processes a deposit transaction by sending the necessary details in the request body.

Request Body

The request body should be in JSON format and include the following parameters:

id (string, required): The unique identifier for the transaction.
\n
productId (number, required): The ID of the product associated with the transaction.
\n
amount (number, required): The amount of money to be credited in the transaction.
\n
reference (string, required): A reference string for tracking the transaction.
\n
dateproccessedutc (string, required): The date and time when the transaction was processed, formatted in UTC.
\n
card (object, required): An object containing details about the card used for the transaction.
\n
- type (object, required): An object specifying the type of transaction, which includes:
  \n
  - id (number, required): The identifier for the transaction type.
    \n
  - name (string, required): The name of the transaction type (e.g., Deposit).
    \n
  \n
\n
debit (object, required): An object containing details of the debit card or account used in the transaction, specifically:
\n
- number (string, required): The card number for the debit account.
\n
credit (object, required): An object containing details of the credit card or account involved in the transaction, specifically:
\n
- number (string, required): The card number for the credit account.
\n
transmission (object, required): An object with details about the transmission of the transaction, including:
\n
- id (string, required): The unique identifier for the transmission.
  \n
- stan (string, required): The system trace audit number.
  \n
- rrn (string, required): The retrieval reference number.
  \n
- transmissionutc (string, required): The UTC time of the transmission.
  \n
- posentrymode (string, required): The method used to enter the point of sale.
  \n
- terminalcode (string, required): The code for the terminal processing the transaction.
  \n
- entityid (string, required): The unique identifier for the entity involved in the transaction.
  \n
- currencycode (string, required): The code representing the currency of the transaction.
  \n
- track2data (string, required): The track 2 data from the card.
  \n
- pinblock (string, optional): The encrypted PIN block.
  \n
- keydata (string, optional): Additional key data.
  \n
- keyX917 (string, optional): Key data in X917 format.
  \n
- entityreference (string, required): A reference identifier for the entity.
  \n
- referenceid (string, required): A unique identifier for tracking the reference.
  \n
\n
provider (object, required): An object containing details about the provider handling the transaction.
\n

Response

The response will be in JSON format and may include the following fields:

id (string): The unique identifier for the transaction.
\n
sourcetransactionid (string): The source transaction identifier.
\n
dateproccessedutc (string): The date and time when the transaction was processed in UTC.
\n
processcode (number): The process code indicating the status of the transaction.
\n
authorizationid (string|null): The authorization identifier for the transaction, if applicable.
\n
balance (number|null): The balance after the transaction, if applicable.
\n
amount (number): The amount processed in the transaction.
\n
details (string|null): Additional details about the transaction, if any.
\n

\n","urlObject":{"protocol":"https","path":["v1","transaction","dto"],"host":["test.api.supercard.co.za"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c0059ab-cc79-42cd-aed8-fdce5463e203"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"0e0d509b-584e-40e4-9057-3c1608651efd","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"d584c0ef-046f-4a0f-ae4d-5e9f71836ef0","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"baseURL","value":"test.api.supercard.co.za"},{"key":"TerminalCode","value":"oA1So"},{"key":"EntityReference","value":"SCoA1SoK"},{"key":"Card","value":"6094690000000000021"},{"key":"Pinblock","value":"13424982A205F947"},{"key":"x-api-key","value":"TempKey4"},{"key":"Card3","value":"9710390100009438046"},{"key":"Provider","value":"Supercard"}]}