API Reference

Transfer Credit

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

This API is used to process transfer credit transactions in Credit+ Issuing system. It can also be consumed by the Acquiring institutions, if enabled through the requisite system parameter on processing center level.

NOTE: The API, if sent with Card Number Alias (CNA), will fetch the corresponding associated device for further processing only if DEVICE _STATUS_CODE = NORMAL (0) OR (DEVICE_STATUS_CODE = UPGRADE (9) AND UPGRADE_STATUS = 1).

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.
  • Details: This is the detailed description of the error code returned by Credit+ Issuing application
HTTP CodeError CodeReasonDetails
400997Transaction Type field is invalid.
400100Do Not Honour.
400-1Incorrect result size: expected 1, actual 0.
400991Form Factor Not Supported CNA.
400991Form Factor Not Supported CPI.
403900User Or Bank does not support API.
400119Transaction not permitted.
400200CAPTURE CARD.
400107REFER TO CARD ISSUER.
403900Bank Not Registered.
500INVCHA002Channel Error-Invalid channel - 21.
500INVCHA001Invalid channel - 21.
400997Channel field must be numeric.
400997Channel field value must have size 2.
400905Invalid CVV2, DOB, Expiry date or Old Pin.
400994Invalid Encryption-Algorithm header value.
400994Invalid Encryption Request Parameters.
400994Cryptography error.
500920PIN change operation is not permitted.
500TRANSACTION_PROCESSING_TIMEOUTThe transaction processing has got timed out. Please try after some time.A reversal entry would be created for the transaction only if the processing is successful.
500TRANSACTION_PROCESSING_FAILUREThe transaction cannot be processed. Please try after some time.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 15 and 15
^[0-9]{15}$

Card Acceptor ID. This is mandatory for Closed Loop Programs. Fixed Length: 15. Spaces are not allowed. Example: 123456789123456

string
length between 40 and 40
^[A-Za-z0-9]{40}$

Merchant location. This is mandatory for Closed Loop Programs. Fixed Length: 40. Spaces are not allowed. Example: 1234567890123456789012345678901234567890

string
required
length between 8 and 8
^[A-Za-z0-9]{8}$

Card Acceptor terminal ID. This is mandatory for Closed Loop Programs. Fixed Length: 8. Spaces are not allowed. Example: ABCDEFGH

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

ISO Acquirer Country code of the transaction. Not Null. Fixed Length: 3. Example: 356

string
required
length ≤ 11
^[0-9]+$

Institution Code identifying the acquirer. Not Null. Maximum Length: 11. Example: 212213

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

Billing amount. Not Null. Numeric ISO amount format and positive validation. Fixed Length: 12. Example: 000000009000

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

Billing Currency Code Numeric ISO Currency Code. Not Null. Fixed Length: 3. Example: 356

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

Network Code. Should have two digit for value; for example, network code '31' which Indicates Network - 'Private Network API'. Network should be Configured for the Institution. Refer to the Network Codes configured in Customer Portal on 'Processing Center > Setup > Master Parameters > Network' screen. Fixed Length: 2. Example: 31

string
length between 8 and 8
^[0-9]{8}$|^$

Currency Conversion Rate. Numeric ISO amount format. Used for only display purpose only. If present, should be numeric and greater than 0. Fixed Length: 8. Example: 57100000

string
length ≤ 10
^[A-Za-z0-9][A-Za-z0-9_]*[A-Za-z0-9]$|^$

Device Plan Code attached with the device. Alphanumeric. Maximum Length: 10. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA. Example: ''

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

POS Entry Mode. Should be in line with Pine Labs card format. Refer DE-22 values. Fixed Length: 3. Example: 010

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

POS Pin Capture Mode. Should be in line with Pine Labs card format. Refer DE-26 values. Fixed Length: 2. Example: 00

string
required
length ≤ 999
^[0-9]+$

Point of service Data. Should be in line with Pine Labs card format refer DE-61 values. Maximum Length: 999. Example: 000000000070035690210

string
^[0-9A-Fa-f]+$

EMV Data. Should be in line with Pine Labs card format. Hex Encoded. Example: 5F2A020356820258008407A0000000041010950500000000009A031911159C01009F02060000000015009F10120110250000044000DAC100000000000000009F1A0208409F2608AFA989E946D5E7299F2701809F3303E0E8E89F34031E03009F360200039F37040C886796

string
required
length between 10 and 24
^[A-Za-z0-9]+$

It is a Card Number or Card Pack ID or Card Number Alias depending on the formFactorType value. String. Maximum length: 24. Minimum length: 10 (Minimum length is not applicable for CNA). Example: 5847740000090073

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

Expiry date of the device number in YYMM format. This field will present if the selected formFactorType is CRD. Fixed Length: 4. Example: 4012

string
enum
required
length between 3 and 3

Indicates the data that is being sent in formFactor attribute. Valid values: CRD: Card Number, CPI: Card Pack ID, CNA: Card Number Alias. Not NULL. Maximum length: 3. Either CRD or CPI or CNA. Example: CRD

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

Merchant Category Code. Not null. Fixed Length: 4. Example: 5999

string
^[A-Za-z0-9]+$

This is derived after decrypting sourceBlock.

string
enum
length ≤ 1

Product type of Device. Valid values: P: Pre-paid, D: Debit, C: Credit. String. Must be P, D or C. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA. Fixed Length: 1. Example: ''

Allowed:
string
length ≤ 6
^[A-Za-z0-9][A-Za-z0-9_]*[A-Za-z0-9]$|^$

Program attached to the device. Alphanumeric. Maximum Length: 6. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA. Example: ''

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

It can be used to retrieve the original transaction data. It is Mandatory and a Unique Authorization Reference Number (Reference Retrieval Number). Not Null. Fixed Length: 12. Example: 201921151077

string
length between 9 and 9
^D[0-9]{8}$|^$

This field contains transaction fee if applied. This will contain any surcharge fee applied for the transaction with the Sign. This is having 2 subfields: 1. Fee Sign: D, format: A.1, 2. Fee Amount, format: N.8. If present should be as per given format; for example, D12345678 where first character is alphanumeric and must be D, remaining 8 characters are numeric. Fixed Length: 9. Example: D00000045

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. Not Null. Fixed Length: 6. Example: 905988

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

Transaction amount. Not Null. Numeric ISO amount format and positive validation. Fixed Length: 12. Example: 000000009000

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

Transaction Currency Code. Not Null. Numeric ISO Currency Code. Fixed Length: 3. Example: 356

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

Transaction local date and time in YYYYMMDDHHmmss format. YYYY – 0000 to 9999, MM – 01 to 12, DD – 01 to 31, HH – 00 to 23, mm – 00 to 59, ss – 00 -59. Not Null. Value should be in given format. To be converted to YYYYMMDDHHmmss format while mapping to DE field of mapper. Fixed Length: 14. Example: 20250224101000

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

Transaction time in GMT in MMDDhhmmss format. Fixed Length: 10. Example: 0222000000

string
required
^[0-9]+$

Current UTC timestamp in milliseconds. Numeric. AES key expiration criteria depends on input UTC timestamp. Applicable only for encrypted requests. Example: 1563877848815

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:
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?