API Reference

Reversal API

post
https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/transactions/reversal

This API is used by an institution to process transaction rejection/reversal in Credit+ Issuing system in case of failure so that the cardholder can be credited. The Credit+ Issuing receives a reversal request through an API. The system performs validations and credits the amount back to the carholder. This API is applicable for the credit, debit, prepaid products of the Credit+ Issuing system for the Pine Labs network only.

HTTP Status and Response Status Matrix

  • HTTP Code: This is the response status code issued by a server in response to a client's request made to the server.
  • Error Code: This is the error code returned by Credit+ Issuing application in the ‘code’ field of the response message indicating if the request was processed successfully or failed.
  • Reason: This is the description of the error code returned by Credit+ Issuing application.
HTTP CodeError CodeReasonDetails
201000Success
400997Channel field is mandatory
400997Transaction Type field is mandatory
400997Transaction Type field is invalid
400997Trace Audit Number field is mandatory
400997Trace Audit Number field value must have size 6
400997Retrieval Reference Number field is mandatory
400997Retrieval Reference Number field value must have max length 12
400997Transmission Date Time field is mandatory
400997Transmission Date Time field must be in MMddHHmmss format
400997Transaction Local Date field is mandatory
400997Transaction Local Date field must be in yyMMddHHmmss format
400997Transaction Amount field is mandatory
400997Transaction Amount field value must have size 12
400997Transaction Currency field is mandatory
400997POS Data field is mandatory
400997POS Data field is invalid
400997Card Acceptor Terminal ID field is mandatory
400997Card Acceptor Terminal ID field value must have size 8
400997Card Acceptor Code field is mandatory
400997Card Acceptor Code field value must have size 15
400997Card Acceptor Name Location field is mandatory
400997Card Acceptor Name Location field value must have max length 100
400997Acquiring Country Code field is mandatory
400997Reversal Reason Code field is mandatory
400997Reversal Reason Code field value must have size 4
400997Original Transaction Reference Number field is mandatory
400997Original Transaction Reference Number field value must have max length 12
400997Original Trace Audit Number field is mandatory
400997Original Trace Audit Number field value must have size 6
400997Original Transmission Date field is mandatory
400997Original Transmission Date field must be in MMddHHmmss format
400997Original Transaction Date field is mandatory
400997Original Transaction Date field must be in yyMMddHHmmss format
400997Transaction Currency field should be Number
403900User Or Bank does not support API
404998Invalid Device
500999Error while processing request
500912Forward offset time limit violated
500913Backward offset time limit violated
500951System Internal Error
400902Invalid Transaction
500909System Malfunction
404914Original Transaction not Found
500TRANSACTION_PROCESSING_FAILUREThe transaction cannot be processed. Please try after some time
400994Invalid Encryption-Algorithm header value
400994Invalid Encryption Request Parameters
400994Cryptography error
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Accessing channel. Valid values: MAO if transactionType is QR. For transactionType 01, 03, TC, or TD, valid channels are: 31 (API Private Network 1), 32 (API Net Banking), 33 (API ATM), 34 (API Mobile). These values are valid only if configured for the institution on Card Management > Institution Parameter Setup > Transaction Registration.

Allowed:
string
required
length ≤ 24
^[0-9]+$

Valid Device Number. Not NULL.

string
enum
required

Transaction type. Valid values: QR (QR Reversal), 01 (Purchase Reversal), 03 (Cash Advance/Cash Out Reversal), TC (Transfer Credit Reversal), TD (Transfer Debit Reversal).

Allowed:
string
required
length between 6 and 6
^[0-9]{6}$

A number assigned by the originator of a transaction to uniquely identify a transaction throughout its life. Fixed length: 6. Not NULL.

string
required
length between 12 and 12
^[0-9]{12}$

Mandatory and Unique Authorization Reference Number. Fixed length: 12. Not NULL.

string
required
^(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])([01]\d|2[0-3])([0-5]\d)([0-5]\d)$

Channel transmission date & time in format MMddHHmmss. Not NULL.

string
required
^\d{2}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])([01]\d|2[0-3])([0-5]\d)([0-5]\d)$

Transaction date & time of the transaction Acceptor in format YYMMDDHHMMSS. Not NULL.

string
required
length between 12 and 12
^[0-9]{12}$

Must have a valid Numeric Value for Financial Transaction and Non-Financial Transaction with fee. Not NULL. Must be greater than 0. In fixed length of 12-digit format, e.g., for 50 Rs value would be '000000005000'.

string
required
length between 3 and 3
^[0-9]{3}$

3 digit numeric currency code in which the amount is specified. Not NULL. Numeric ISO 3-digit Currency Code.

string
enum
required

POS data is calculated based on pos entry mode, pos pin capture mode and point service code. Fixed value: '000000100001'.

Allowed:
string
required
length between 8 and 8
^[a-zA-Z0-9]{8}$

Identification code of acceptor terminal. It is the same as original. Fixed length: 8. Not NULL.

string
required
length between 15 and 15
^[a-zA-Z0-9]{15}$

Identification of acquiring entity. It is the same as original. Fixed length: 15. Not NULL.

string
required
length ≤ 100
^[a-zA-Z0-9\s]+$

Name and location of acceptor. It is the same as original. Maximum length: 100.

string
required
length between 3 and 3
^[0-9]{3}$

Acquiring country code of the original transaction to be sent. Fixed length: 3 numeric. Not NULL.

string
required
length between 6 and 6
^[0-9]{6}$

Acquiring Institution ID. Fixed length: 6. Not NULL.

string
required
length between 4 and 4
^[0-9]{4}$

Reversal Reason code. Fixed 4-digit number. The request is processed successfully for all reason codes passed in this field. The balance is also updated correctly, except for: 4000 (CUSTOMER CANCELLATION), 4352 (CASH_RETAIN), 4013 (NET_FAILED), 4353 (NET DISCONNECT), 4360 (UNKNOWN AMOUNT DISPENSED).

reversalData
object
required

Mandatory in case of reversal transactions.

string
^[0-9]+$

Current UTC timestamp in milliseconds. AES key expiration criteria depends on input UTC timestamp.

Headers
string
^[a-zA-Z0-9-]{1,50}$

API Consumer must share Correlation-ID in HTTP header for API requests. The Correlation-ID must be unique for each request. It is recommended to generate a universally unique identifier (UUID) of length 32 or 36 that is compliant with RFC 4122. The maximum supported length is 50 alphanumeric characters. For example, ac97d177-9345-4934-8343-0f91a7a02836. If the Correlation-ID is not received in the incoming request, the system generates the UUID dynamically and assigns it to the request.

string
enum
required

API Consumer must share Encryption-Algorithm as a key (value: DES168) in HTTP header in order to encrypt the API requests.

Allowed:
string

API Consumer can share Source in HTTP header for API requests. For the list of Source values, see the Pre-conditions for HTTP Header of REST API topic in the Pre-requisite for Rest API section.

Response

Updated about 1 year ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?