Body
COD Payments
Create a payment transaction for Cash on Delivery. Once the COD transaction API is hit, the transaction will routed via CASH gateway and the status will be directly marked COD_INITIATED.
Note
Please configure ‘CASH’ gateway with ‘Cash Payment‘ enabled on Juspay Dashboard under ‘PG Control Center’
.png)
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/txns
Production Link
POST
https://api.juspay.in/txns
Headers
Content-Type
*
String
Mandatory
application/x-www-form-urlencoded
x-routing-id
*
String
Required
We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.
Warning
This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.
Example:- customer_1122
Parameters
order_id
*
string
Mandatory
order_id pertaining to the order for which the payment is started.
merchant_id
*
string
Mandatory
ID of the merchant_account that you hold with us.
payment_method_type
*
string
Mandatory
Must be CASH.
payment_method
*
string
Mandatory
Must be CASH.
redirect_after_payment
*
string
Mandatory
This is a boolean variable and accepts true/false. We recommend that you set this to true and use the redirection flow. If set to true, then the user is redirected to the return_url configured for the order. If set to false, then the user will be stopped at the response page from the gateway. Your client should be able to read the page/title to infer that the user has completed the transaction.
format
*
string
Mandatory
f it is set to json, then the response will be HTTP 200 with a JSON formatted text. Otherwise, the response is HTTP 302 with the Location attribute having the destination URL.
200 : Success
Response Body
order_id
string
:order_id
txn_id
string
:txn_id
status
string
PENDING_VBV
payment
object
authentication.method
String
authentication.url
string
authentication.params
object
Only when you have POST as the authentication method
key1
String
key2
String
key3
String
400 : Invalid Input data
Response Body
status
string
error
error_message
string
Order timed out
error_code
string
invalid_request