API reference / Withdrawals
Retrieve a withdrawal
GET
/v1/withdrawals/{reference_id} The amount leaves your balance when the withdrawal is requested. If it fails, a WITHDRAWAL_RETURNED ledger entry puts it back.
When it arrives
- InstaPay: right away.
- PESONet: credited in batches on banking days. Sent from 4:00 PM the day before to 10:00 AM: credited from 10:40 AM. Sent from 10:00 AM to 1:00 PM: from 1:40 PM. Sent from 1:00 PM to 4:00 PM: from 4:40 PM.
- Sent on a Friday after 4:00 PM, or on a Saturday or Sunday: credited the next Monday, from 10:40 AM. Check at the end of that day before contacting support.
Path parameters
reference_idstringRequiredPattern: ^WD[0-9A-Z]{12}$
Headers
AuthorizationstringRequiredBearerplus your API key. See Authentication.
Responses
200 OK
The withdrawal.
What data holds
withdrawalobject15 fields in
withdrawalreference_idstringcurrencystringISO 4217. PHP today; more as they're enabled for your account.One of:PHPamountnumberfeenumber | nulltotalnumber | nullamountplusfee.statusstringPENDING,FOR_SETTLEMENT,COMPLETEDorFAILED.One of:PENDINGFOR_SETTLEMENTCOMPLETEDFAILEDrailstring | nullINSTAPAY (real time) for 50,000.00 or less; PESONET (batch, not real time) above that, or when the bank isn't on InstaPay. Null for withdrawals made before rails were recorded.One of:INSTAPAYPESONETprovider_reference_idstring | nullThe bank partner's transfer reference. Null until known.channel_reference_idstring | nullThe InstaPay or PESONet reference. Null until known.destinationobjectbank_name,account_name,account_number_last4. Never the full account number.3 fields in
destinationbank_namestringaccount_namestringaccount_number_last4string
failureobject | nullcodeandmessagewhen the withdrawal failed.codecan be null.2 fields in
failurecodestring | nullmessagestring
requested_atstring (date-time)completed_atstring (date-time) | nullfailed_atstring (date-time) | nullupdated_atstring (date-time)
401 Unauthorized
Missing, malformed or unknown API key (code 4010000).
403 Forbidden
The key can't make this request (code 4030000): an address outside the key's IP allowlist, a live key before your live mode is on, or an account that isn't active. A live key sent from a browser is refused (code 4030001): keep live keys on your server.
404 Not Found
Not found in this mode for your account (code 4040000).