Body
PIX
PIX is a real-time payment system created by Brazil’s Central Bank. Merchants can integrate PIX with Juspay by displaying QR codes for customers to scan and complete payments instantly. By default, PIX payments are valid for 30 minutes, although this may vary depending on the payment gateway, with the shortest duration being used.
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
version
string
Pass the date in YYYY-MM-DD format
Example:-
2023-01-01
Content-Type
String
application/x-www-form-urlencoded
Request Schema: application/json
Basic Parameters
order_id
*
string
required
Unique Identifier for the order. Should be Alphanumeric with character length less than 21.
Example:-
order-id-9876580
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.
Example:-
1.00
options.get_client_auth_token
string
Client side authenticaion token required for Hyper SDK calls
Example:- Value : true
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
customer_email
string
Email address of the customer. If the backend gateway requires it, then you must send this value.
Example:-
test@gmail.com
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:-
99999999
currency
string
ISO string of the currency. Use BRL for Brazilian Real. Among other accepted values are EUR, USD, GBP, SGD, IDR etc. Default value: INR
description
string
Short description for the order. We send this information to the backend gateways whenever there is a provision for this.
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
product_id
string
An identifier for the product. Fits well for impulse purchase usecases.
Example:-
John
gateway_id
string
Specify your preferred gateway for this order.
Example:-
Wick
merchant_id
*
String
Mandatory
payment_method_type
*
String
Mandatory
This will be RTP for PIX payments
redirect_after_payment
*
String
Mandatory
payment_method
*
String
Mandatory
The value for this field will be PIX_QR for PIX payments
format
*
String
Mandatory
identity_credentials
*
Object
Mandatory
This field should be used to pass cpf or cnpj values in the json format.
cpf
String
Conditional
Brazilian identity number without punctuation
cnpj
String
Conditional
Brazilian identity number for companies without punctuation
pix_key
String
Conditional
Nickname that identifies a user's transactional account in Brazil
sdk_params
*
Bool
Mandatory
This value should be passed if you are not doing SDK integration.
200 : Success
Response Body
order_id
*
String
Required
payment
*
Object
Required
authentication
*
Object
Required
method
*
String
Required
url
*
String
Required
sdk_params
*
Object
Required
contents
*
Object
Required
name
*
String
Required
qrString
*
String
Required
tag
*
String
Required
status
*
String
Required
Required
txn_id
*
String
Required
Required
txn_uuid
String
400 : Invalid Input data
Response Body
status
string
Bad Request
error_code
string
Details of keys missing
Example:-
Mandatory fields are missing
error_message
string
Further Details of keys missing