Create Instant Settlement

This endpoint allows you to temporarily withhold a specific amount of money for settlement from the Merchant's wallet.

This endpoint is allowed only for dropshipping applications.

Scopes

settlements.read_write - Settlements Read & Write

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Body Params application/json

reference_id

integer

required

Order's reference ID. Get a list of Order Reference IDs from here

Example:

566345

amount

number

required

The amount to hold. It should be less than or equal to the order total, and up to two decimal points

Examples:

57.32120

Example

{
  "reference_id": 9363145,
  "amount": 120.21
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Body

status

number

required

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.

success

boolean

required

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.

data

object (Settlement)

required

number

required

Settlement unique ID

reference_id

integer

required

Order's reference ID. Get a list of Order Reference IDs from here

Example:

653443

amount

number <float>

required

The amount held from the Merchant's wallet

Examples:

153.35120

status

enum<string>

required

The settlement status

Allowed values:

pendingreadysettledcanceled

Example:

pending

Example

{
  "status": 201,
  "success": true,
  "data": {
    "id": 587246469,
    "reference_id": 385748,
    "amount": 200,
    "status": "pending"
  }
}

🟠422error_validation

🟠404error_notFound_404

🟠403Forbidden

🟠401Unauthorized