Billing Cycle Change API

post

https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/helpdesk/billingcyclechange

This API is used to change billing cycle for requests received through various channels such as online banking or mobile banking.
The Credit+ Issuing system receives, validates and processes the request. If the request is successful, the card’s billing cycle is changed,system logsthe “Billing Cycle Change” (Service Code: 201)service request (SR) and sendsthe service request number in the response message. If the request fails, the system returns the corresponding error code in the response and the SR is not logged.

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	HDS000	Billing Cycle change fee applied successfully
400	997	Billing Cycle Change Request failed: invalid request
403	900	Invalid User
404	998	Card Number(s) does not exist
500	999	Invalid Request Type
400	997	Device Number field is mandatory.
400	997	Device Number field should be numeric.
400	997	Request Date field is mandatory.
400	997	Request Date field must be in MM/DD/YYYY HH:MM:SS format.
400	997	Request Date should be less than or equal to institution date.
400	997	Priority Request field is invalid.
400	997	Billing Cycle field should be numeric

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

deviceNumber

string

required

length ≤ 24

^[0-9]+$

Card number. Numeric, not null, maximum length 24.

priorityRequest

string

enum

Denotes whether the request is to be taken on priority or not. Valid values are 0 for no priority, 1 for priority request, or null.

Allowed:

note

string

Any free text that requestor may want to send for logging purpose.

channel

string

Accessing channel.

requestDate

string

required

^(0[1-9]|1[0-2])/(0[1-9]|[12][0-9]|3[01])/([0-9]{4}) ([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$

Denotes the date and time of request in MM/DD/YYYY HH:MM:SS format. Must be less than or equal to the institution date.

billingCycle

string

required

^[0-9]+$

Billing cycle. Numeric.

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

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful billing cycle change