API Reference

Utility Bill Payment API

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

A vendor initiates a utility bill payment request. Credit+ Issuing will receive the request and performs the validations. If the validations are passed, a bill payment transaction is posted. It is logged in transaction table and updates the ‘Open to Buy (OTB)’ value and sends the transaction details as the response message.

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.
HTTPS CodeError CodeReason
201HDS000Request processed successfully
400997Month’s data is invalid
403900Invalid User
404998Device(s) does not exist
500999Statement not available for last 3
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 4

Denotes the type of message. Alphanumeric. Must not be null. Maximum Length: 4.

string
required
length ≤ 24

Unique code of a device. Alphanumeric. Must be a valid card number. Maximum Length: 24.

string
enum
required
length ≤ 6

Unique code of each process. Alphanumeric. Must be 840000. Maximum Length: 6.

Allowed:
string
required
length ≤ 12

Amount of the transaction. Alphanumeric. Should be divided by 100 to get the monetary value as this is coming without decimal in input file. Maximum Length: 12.

string
length ≤ 14
^\d{2}\d{2}\d{4}\d{2}\d{2}\d{2}$

Date on which the transaction was captured or initiated. Alphanumeric. DDMMCCYYHHMMSS format. Should be a valid date. Maximum Length: 14.

string
required
length ≤ 6

Unique code of a transaction. Alphanumeric. No validations. Transaction code defined in system should be used. Maximum Length: 6.

string
length ≤ 4
^\d{2}\d{2}$

Year and month on which the card will expire. Alphanumeric. YYMM format. Should be a valid date. Maximum Length: 4.

string
required
length ≤ 4

Merchant Category Code (MCC). Used to classify the business by the type of goods or services it provides. Alphanumeric. Maximum Length: 4.

string
required
length ≤ 3

Unique code of a country. Alphanumeric. Maximum Length: 3.

string
required
length ≤ 3

Unique code of a function. Alphanumeric. Maximum Length: 3.

string
required
length ≤ 15

Unique code of a terminal. Alphanumeric. Maximum Length: 15.

string
required
length ≤ 15

Unique code of a merchant. Alphanumeric. Maximum Length: 15.

string
length ≤ 40

Name of a merchant. Alphanumeric. Maximum Length: 40.

string
required
length ≤ 3

Unique code of a currency. Alphanumeric. Maximum Length: 3.

string
required
length ≤ 6
^\d{2}\d{2}\d{2}$

Date from which the payment is initiated. Alphanumeric. DDMMYY format. Should be a valid date. Maximum Length: 6.

string
required
length ≤ 3

Number of times the transaction is performed per day or for a selected duration. Alphanumeric. Maximum Length: 3.

string
required
length ≤ 12

Unique code of payee. Alphanumeric. Maximum Length: 12.

Headers
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.

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

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?