Withdrawal Meta

Retrieve the platform-specific reference data accepted by the WAPI withdrawal endpoints.

Use this endpoint as the source of truth for values that are submittable to the other WAPI withdrawal routes. In practice, it acts as a reference list for acceptable values such as Banks, ID types, withdrawal statuses, and withdrawal_type modes.

This endpoint is unusual within WAPI because it does not require bearer authentication.

Endpoint

GET /withdrawals/meta

Access	Requirement
Authenticated	No
Required Scope	None
Rate Limit	60 requests per minute

Request

Headers

Header	Value
`Accept`	`application/json`

Responses

200 OK

{
  "message": "OK",
  "data": {
    "banks": [
      {
        "account": {
          "length": {
            "max": 10,
            "min": 10
          }
        },
        "display_name": "First Citizens",
        "logo_url": "https://example.com/images/bank_logos/first-citizens.svg",
        "name": "First Citizens"
      }
    ],
    "ids": [
      {
        "type": "passport",
        "regex": "^[A-Z]{2}[0-9]{6}$"
      }
    ],
    "statuses": [
      {
        "value": 0,
        "description": "Not On ACH File"
      }
    ],
    "withdrawal_types": [
      "normal",
      "sub_banked",
      "sub_unbanked"
    ]
  }
}

Metadata Fields

Field	Type	Description
`data.banks`	array	Platform bank definitions accepted in withdrawal requests
`data.banks[].name`	string	Canonical bank name expected by `bank_name`
`data.banks[].display_name`	string	Display label for UI use
`data.banks[].logo_url`	string \| null	Absolute URL for the bank logo
`data.banks[].account.length.min`	integer	Minimum permitted account-number length for that bank
`data.banks[].account.length.max`	integer \| null	Maximum permitted account-number length for that bank
`data.banks[].account.type`	array \| null	Allowed bank account types. Present on Jamaica platforms
`data.banks[].branches`	array \| null	Allowed branch strings for Jamaica banks
`data.ids`	array	Allowed ID types and their validation regex patterns
`data.statuses`	array	Withdrawal status codes and descriptions for filtering and display
`data.withdrawal_types`	array	Allowed API mode values for `withdrawal_type`

The sub_banked and sub_unbanked values in data.withdrawal_types are API mode names used when an authenticated MMA submits a withdrawal on behalf of an external recipient.

Example

curl -X GET https://ttsb.wipayfinancial.com/wapi/withdrawals/meta \
  -H "Accept: application/json"