Purchase API

post

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

This API is used by the Credit+ Issuing system to processthe Purchase transaction. This API is application for Credit, Debit and Prepaid products.

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.
Description: 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

HTTPS Code	Error Code	Description	Details
200	000	Successful.
401	107	REFER TO CARD ISSUER.
401	200	CAPTURE CARD.
401	100	Do Not Honour.
401	207	PICK-UP CARD.
400	304	Error in field.
400	110	Invalid Amount.
400	905	Invalid Client.
400	903	Invalid Currency.
400	307	Format Error.
400	114	Invalid Account Type.
401	116	Insufficient Fund.
404	181	No Current Account.
404	182	No Saving Account.
403	119	Transaction not permitted.
403	102	Suspected fraud.
403	121	Exceeds Amount Limit.
403	122	Security violation.
403	123	Frequency Exceeded.
404	719	Invalid/nonexistent account specified (general).
400	184	Invalid date.
403	913	Duplicate transmission detected.
500	909	System Malfunction.
400	997	Form Factor field is mandatory.
400	997	FormFactorType field is invalid.
400	997	Form Factor Type is mandatory.
400	997	Program Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400	997	Device Plan Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400	997	Product Type field is invalid.
400	997	Only alphanumeric characters and underscore are allowed.
400	997	FORM_FACTOR field value must have max length 24.
400	CNA006	Multiple device numbers are active for given details.
400	CNA002	Card Number Alias Functionality is not applicable for this Institution.
400	CNA003	Record does not exists for the given details.
400	CNA001	Bank Does Not Exists.
400	997	acceptorTerminalId field is mandatory.
400	997	acquirerCountryCode field is mandatory.
400	997	acquiringInstitutionCode field is mandatory.
400	997	billingAmt field is mandatory.
400	997	billingCurrency field is mandatory.
400	997	channel field is mandatory.
400	997	mcc field is mandatory.
400	997	rrn field is mandatory.
400	997	traceAuditNumber field is mandatory.
400	997	txnamount field is mandatory.
400	997	txnCurrency field is mandatory.
400	997	transactionDateTime field is mandatory.
400	997	dateTimeTransmission field is mandatory.
400	997	acceptorId field value must have size 15.
400	997	acceptorNameLocation field value must have size 40.
400	997	acceptorTerminalId field value must have size 8.
400	997	acquirerCountryCode field value must have size 3.
400	997	billingAmt field value must have size 12.
400	997	billingCurrency field value must have size 3.
400	997	channel field value must have size 3.
400	997	formFactorType field value must have size 3.
400	997	formFactorExpiryDate field value must have size 4.
400	997	mcc field value must have size 4.
400	997	rrn field value must have size 12.
400	997	txnamount field value must have size 12.
400	997	txnCurrency field value must have size 3.
400	997	transactionDateTime field value must have size 14.
400	997	dateTimeTransmission field value must have size 10.
400	997	acquiringInstitutionCode field value must have max length 11.
400	997	trackTwoData field value must have max length 40.
400	997	billingAmt field must be a positive value with maximum 12 integers and 0 fractions.
400	997	currencyConversionRate field must be a positive value with maximum 8 integers and 0 fractions.
400	997	txnamount field must be a positive value with maximum 12 integers and 0 fractions.
400	997	billingCurrency field must be numeric.
400	997	surchargeFee must start with character 'D'.
400	997	surchargeFee field must have character 'D' followed by eight numeric characters.
400	997	txnCurrency field must be numeric.
400	997	channel field is invalid.
400	997	formFactor field value must have min length 10.
400	997	formFactorExpiryDate field should be empty for form factor type CNA and CPI.
400	997	formFactorExpiryDate field must be in yyMM format.
400	997	transactionDateTime field must be in yyyyMMddHHmmss format.
400	997	dateTimeTransmission field must be in MMddHHmmss format.
403	900	User Or Bank does not support API.
500	BASPAR001	MCC field is required for Purchase Transaction.
500	VALFRM002	Invalid.
500	VALFRM003	Invalid Device.
500	VALFRM004	Invalid Device.
500	VALFRM024	Device is not stoplisted.
500	VALFRM026	Error while getting device details.
500	VALFRM005	Invalid Card Pack Id.
500	VALFRM006	Invalid Client.
500	VALFRM007	Invalid form factor type.
500	VALFRM008	Device status is not normal.
500	VALFRM023	Error while validating form factor.
500	HDEERR001	Error in Device and Device Plan Selection.
500	VALFRM046	Error getting device details.
500	VALEXP001	Expiry Date can not be null.
500	VALEXP002	Expiry Date is not matching.
500	BPINU002	Error in Device Selection.
500	GETCNT002	Invalid card pack id.
500	VALEXP004	Expiry Date is null.
500	VALEXP005	Expiry Date is not matching.
500	VALEXP006	Expiry Date should be null.
500	VALEXP007	Error while validating expiry date.
500	GETDEV001	Invalid device.
500	GETDEV002	Invalid Card pack id.
500	GETDEV003	Invalid client code.
500	GETDEV004	Error while fetching device number.
500	GETCNT001	Invalid device.
500	GETCNT003	Invalid client code.
500	GETCNT004	Error while fetching device number.
500	BASPAR002	Invalid Datetime.
500	CHKRRN002	Error in Fun CHKRRN002 FUN_CHECK_RRN_TAN_CARD_TXN_DATE.
500	BASPAR003	Invalid device number.
500	CHKRRN000	RRN already exists.
500	CHKRRN001	RRN already exists.
500	CHKRRN002	Error while processing.
500	BASPAR004	Transaction API field validation is failed due to an internal error. Please contact system admin.
500	3	INVALID MERCHANT.
500	4	DO NOT HONOR, PICK-UP.
500	5	DECLINED.
500	6	CONTROL FIELD EDIT ERROR.
500	7	SUSPECTED FRAUD, PICK-UP.
500	11	APPROVED (VIP).
500	12	ACCOUNT TYPE NOEXIST.
500	13	INVALID AMOUNT.
500	14	INVALID CARD NUMBER.
500	15	UNKNOWN ISSUER ON SWITCH.
500	19	RE-ENTER TRANSACTION.
500	21	NO ACTION TAKEN.
500	25	UNABLE TO LOCATE RECORD ON FILE.
500	28	LOCKED FILE.
500	39	NO CREDIT ACCOUNT.
500	41	LOST CARD, PICK-UP.
500	43	STOLEN CARD, PICK-UP.
500	51	INSUFFICIENT FUNDS.
500	52	NO CHEQUING ACCOUNT.
500	53	NO SAVING ACCOUNT.
500	54	EXPIRED CARD.
500	55	PIN DATA REQUIRED.
500	57	TRANSACTION NOT PERMITTED TO CARDHOLDER.
500	61	EXCEEDS WITHDRAWAL AMOUNT LIMIT.
500	62	RESTRICTED CARD.
500	63	SECURITY VIOLATION.
500	65	EXCEEDS WITHDRAWAL FREQUENCY LIMIT.
500	75	ALLOWABLE NUMBER OF PIN TRIES EXCEEDED.
500	79	ALREADY ADJUSTED.
500	80	INVALID DATE.
500	81	PIN KEY ERROR.
500	82	INVALID CVV.
500	83	UNABLE TO VERIFY CVV/PIN.
500	84	RESPONSE RECEIVED TOO LATE.
500	85	NO REASON TO DECLINE.
500	86	UNABLE TO VERIFY CVV/PIN.
500	87	CUTOFF RECONCILIATION.
500	88	CUTOFF IS IN PROCESS.
500	89	UNAVAILABLE CUTOFF RECONCILIATION WITH MEMBER.
500	91	ISSUER OR SWITCH IS INOPERATIVE.
500	92	UNABLE TO ROUTE TRANSACTION.
500	93	UNABLE TRANSACTION PROCESS.
500	96	SYSTEM MALFUNTION.
500	N7	Invalid CVV2.
500	100	Do Not Honour.
500	101	EXPIRED CARD.
500	102	Suspected fraud.
500	103	Card acceptor contact acquirer.
500	106	Allowable Pin tries exceeded.
500	107	REFER TO CARD ISSUER.
500	109	Invalid Merchant.
500	110	Invalid Amount.
500	111	Invalid card number.
500	112	PIN data required.
500	113	Unacceptable fee.
500	114	Invalid Account Type.
500	116	Insufficient Fund.
500	117	Incorrect PIN.
500	118	No card record.
500	119	Transaction not permitted.
500	120	TRANSACTION NOT PERMITTED ACQUIRER.
500	121	Exceeds Amount Limit.
500	122	Security violation.
500	123	Frequency Exceeded.
500	125	Card not effective.
500	126	Invalid PIN Format.
500	181	No Current Account.
500	182	No Saving Account.
500	183	CVV Verification Failure.
500	184	Invalid date.
500	191	CVV2/CVC2/CVD2/4CSC Verification Failure.
500	192	CVV2/CVC2/CVD2 Verification Failure.
500	200	CAPTURE CARD.
500	207	PICK-UP CARD.
500	208	LOST CARD, PICK-UP.
500	209	STOLEN CARD, PICK-UP.
500	211	Per transaction Cash limit exceeded.
500	212	Purchase Limit Exceeded.
500	213	Per transaction Travel and Entertainment limit exceeded.
500	214	Per transaction Fund Transfer limit exceeded.
500	215	Daily Cash Limit Exceeded.
500	216	Daily Purchase Limit Exceeded.
500	217	Daily Transport and Entertainment Limit Exceeded.
500	218	Daily Inter Bank Fund Transfer Limit Exceeded.
500	219	Daily Total Limit Exceeded.
500	220	Periodic Purchase Limit Exceeded.
500	221	Periodic Cash Limit Exceeded.
500	222	Periodic Transport and Entertainment Limit Exceeded.
500	223	Periodic Inter Bank Fund Transfer Limit Exceeded.
500	224	Periodic Total Limit Exceeded.
500	225	MCC Transaction Limit Exceeded For International Transaction.
500	226	MCC Daily Amount Limit Exceeded For International Transaction.
500	227	MCC Period Amount Limit Exceeded For International Transaction.
500	228	MCC Daily Count Limit Exceeded For International Transaction.
500	229	MCC Periodic Count Limit Exceeded For International Transaction.
500	271	FT Incoming Min Amount Violated.
500	272	FT Incoming Per Transaction Amt Exceeded.
500	273	FT Incoming Daily Amt Limit Exceeded.
500	274	FT Incoming Daily Velocity Exceeded.
500	275	FT Incoming Periodic Amt Limit Exceeded.
500	276	FT Incoming Periodic Velocity Exceeded.
500	277	FT Incoming Yearly Amt Limit Exceeded.
500	280	RUPAY ECOM ERROR.
500	283	AMOUNT IS LESS THAN MINIMUM LOAD AMOUNT ALLOWED.
500	284	AMOUNT EXCEEDED PER TRANSACTION LOAD LIMIT.
500	285	Velocity: DAILY LOAD VELOCITY EXHAUSTED.
500	286	AMOUNT EXCEEDED DAILY LOAD LIMIT ALLOWED.
500	287	Velocity: Periodic LOAD VELOCITY EXHAUSTED.
500	288	AMOUNT EXCEEDED PERIODIC LOAD LIMIT ALLOWED.
500	289	Velocity: Periodic LOAD VELOCITY EXHAUSTED.
500	290	AMOUNT EXCEEDED YEARLY LOAD LIMIT ALLOWED.
500	291	VELOCITY: MAX NUMBER OF LOAD EXHAUSTED.
500	292	FT Outgoing Daily Amt Limit Exceeded.
500	293	FT Outgoing Daily Velocity Exceeded.
500	294	FT Outgoing Periodic Amt Limit Exceeded.
500	295	FT Outgoing Periodic Velocity Exceeded.
500	296	FT Outgoing Yearly Amt Limit Exceeded.
500	278	FT Incoming Yearly Velocity Limit Exceeded.
500	298	FT Outgoing Minimum Amount Limit Violated.
500	299	FT Outgoing Per Txn Limit Exceeded.
500	480	Transaction Aged.
500	902	Invalid Transaction.
500	903	Invalid Currency.
500	904	Invalid Institution.
500	905	Invalid Client.
500	907	Issuer Switch Inoperative.
500	909	System Malfunction.
500	911	Issuer timed out.
500	912	Service not available.
500	914	Original Transaction Not Found.
500	993	Unable to verify PIN.
500	995	Object Not in Sync.
500	REQ	Response not received from third party.
500	6	Partial Approval.
500	115	Function Not Supported.
500	104	Restricted card/Card Not permitted.
500	908	Unable to route transaction.
500	719	Invalid/nonexistent account specified (general).
500	297	FT Outgoing Yearly Velocity Limit Exceeded.
500	913	Duplicate transmission detected.
500	502	Error When Fetching Data from client_aggregate_tot.
500	503	Error while converting amount.
500	504	Error in calculating aggregate periods.
500	131	MID-TID Block.
500	710	Deemed Approve.
500	915	Timeout Reversal not supported.
500	910	Invalid Biller/Payee ID.
500	996	Debit-limit Update failed.
500	505	Exceeded Aggregate Monthly Load Limit on Client.
500	506	Exceeded Aggregate Monthly Velocity.
500	507	Exceeded Aggregate Yearly Load Limit on Client.
500	508	Exceeded Aggregate Yearly Velocity.
500	509	Invalid travel type chosen, limits not defined under this program.
500	510	PER trip limit exceeded.
500	511	PER YEAR TRAVEL limit exceeded.
500	512	Internal error while validating travel LIMITS.
500	513	ERROR WHILE UPDATING TRAVEL USAGE COUNTERS.
500	514	ERROR WHILE UPDATING CLIENT USAGE COUNTERS.
500	515	Internal error while validating aggregate LIMITS.
500	516	No active or upcoming travel trip exist for device.
500	TRANSACTION_PROCESSING_TIMEOUT	The 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.
500	TRANSACTION_PROCESSING_FAILURE	The transaction cannot be processed. Please try after some time.
400	994	Invalid Encryption-Algorithm header value.
400	994	Invalid Encryption Request Parameters.
400	994	Cryptography error.
500	988	Encryption Algorithm Not Supported.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

acceptorId

string

length between 15 and 15

^[a-zA-Z0-9]{15}$

Unique ID to identify the merchant from where the transaction is initiated. Alphanumeric. Length: 15. Spaces are not allowed. Example: 123456789123456

acceptorNameAndLocation

string

length between 40 and 40

^[a-zA-Z0-9]{40}$

Name and location of the card acceptor. Alphanumeric. Length: 40. Spaces are not allowed. Example: 1234567890123456789012345678901234567890

acceptorTerminalId

string

required

length between 8 and 8

^[a-zA-Z0-9]{8}$

Identification code of acceptor terminal. Alphanumeric. Length: 8. Not Null. Spaces are not allowed. Example: ABCDEFGH

acquirerCountryCode

string

required

length between 3 and 3

^[a-zA-Z0-9]{3}$

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

acquiringInstitutionCode

string

required

length between 11 and 11

^[a-zA-Z0-9]{11}$

Acquiring institution code identifies the acquiring institution; that is, merchant’s bank or its agent. Alphanumeric. Length: 11. Not Null. Example: 222333

billingAmt

string

required

length between 12 and 12

^[0-9]{12}$

Billing amount. Alphanumeric. Length: 12. Not Null, Numeric and cannot be negative. Currency Exponent validation. Needs to be converted to ISO format while assigning to mapper. Example: 000000000500

billingCurrency

string

required

length between 3 and 3

^[0-9]{3}$

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

channel

string

required

length between 3 and 3

^API$

Delivery Channel Controller ID - Three-character code identifying the controller. Alphanumeric. Length: 3. Value should be 'API'. Example: API

currencyConversionRate

string

length ≤ 8

^[0-9]{1,8}$

Currency Conversion Rate. Numeric. Length: 7, 8. Numeric and cannot be negative. Needs to be converted to ISO format while assigning to mapper. Example: 61000000

formFactor

string

required

length between 10 and 24

^[a-zA-Z0-9]{10,24}$

It will contain either Card Number or Card Number Alias or Card Pack ID based on the formFactorType value. Not Null. Maximum length: 24. Minimum length: 10 (minimum length is not applicable for CNA). Alphanumeric. Example: RP23SEP or 5301682345434310

formFactorExpiry

string

length between 4 and 4

^[0-9]{4}$|^$

Expiry date of the card number. Format: YYMM. Length: 4. Not Null if the form factor is selected as 'CRD'. Example: 2906

formFactorType

string

enum

required

length between 3 and 3

It is used to identify whether Card Number (CRD) or Card Number Alias (CNA) or Card Pack ID (CPI) is received in request. Alphanumeric. Length: 3. Not Null. Either CRD or CNA or CPI. Example: CNA or CRD

Allowed:

mcc

string

required

length between 4 and 4

^[0-9]{4}$

Merchant Category Code. Merchant category code identifies the merchant’s type of business or service. It must be a valid code from list of MCCs available in Quick reference booklet published by interchange/schemes. Alphanumeric. Length: 4. Not null. Example: 5999

productType

string

enum

length ≤ 1

Product type (Credit, Debit and Prepaid). Alphanumeric. Length: 1. Valid Value- 'P','D','C'. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA. Example: P

Allowed:

programCode

string

length ≤ 6

^[A-Z0-9][A-Z0-9_]*[A-Z0-9]$

Program Code. Alphanumeric. Length: 6. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA. Example: HJU001

devicePlan

string

length ≤ 10

^[A-Z0-9][A-Z0-9_]*[A-Z0-9]$

Device Plan. Alphanumeric. Length: 10. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA. Example: FHITG85778

rrn

string

required

length between 12 and 12

^[a-zA-Z0-9]{12}$

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

surchargeFee

string

length ≤ 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. If present should be as per given format. For example, Eg; D12345678. Where 1st char is alphanumeric and must be D. Rest 8 characters are numeric. Alphanumeric. Length: 9. Example: D00000045

traceAuditNumber

string

required

length between 6 and 6

^[a-zA-Z0-9]{6}$

A number assigned by the originator of a transaction to uniquely identify a transaction. Alphanumeric. Length: 6. Not Null. Example: 999999

txnAmount

string

required

length between 12 and 12

^[0-9]{12}$

Transaction amount. Numeric. Length: 12, 7. Not Null, Numeric and cannot be negative. Currency Exponent validation. Needs to be converted to ISO format while assigning to mapper. Example: 000000000500

txnCurrency

string

required

length between 3 and 3

^[0-9]{3}$

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

transactionDateTime

string

required

length between 14 and 14

^[0-9]{14}$

Transaction local date and time [yyyyMMddHHmmss]. yyyy – 0000 to 9999, MM – 01 to 12, DD – 01 to 31, HH – 00 to 23, mm – 00 to 59, ss – 00 -59. Alphanumeric. Length: 14. Not Null, Value should be in given format. Example: 20190923101000

dateTimeTransmission

string

required

length between 10 and 10

^[0-9]{10}$

Transaction time – GMT [MMDDhhmmss]. MM – 01 to 12, DD – 01 to 31, HH – 00 to 23, mm – 00 to 59, ss – 00 -59. Alphanumeric. Length: 10. Not Null. Value should be in given format and its values. Example: 0916000000

posEntryMode

string

required

length between 3 and 3

^[0-9]{3}$

POS Entry Mode. It indicates the method used for PAN entry to initiate a transaction and the PIN entry capabilities. Refer to DE-22 details present in ‘Customer Interface Specification’ published by Pine Labs for values and their description. Should be in line with Pine Labs card format. Fixed Length: 3. Example: 010

posPinCaptureCode

string

required

length between 2 and 2

^[0-9]{2}$

POS Pin Capture Mode. It indicates the technique, maximum number or both of PIN characters that can be accepted by the POS terminal used to construct the PIN data. Refer to DE-26 details present in ‘Customer Interface Specification’ published by Pine Labs for values and their description. Should be in line with Pine Labs card format. Fixed Length: 2. Example: 00

pointServiceCodes

string

required

length ≤ 999

^[a-zA-Z0-9]+$

Point of service Data. It indicates the conditions that exist at the point of service at the time of transaction. Refer to DE-61 details present in ‘Customer Interface Specification’ published by Pine Labs for values and their description. Should be in line with Pine Labs card format. Maximum Length: 999. Example: 000000000070035690210

timestamp

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

emvData

string

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

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

encKey

string

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

ASN.1 DER encoded DES key block to be encrypted under Pine Labs RSA public key. DES key block to have: DES key, Initialization vector (IV). Use IV as 99999999999999999999999999999999. Example: Triple DES Key (Hex): E63BABBCD09713F7A126C4B5CB67D607D9EF83FD79751CEF. IV: 99999999999999999999999999999999. ASN.1 DER encoded DES key block: 302C0418E63BABBCD09713F7A126C4B5CB67D607D9EF83FD79751CEF04109999999999999999999999999999999999. Encrypt ASN.1 DER encoded DES key block and encode the output in HEX format. CIPHER TYPE to be used: 'RSA ECB OAEP With SHA-1 And MGF1 Padding'. Alphanumeric.

sourceBlock

string

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

Old PIN Block created with below standard format ISO 9564-1 & ANSI X9.8 format 0. Encrypt this PIN Block under double length DES key (DES-112). CIPHER TYPE to be used: 'DESede ECB with No Padding'. Alphanumeric.

sourceEncKey

string

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

ASN.1 DER encoded DES key block to be encrypted under Pine Labs RSA public key. DES key block to have: DES key, Initialization vector (IV). Use IV as 99999999999999999999999999999999. Example: Double DES Key (Hex): E63BABBCD09713F7A126C4B5CB67D607. IV: 99999999999999999999999999999999. ASN.1 DER encoded DES key block: 30240410E63BABBCD09713F7A126C4B5CB67D60704109999999999999999999999999999999999. Encrypt ASN.1 DER encoded DES key block and encode the output in Hex format. CIPHER TYPE to be used: 'RSA ECB OAEP With SHA-1 And MGF1 Padding'. Alphanumeric.

Headers

Correlation-ID

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.

Source

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

200Successful transaction.