[lightMode]

List Instant Settlements

GET/settlements/instant

[updatedIn] 2 months ago

This endpoint lists all the instant settlements including details such as amount and status that are associated with the store.

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

`settlements.read` - Settlements Read Only

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.queryParameter]

reference_id

integer

optional

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

page

integer

optional

Filter by page number

Request samples

[api.label.responses]

Success(200)

Forbidden(403)

HTTP Code: 200

Content Type : JSONapplication/json

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

array[object (Settlement) {4}]

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

pagination

object (Pagination)

required

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 40643814,
      "reference_id": 1444968,
      "amount": 56.21,
      "status": "settled"
    },
    {
      "id": 814209365,
      "reference_id": 913456,
      "amount": 50,
      "status": "ready"
    },
    {
      "id": 172398348,
      "reference_id": 324144,
      "amount": 100,
      "status": "pending"
    },
    {
      "id": 3499435415,
      "reference_id": 694175,
      "amount": 37.41,
      "status": "pending"
    },
    {
      "id": 989289633,
      "reference_id": 360174,
      "amount": 469.7,
      "status": "pending"
    },
    {
      "id": 1749842897,
      "reference_id": 460169,
      "amount": 85.36,
      "status": "ready"
    },
    {
      "id": 52596436,
      "reference_id": 4016556,
      "amount": 1000,
      "status": "pending"
    },
    {
      "id": 1298194523,
      "reference_id": 4034135,
      "amount": 11.2,
      "status": "pending"
    },
    {
      "id": 1939592358,
      "reference_id": 3879624,
      "amount": 118,
      "status": "pending"
    },
    {
      "id": 566146469,
      "reference_id": 3879628,
      "amount": 200,
      "status": "pending"
    }
  ],
  "pagination": {
    "count": 10,
    "total": 10,
    "perPage": 15,
    "currentPage": 1,
    "totalPages": 1,
    "links": {
      "previous": "http://api.salla.dev/admin/v2/setllements/instant?page=3",
      "next": "http://api.salla.dev/admin/v2/setllements/instant?page=2"
    }
  }
}

[updatedIn] 2 months ago