Get withdrawal history

GET

/v2/send/withdrawals/{withdrawalId}/history

• Staging
• Development

Retrieve the complete history of status changes for a withdrawal

Authorizations

• X-API-Key
• X-API-Secret

Parameters

Path Parameters

withdrawalId

required

string format: uuid

Withdrawal ID

Example

82c4fce1-d2c7-48cb-a647-6993dbe37819

Responses

200

List of withdrawal history entries ordered by creation date (newest first)

object

history

required

List of withdrawal history entries

Array<object>

object

id

required

History entry ID

string format: uuid

oldStatus

Previous status

string

Allowed values: created networkinprogress networkcompleted networkfailed payoutinprogress payoutcompleted payoutfailed banktransferinprogress banktransfercompleted banktransferfailed completed failed

newStatus

required

New status

string

Allowed values: created networkinprogress networkcompleted networkfailed payoutinprogress payoutcompleted payoutfailed banktransferinprogress banktransfercompleted banktransferfailed completed failed

userId

required

User ID from withdrawal

string format: uuid

organisationId

required

Organization ID from withdrawal

string format: uuid

metadata

Additional metadata (networkDetails, payoutDetails, etc.)

object

createdAt

required

Timestamp when the status change occurred

string format: date-time

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error