POST
/api/v2/banking/payouts/checkPayout Step 2: check the quoted payout before OTP approval.
Send the quote Id from POST /api/v2/banking/quotations as QuotationId. The returned CheckId is used in POST /api/v2/banking/payouts/initiate.
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userId (query) | unknown | No |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| PayeeId | unknown | Yes | Local payee ID from the payee list endpoint. Local payee ID from GET /api/v2/banking/payees. |
| QuotationId | string | Yes | Quotation Id returned by POST /api/v2/banking/quotations. Quotation Id returned by POST /api/v2/banking/quotations. |
| Amount | string | Yes | Payout amount as a decimal string. |
| Currency | string | Yes | Payout currency, usually the payee currency. |
| BalanceId | string | No | Optional provider balance or budget ID to fund the payout from. Optional provider balance or Equals Money budget ID used as funding source. |
| Memo | string | No | Optional memo/reference for the payout. |
| Reason | string | No | Optional payout reason. |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| CheckId | string | No | Provider check ID. Pass this as CheckId to POST /api/v2/banking/payouts/initiate. |
| Pass | boolean | No | |
| DetailMessage | string | No |
400 — Bad Request
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
401 — Unauthorized
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
404 — Not Found
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
500 — Internal Server Error
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
Example request
curl -X POST "https://{base_url}/api/v2/banking/payouts/check" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"PayeeId":"…","QuotationId":"…","Amount":"…","Currency":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.