OmniPayDocs
API referenceWithdrawals

Get a withdrawal

GET
/v1/withdraws/{id}

Returns the current state of a withdrawal owned by the API key's organization.

Authorization

bearerAuth
AuthorizationBearer <token>

API key created in the OmniPay developer dashboard.

In: header

Path Parameters

id*string

OmniPay withdrawal ID.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/withdraws/string"
{  "id": "string",  "phone": "string",  "payment_method": "bkash",  "amount": "string",  "status": "processing",  "metadata": {},  "merchant_id": "string"}