Credit Card Bill Payment

post

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

This API is used to process credit card bill payment requests. The Credit+ Issuing system receives, validates and processes the request. If the request is successful, the cardholder will receive the bill payment message in response. If the request fails, the system returns the corresponding error code.
The system sends the successful response only if the request message passes on all input parameters and the payment transaction is processed successfully.
A failure response is sent if any of the request message parameters fail in validation/pre-screening checks. Further, it is also sent if all the request message parameter validation are successful; however, the payment transaction couldn't be processed successfully.

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 Code	Error Code	Reason
201	000	Request processed successfully
400	997	Payment Transaction Request failed: invalid request
403	900	Invalid User
404	998	Device(s) does not exist
500	999	Invalid Request Type
400	997	Form Factor Type field is mandatory.
400	997	Form Factor Type field is invalid.
400	997	Form Factor field is mandatory.
400	997	Form Factorfield should be numeric for Form Factor Type 'CRD'.
400	997	Form Factor field should be alphanumeric and without space for Form Factor Type 'ACT'.
400	997	Transaction Type field is mandatory.
400	997	Transaction Type field is invalid.
400	997	Transaction Code field is mandatory.
400	997	Transaction Code field is invalid.
400	997	Transaction Amount field is mandatory.
400	997	Transaction Amount field must be a positive value with maximum scale 14 integers and precision 7 fractions.
400	997	Transaction Currency industry standard code is mandatory.
400	997	Transaction Currency field value must have max length 3.
400	997	Transaction Reference Number field is mandatory.
400	997	Transaction Reference Number field is not allowed for Transaction Type Original.
400	997	MICR Code field should be numeric.
400	997	Cheque Number field is mandatory.
400	997	Cheque Number field value must have size 6.
400	997	Cheque Number field should be numeric.
400	997	Cheque Date field is mandatory.
400	997	Cheque Date field must be in dd-MM-YYYY format.
400	997	Cheque Return Reason Code field is mandatory.
400	997	Value Date field is mandatory.
400	997	Value Date field must be in dd-MM-YYYY format.
400	997	OTB Release Date field is mandatory.
400	997	OTB Release Date field must be in dd-MM-YYYY format.
500	999	Invalid device number.
500	TRAN003	Invalid Wallet number.
500	TRAN004	Error while fetching Wallet details.
500	TRAN001	Transaction notset in Transaction Plan.
500	TRAN002	Transaction limit plan not attached.
500	TRAN005	Transaction Reference number is mandatory in case of reversal.
500	TRAN006	Cheque return reason is mandatory for Outstation cheque payment/cheque payment reversal.
500	TRAN007	Invalid Cheque return reason.
500	TRAN011	OTB release date should not be greater than transaction date.
500	PAY36	Reversal already exists for Chq.No.
500	PAY37	Original Record not found for Chq.No.
500	PAY38	Error while saving details for Chq.No.
500	TRAN008	Error while executing Transaction Payment API
500	TRAN020	Invalid Transaction currency.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

transactionCode

string

enum

required

length ≤ 2

Transaction Code. Must be 53 (Internet Payment/Reversal), 54 (Fund Transfer/Reversal), 55 (Phone Banking Payment/Reversal), 56 (ECS Payment/Reversal), 57 (Outstation Cheque Payment/Reversal), 58 (DD Payment/Reversal), 59 (Cash Payment/Reversal), or 61 (CHQ Payment/Reversal). Maximum length: 2.

formFactorType

string

enum

required

length ≤ 3

Identifies if it is card number or account number. Must be CRD (Card Number) or ACT (Account Number). Not NULL. Maximum length: 3.

Allowed:

formFactor

string

required

length ≤ 24

Card number if formFactorType is CRD, or account number if formFactorType is ACT. Numeric for CRD, alphanumeric without space for ACT. Maximum length: 24.

transactionType

string

enum

required

length ≤ 1

Transaction Type. Must be O (Original Transaction) or R (Reversal Transaction). Maximum length: 1.

Allowed:

transactionAmount

string

required

^[0-9]{1,14}(\.[0-9]{1,7})?$

Total payment amount decimalized as per currency exponent. Maximum length (14,7).

transactionCurrency

string

required

length ≤ 3

^[0-9]{3}$

Numeric ISO currency code in which the transaction was done. Maximum length: 3.

transactionDate

string

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

The date on which the transaction was captured or initiated. Format: DD-MM-YYYY.

valueDate

string

required

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

Posted to Account date when the payment will be posted to the Cardholder's account. Format: DD-MM-YYYY.

otbReleaseDate

string

required

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

The date on which the applicable Open-to-Buy (OTB) amount will be released from the cardholder's account for further usage. Format: DD-MM-YYYY.

txnRefNumber

string

length ≤ 23

Acquirer Reference Number (ARN). Must be present for reversal transactions when transactionType is R. Maximum length: 23.

paymentRefNumber

string

length ≤ 12

Payment reference number maintained by the bank at their end. Maximum length: 12.

chequeNumber

string

length ≤ 6

^[0-9]{6}$

Cheque Number for local and outstation cheque. Must be present if transactionCode is 57 or 61. Maximum length: 6.

chequeDate

string

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

Cheque Date. Must be present if transactionCode is 57 or 61. Format: DD-MM-YYYY.

micrCode

string

length ≤ 9

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

MICR code mentioned on outstation or local cheque. Maximum length: 9.

bankName

string

length ≤ 50

Bank name mentioned on outstation or local cheque. Maximum length: 50.

branch

string

length ≤ 15

Bank branch mentioned on outstation or local cheque. Maximum length: 15.

chequeRetReasonCode

string

length ≤ 3

Cheque return reason code indicating reasons for bounced/returned cheques by clearing house or bank’s system. Must be present for reversal transactions when transactionType is R and transactionCode is 57 or 61. Maximum length: 3.

note

string

length ≤ 40

Any free text that requestor may want to send for logging purpose. Maximum length: 40.

channel

string

length ≤ 10

Accessing Channel. Maximum length: 10.

Headers

Correlation-ID

string

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

API Consumer must share a Correlation-ID in the HTTP header for API requests. The Correlation-ID must be unique for each request. It is recommended to generate 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 the 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

201Bill payment processed successfully