Create Instant Settlement
POST
/settlements/instantThis endpoint allows you to temporarily withhold a specific amount of money for settlement from the Merchant's wallet.
:::warning[]
This endpoint is allowed only for dropshipping applications.
:::
Request
Order's reference ID. Get a list of Order Reference IDs from here
The amount to hold. It should be less than or equal to the order total, and up to two decimal points
{
"reference_id": 9363145,
"amount": 120.21
}
Request samples
[api.label.responses]
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
Settlement unique ID
Order's reference ID. Get a list of Order Reference IDs from here
The amount held from the Merchant's wallet
The settlement status
{
"status": 201,
"success": true,
"data": {
"id": 587246469,
"reference_id": 385748,
"amount": 200,
"status": "pending"
}
}