Update Instant Settlement - Salla Public APIs Docs

This endpoint allows you to update the status and the amount of a specific settlment by by passing the id as a path parameter.

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 ********************

Path Params

integer

required

Settlment ID. Get a list of Settlment IDs from here

Body Params application/json

amount

number

optional

The amount to hold. It should be <= the order total, and up to two decimal points

status

enum<string>

optional

The settlement status

Allowed values:

pendingready

Examples:

pendingready

Example

{
    "amount": 9823743,
    "status": "ready"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

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": 200,
    "success": true,
    "data": {
        "id": 33787469,
        "reference_id": 685748,
        "amount": 200,
        "status": "ready"
    }
}

🟠422Parameter Error

🟠404Record Not Found

🟠403Forbidden

🟠401Unauthorized