{"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\": \"8f0b1414-de0b-4b00-8347-0c1db855ceec\",\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 \"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\": \"dc8e3a8f-a159-4754-8ad1-3567f2ad31cf\",\r\n \"stan\": \"148\",\r\n \"rrn\": \"775\",\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/transaction/authorisation/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":["transaction","authorisation","dto"],"host":["test.api.supercard.co.za"],"query":[],"variable":[]}},"response":[{"id":"b00a8a5b-66f4-4fba-9c58-e3d43e3b929a","name":"Balance Enquiry pin card","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"4be5a672-6d12-4f36-a214-e5a9feec30df\",\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 \"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\": \"32ead765-9a82-4300-9c84-ff20b8b2b8ea\",\r\n \"stan\": \"743\",\r\n \"rrn\": \"537\",\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/transaction/authorisation/dto"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 13 Mar 2026 08:56:24 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\": \"4be5a672-6d12-4f36-a214-e5a9feec30df\",\n \"dateproccessedutc\": \"2026-03-13T08:56:24.3994884Z\",\n \"processcode\": 0,\n \"authorizationid\": 554954,\n \"balance\": 45000,\n \"amount\": 0,\n \"details\": null\n}"},{"id":"f268bd1f-a97c-461f-9b1b-0d1c366aa29f","name":"Balance Enquiry non pin","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"b9a2b556-c415-4a62-a832-958348ce7602\",\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 \"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\": \"0ec96501-66e0-4c4b-a9b5-1d12c5158c8c\",\r\n \"stan\": \"263\",\r\n \"rrn\": \"265\",\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/transaction/authorisation/dto"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 12 Mar 2026 19:00:05 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\": \"ea87894a-1a99-40c1-bd02-4249c9523f30\",\n \"dateproccessedutc\": \"2026-03-12T19:00:05.2867608Z\",\n \"processcode\": 0,\n \"authorizationid\": 554949,\n \"balance\": 390000,\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\": \"3cd3ad7c-dbbd-4d68-b921-8472a8c4cae7\",\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 \"type\": {\r\n \"id\": 1,\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\": \"ffbb2337-bb92-482a-ba58-ea18cabb8733\",\r\n \"stan\": \"104\",\r\n \"rrn\": \"635\",\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":"2052a482-40d8-4272-b5f0-dfa2f8a9c4e0","name":"Purchase No Pin","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"0da77e33-c967-4140-abaa-569e2a59e62f\",\r\n \"productId\": 0,\r\n \"amount\": 50.00,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {},\r\n \"type\": {\r\n \"id\": 1,\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\": \"d9268e45-399f-4121-b9fc-720943ab0824\",\r\n \"stan\": \"884\",\r\n \"rrn\": \"324\",\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":"json","header":[{"key":"Date","value":"Fri, 30 May 2025 11:27:14 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\": \"2ca332c1-c9e1-41dc-8ef5-ec94ee098185\",\n \"dateproccessedutc\": \"2025-05-30T11:27:14.4215693Z\",\n \"processcode\": 0,\n \"authorizationid\": 553273,\n \"balance\": 12950,\n \"amount\": 2525,\n \"details\": null\n}"},{"id":"89b8e899-c288-460f-b32d-1ba86de33a4b","name":"Purchase Pin","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"7d9261df-6d54-47df-ba75-58d52d944920\",\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 \"type\": {\r\n \"id\": 1,\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\": \"351c30ef-288c-4181-ae37-c739b1e501e9\",\r\n \"stan\": \"455\",\r\n \"rrn\": \"377\",\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:05: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"},{"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\": \"c9d46cf3-5848-4936-993c-706e281dd236\",\n \"dateproccessedutc\": \"2026-03-12T19:05:02.9302619Z\",\n \"processcode\": 0,\n \"authorizationid\": 554953,\n \"balance\": 45000,\n \"amount\": 5000,\n \"details\": null\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\": \"d5d2f372-83f6-47ef-b3a0-4f840d6b4f9d\",\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 \"type\": {\r\n \"id\": 2,\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\": \"c172efba-7d43-4420-9182-1a828bda273f\",\r\n \"stan\": \"131\",\r\n \"rrn\": \"776\",\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":"9e62efb0-5971-4028-922c-cb649b1de84d","name":"Deposit No Pin","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"a2cae06c-094b-457b-9587-3e0f23163cd7\",\r\n \"productId\": 0,\r\n \"amount\": 100,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {},\r\n \"type\": {\r\n \"id\": 2,\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\": \"49f1d2ee-9e8e-4baf-8f47-ebcad5374c1b\",\r\n \"stan\": \"276\",\r\n \"rrn\": \"450\",\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":"json","header":[{"key":"Date","value":"Fri, 30 May 2025 11:26:37 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\": \"758ac098-2a4f-424f-b3e4-5e73ad90ecaa\",\n \"dateproccessedutc\": \"2025-05-30T11:26:37.8048685Z\",\n \"processcode\": 55,\n \"authorizationid\": null,\n \"balance\": null,\n \"amount\": 10000,\n \"details\": null\n}"},{"id":"6c25e52c-6f48-4e9c-ae7c-284fe30b5341","name":"Deposit Pin","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"83f5199c-c93b-410f-b507-640a2ecf51b8\",\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 \"type\": {\r\n \"id\": 2,\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\": \"e2c386c6-38b6-430d-85cd-a31c793db3a8\",\r\n \"stan\": \"4\",\r\n \"rrn\": \"902\",\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}"}],"_postman_id":"cbdfa461-2a2e-41d9-ab4f-03c743a349b5"},{"name":"Reversal","id":"d389a829-2fe8-40dc-b98a-7064c406e593","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\": \"7a4d8972-257f-4632-bfcd-9712b77f4c57\",\r\n \"productId\": 0,\r\n \"amount\": 100,\r\n \"reference\": \"string\",\r\n \"dateproccessedutc\": \"2025-02-27T06:29:31.602Z\",\r\n \"card\": {},\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\": \"c5c6d387-1fae-47d0-a279-6651892cc5e1\",\r\n \"stan\": \"263\",\r\n \"rrn\": \"500\",\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\": \"\",\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":"

Reversal Transaction

This endpoint allows you to reverse a previously processed transaction by creating a mirror entry with reversed debit and credit flows.

Request Body

id (string, required): The unique identifier for the reversal transaction.
\n
productId (number, required): The ID of the product associated with this reversal.
\n
amount (number, required): The amount to be reversed.
\n
reference (string, required): A reference note or identifier for this reversal.
\n
dateproccessedutc (string, required): The UTC date and time when the reversal is processed, in ISO 8601 format.
\n
card (object, required): Details of the card used for the original transaction (can be empty or include relevant card metadata).
\n
- type (object, required):
  \n
  - id (number): The transaction type ID; for reversals this must be 4.
    \n
  - name (string): The transaction type name; for reversals this must be \"Reversal\".
    \n
  \n
\n
debit (object, required):
\n
- number (string): The card number to debit (same as credit for reversal).
\n
credit (object, required):
\n
- number (string): The card number to credit back (same as debit for reversal).
\n
transmission (object, required):
\n
- id (string): The unique identifier for this transmission record.
  \n
- stan (string): System Trace Audit Number for tracking.
  \n
- rrn (string): Retrieval Reference Number for reconciliation.
  \n
- transmissionutc (string): UTC timestamp when the reversal transmission is sent, in ISO 8601 format.
  \n
- posentrymode (string): POS entry mode code (e.g., \"1\").
  \n
- terminalcode (string): The code of the terminal performing the reversal.
  \n
- entityid (string): UUID of the entity initiating the reversal (often \"00000000-0000-0000-0000-000000000000\" if not applicable).
  \n
- currencycode (string): Numeric currency code (e.g., \"1\" for ZAR).
  \n
- track2data (string): Track 2 data from the card (same as card number for reversal).
  \n
- pinblock (string): Encrypted PIN block (can be empty).
  \n
- keydata (string): Key data for encryption (can be empty).
  \n
- keyX917 (string): X9.17 key data for encryption (can be empty).
  \n
- entityreference (string): Reference string for the entity (e.g., SCoA1SoK).
  \n
- referenceid (string): UUID referencing the original transaction (use \"00000000-0000-0000-0000-000000000000\" if not applicable).
  \n
- provider (object): Details of the transaction provider (can be empty or include provider metadata).
  \n
\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":"37bad2b0-1a1b-4690-8918-2c8b0a5237b3","name":"Reversal","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"9eb2038a-83b5-475f-ab0c-4f634d99baa4\",\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 \"type\": {\r\n \"id\": 4,\r\n \"name\": \"Reversal\"\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\": \"38e81dfa-fe04-477e-a53d-53f4276a1949\",\r\n \"stan\": \"822\",\r\n \"rrn\": \"711\",\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\": \"1320C055-CD38-4466-81CD-865ADBF4995D\",\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":"json","header":[{"key":"Date","value":"Tue, 03 Jun 2025 13:44:53 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\": \"8f572dbb-ab21-442d-a6a3-dd84b5d1a110\",\n \"dateproccessedutc\": \"2025-06-03T13:44:53.5062733Z\",\n \"processcode\": 40,\n \"authorizationid\": null,\n \"balance\": null,\n \"amount\": 10000,\n \"details\": null\n}"}],"_postman_id":"d389a829-2fe8-40dc-b98a-7064c406e593"},{"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\": \"f2bcb45f-81f4-46b3-ab69-1cce56e96f9c\",\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 \"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\": \"8211ad7f-0fe8-4504-8558-3beb193fe9e0\",\r\n \"stan\": \"27\",\r\n \"rrn\": \"70\",\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\": \"24e610b8-13b3-4e8c-81cf-f297e1c12fc69\",\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"}],"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"}]}