Body
Order Fulfillment Sync API
The FulfilmentSync API enables merchants to efficiently inform Juspay whether an order was successfully fulfilled after a payment request is confirmed. It reduces manual intervention and streamlines the fulfilment process by allowing automatic triggers for actions such as refunds or invoice generation, or simply notifying Juspay when no further action is required. Additionally, it supports proactive monitoring of fulfilment performance. In cases where a payment remains unpaid, the receiving party can initiate a protest, which may impact the payer’s credit score.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/orders/{order_id}/fulfillment
Production Link
POST
https://api.juspay.in/orders/{order_id}/fulfillment
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.
Content-Type
String
application/x-www-form-urlencoded
Path Params
order_id
*
String
Mandatory
Order ID for which you want to notify order fulfilment to Juspay.
Request Schema: application/json
Basic Parameters
fulfillment_status
*
String
Required
Possible values: SUCCESS or FAILURE
In case of raising protest against an unpaid payment, the value should be FAILURE.
The value of this field should always be “FAILURE” for Boleto Protest.
fulfillment_command
*
Double
Required
The value of this field should always be “PROTEST” for Boleto Protest.
Fulfilment commands are consisting of the following enums:
PROTEST: When payment is not made by a user, the receiving end can protest and affect the credit score of the paying end.INITIATE_CREDIT: Delivery update for Credit Systems and Consumer Finance Partners (Contact your Juspay POC for more details on the usage of this field)INITIATE_REFUND: Initiating refunds (Contact your Juspay POC for more details on the usage of this field)BLOCK_IMEI: Block IMEI (Used to send fulfilled device IMEI to Pinelabs)UNBLOCK_IMEI: Unblock IMEI (Used to send fulfilled device IMEI to Pinelabs)POST_TXN_SPLIT_SETTLEMENT: Settle amounts between different vendors after a successful transaction (Contact your Juspay POC for more details on the usage of this field)NO_ACTION: Store the fulfillment data and pass to the relevant PA/PG if requiredINVOICE: Share invoice to LSP (Contact your Juspay POC for more details on the usage of this field)
fulfillment_time
String
Optional
This is the time at which the order was fulfilled.
This field is not required for Boleto Protest.
fulfillment_id
String
Optional
A unique/repeat merchant-generated identifier (e.g., deliveryId, orderId, PNR) when an order is fulfilled, providing a clear reference to the fulfilment event.
This field is not required for Boleto Protest.
fulfillment_data
String
Optional
Fulfillment related information such as product/service information or any other details which may be used for debugging or recon activities.
This field is not required for Boleto Protest.
200 : Success
Response Body
order_id
String
status
String
Example : PENDING_VBV
merchant_id
String
commands
String
status
String
metadata
String
date_created
String
command
String
400 : Invalid Input data
Response Body
status
String
error
error_message
*
String
Mandatory
invalid_card_number
error_code
*
String
Mandatory
invalid_request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt