Retrieve Withdrawal

Retrieve a single withdrawal record by its public transaction_id.

Endpoint

GET /withdrawals/{transaction_id}

Access	Requirement
Authenticated	Yes
Required Scope	`wapi-withdrawals-retrieve`, or `wapi-withdrawals-all`
Rate Limit	15 requests per minute

Request

Headers

Header	Value
`Accept`	`application/json`
`Authorization`	`Bearer <access_token>`
`X-WAPI-Key`	`wapi_live_<kid>_<secret>` or `wapi_test_<kid>_<secret>`

Send exactly one of Authorization or X-WAPI-Key.

Path Parameters

Parameter	Type	Required	Description
`transaction_id`	string	Yes	Public transaction ID associated with the withdrawal

Responses

200 OK

{
  "message": "OK",
  "data": {
    "amount": "100.00",
    "bank_account_type": null,
    "bank_account": "1234567890",
    "bank_branch": null,
    "bank_name": "First Citizens",
    "created_at": "2025-03-06T13:00:00Z",
    "currency": "USD",
    "deleted_at": null,
    "email": "recipient@example.com",
    "fee_amount": "5.00",
    "id_number": "TB963809",
    "id_type": "passport",
    "name_in_bank": "TEST RECIPIENT",
    "phone": "+18687778899",
    "reference": null,
    "status_description": "Not On ACH File",
    "status": 0,
    "transaction_id": "SB-47-1-W12345-20250306010101",
    "updated_at": "2025-03-06T13:00:00Z",
    "withdrawal_type": "sub_banked"
  }
}

If no withdrawal matches the supplied transaction_id, the endpoint returns data: [].

401 Unauthorized

{
  "message": "Unauthorized"
}

403 Forbidden

{
  "message": "Invalid scope(s) provided."
}

Example

curl -X GET "https://ttsb.wipayfinancial.com/wapi/withdrawals/SB-47-1-W12345-20250306010101" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access_token>"

On this page