Salla Docs
Merchant API
Partner APIs
Storefront
Salla CLI
Salla Docs

    [lightMode]

    Update Instant Settlement

    PUT/settlements/instant/{id}
    [updatedIn] 2 months ago

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

    :::warning[]
    This endpoint is allowed only for dropshipping applications.
    :::

    `settlements.read_write` - Settlements Read & Write

    Request

    Authorization: OAuth 2.0
    Add the parameter
    Authorization
    to [header]    ，whose value is to concatenate the Token after the Bearer.
    [api.label.example]
    Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
    [message.pathParameter]
    id
    integer 
    required

    Settlment ID. Get a list of Settlment IDs from here

    [message.bodyParameter]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
    [api.label.example]
    {
  "amount": 9823743,
  "status": "ready"
}

    Request samples

    [api.label.responses]

    OK(200)
    Parameter Error(422)
    Record Not Found(404)
    Forbidden(403)
    HTTP Code: 200
    Content Type : JSONapplication/json
    [response.label.jsonSchema]
    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
    id
    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
    [api.label.example]
    {
  "status": 200,
  "success": true,
  "data": {
    "id": 33787469,
    "reference_id": 685748,
    "amount": 200,
    "status": "ready"
  }
}
    [updatedIn] 2 months ago