Skip to main content
Use this endpoint to retrieve details of a settlement with its id.

Request

Curl

Response

Success

Parameters

id mandatory : string The unique identifier of the settlement to be retrieved.

Parameters

id : string The unique identifier of the settlement transaction. For example, setl_7IZKKI4Pnt2kEe entity : string Indicates the type of entity. Here, it is settlement. amount : integer The amount to be settled (in the smallest unit of currency). For example, 500 will be 50000. status : string Indicates the settlement states. Possible values:
  • created
  • processed
  • failed
fees : integer This is the total fee charged for processing all payments received from customers settled to you in this settlement transaction. In case of a normal settlement, the fee charge will be 0. tax : integer The total tax, in currency subunits, charged on the fees collected to process all payments received from customers settled to you in this settlement transaction. In case of a normal settlement, the tax charge will be 0. utr : string The Unique Transaction Reference (UTR) number available across banks, which can be used to track a particular settlement in your bank account. For example, 1597813219e1pq6w. created_at : integer Unix timestamp at which the settlement transaction was created.

Errors

The API {key/secret} provided is invalid.
  • code: 4xx
  • description: The API credentials passed in the API call differ from the ones generated on the Dashboard.
  • solution: The API keys must be active and entered correctly with no whitespace before or after.
The id provided does not exist.
  • code: 400
  • description: The settlement id does not belong to the requestor or does not exist.
  • solution: Use a valid settlement id that belongs to the requestor.