Skip to main content

Withdraw Details (full)

POST 
/api/v1/pbl/withdraws/details/full

Returns a withdrawal together with the transactions it settles: the withdrawal header, totals for the whole settlement and one page of positions.

This is a separate endpoint rather than a flag on /api/v1/pbl/withdraws/details, because the checksum is computed from every field of the request body - adding a field to the existing endpoint would invalidate the signature of every working integration. Here page and per_page are part of the signature from day one.

Checksum​

Same rule as the other Payment Services endpoints: concatenate the values of all fields sent in the request body, in the order they appear in the JSON (excluding checksum), join them with |, append your Secret Hash:

sha256({field1}|{field2}|...|{SecretHash})

For the minimal body {service, withdraw_id, checksum} this equals sha256(service|withdraw_id|SecretHash). If you send page or per_page, they must be part of the checksum too, in the same order - otherwise the request is rejected with HTTP 401 Unauthorized request.

Amounts​

Every monetary value in this response - in the header, in summary and in each position - is a decimal string with two decimal places (for example "27.15"). The currency is in settlement.currency_code.

Positions​

For a regular settlement, positions are the individual payments that were paid out. A withdrawal that covers exactly one payment (single payout instruction, refund form payout, direct settlement created through the User API) returns one position carrying the header amounts, so the contract is the same for every type of withdrawal. A withdrawal whose positions are not known returns an empty transactions array with summary.count = 0.

Pagination​

Page-based. summary always describes the whole settlement, never the current page. A page beyond the last one returns an empty transactions array (not the last page), so you can iterate until the array is empty or until meta.page reaches meta.total_pages.

Request​

Responses​

Withdrawal with its settled transactions.

Last updated on