GET token
This operation will allow Client to generate token.
Endpoint
Headers
Authorization: Bearer token Content-Type: application/json
Request Type
FORM-DATA/ RAW-DATA
Request Fields
client_reference_id
Client reference ID
Validation: Must be alphanumeric up to 160 characters long
unique_account_number
Unique account number
Validation: Must be numeric or alphanumeric depending on system requirement
amount
Transaction amount
Validation: Must be a valid number
email_id(optional)
Customer email ID
Validation: Must be a valid email format
additional_info(optional)
Any additional key-value metadata
Validation: JSON object with key-value pairs
encryption(optional)
Encrypted payload (if applicable)
Validation: Depends on encryption scheme used
mobile_number
Mobile number must be 10 digit long
Request Body
{
"client_reference_id": "XXXXXXX",
"unique_account_number": "XXXXXXX",
"amount": "1",
"email_id": "",
"additional_info": {
"key_1": "value_1"
},
"encryption": ""
}Response Fields
client_reference_id
Client reference ID
Validation: Must be alphanumeric up to 160 characters long
unique_account_number
Unique account number
Validation: Must be numeric or alphanumeric depending on system requirement
amount
Transaction amount
Validation: Must be a valid number
email_id(optional)
Customer email ID
Validation: Must be a valid email format
additional_info(optional)
Any additional key-value metadata
Validation: JSON object with key-value pairs
encryption(optional)
Encrypted payload (if applicable)
Validation: Depends on encryption scheme used
mobile_number
Mobile number must be 10 digit long
{
"status": "success",
"message": "This has been posted"
}POST createPaymentRequest
This operation will initiate a payment request for a given customer.
Endpoint
Headers
Authorization: Bearer token Content-Type: application/json
Request Type
RAW-DATA
Request Fields
merchant_id
Unique merchant identifier
Validation: Must be alphanumeric
order_id
Unique order identifier
Validation: Must be alphanumeric up to 50 characters
amount
Total payment amount
Validation: Must be a positive decimal value
currency
ISO currency code
Validation: Must be 3 characters long
customer_name(optional)
Full name of the customer
Validation: Must be alphabetic
callback_url
URL to which payment status will be sent
Validation: Must be a valid URL
Request Body
{
"merchant_id": "M12345",
"order_id": "ORD67890",
"amount": "1500.50",
"currency": "INR",
"customer_name": "John Doe",
"callback_url": "https://merchant.com/callback"
}Response Fields
transaction_id
Generated transaction ID
Validation: Must be alphanumeric
status
Current transaction status
Validation: One of success/failed/pending
redirect_url
Payment page URL
Validation: Must be a valid URL
{
"status": "success",
"message": "Payment request created successfully"
}PUT updatePaymentStatus
This operation will update the status of an existing payment request.
Endpoint
Headers
Authorization: Bearer token Content-Type: application/json
Request Type
RAW-DATA
Request Fields
transaction_id
Unique transaction identifier
Validation: Must be alphanumeric
status
Updated transaction status
Validation: Must be one of success/failed/cancelled
remarks(optional)
Optional remarks for update
Validation: String up to 250 characters
update_by
Identifier of the user/system updating status
Validation: Must be alphanumeric
Request Body
{
"transaction_id": "TXN789456",
"status": "success",
"remarks": "Payment received successfully",
"update_by": "adminUser123"
}Response Fields
transaction_id
Transaction ID
Validation: Must be alphanumeric
status
Updated status
Validation: One of success/failed/cancelled
updated_at
Timestamp of update
Validation: Must be in ISO 8601 format
{
"status": "success",
"message": "Payment status updated successfully"
}