[lightMode]

Instant Settlement Details

GET/settlements/instant/{id}

[updatedIn] 2 months ago

This endpoint allows you to fetch the details for a specific settlement by passing the id as a path parameter.

:::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.pathParameter]

string

required

Unique Identifier for the settlement ID. Get a list of Settlement IDs from here

Example:

897542106

Request samples

[api.label.responses]

Success(200)

Record Not Found(404)

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

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

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

[updatedIn] 2 months ago