Body
Boleto
Boleto is a popular Brazilian payment method where customers receive a bank slip that can be paid online or in person. With Juspay, merchants can generate and manage Boletos easily. Payments take 1-3 business days to settle, and Juspay provides automated notifications upon settlement, ensuring smooth payment tracking.
Request
Response
API Endpoints
Sandbox Link
POST
https://api.sandbox.juspay.io/txns
Production Link
POST
https://api.juspay.io/txns
Authorization Header
Basic Auth
*
Base64 Encoded Username:Password
Required
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
x-merchantid
*
String
Required
Merchant ID provided by Juspay
Example:-
merchant-id
Content-Type
String
application/x-www-form-urlencoded
Request Schema: application/json
Basic Parameters
order.order_id
*
String
Required
Unique Identifier for the order. Should be Alphanumeric with character length less than 21.
Example:-
order-id-9876580
order.amount
*
Double
Required
Amount that the customer has to pay. Will accept stringified double or integer values with upto two decimal places. For example, "100.15" and "100" are valid input but "100.1532" is not valid.
order.customer_id
String
It is the ID with which merchant refers to a customer object. This id is used to access the stored payment methods, allow EMI transactions and setup subscriptions.
In case of guest login it should be an empty string.
Example:-
customer-id-007
order.customer_email
String
Email address of the customer. If the backend gateway requires it, then you must send this value.
Example:-
test@gmail.com
order.customer_phone
String
Mobile number or fixed line number of the customer. If the backend gateway requires it, then you must send this value.
Example:-
9999999912
order.currency
String
ISO string of the currency. Accepted values are BRL, EUR, USD, GBP,HKD. Default value: INR
order.return_url
String
A fully qualified URL which the customer will be redirected after payment completion. It is also required to provide the control back to SDK after the completion of transaction. This URL shouldn't contain any query parameters or Ip address. This URL takes higher precedence over the common return URL configured in your account settings.
Example:-
https://shop.merchant.com
merchant_id
*
String
Required
ID of the merchant_account that you hold with us.
payment_method_type
*
String
Required
Depending on type of payment to be processed. For Boleto, it will be OTC.
payment_method
String
This should be passed as BOLETO.
redirect_after_payment
*
Boolean
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
If 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.
identity_credentials
*
Object
Mandatory
This field should be used to pass cpf or cnpj values in the json format.
cpf
*
String
Mandatory
Brazilian identity number without punctuation
sdk_params
*
Bool
Mandatory
This will be set to true if you are not using the SDK flow.
200 : Success
Response Body
order_id
*
String
Required
payment
*
Object
Required
authentication
*
Object
Required
method
*
String
Required
url
*
String
Required
sdk_params
Object
contents
Object
acquirer_info
*
Object
Required
acquirer_name
*
String
Required
barCodeData
*
String
Required
downloadUrl
String
expiry_time
*
String
Required
payment_instrument
*
String
Required
tag
String
status
*
String
Required
txn_id
*
String
Required
txn_uuid
*
String
Required
400 : Invalid Input data
Response Body
status
String
Example : error
error_message
*
String
Mandatory
Example : invalid_card_number
error_code
*
String
Mandatory
Example : invalid_request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt