Skip to content
Withdrawals

Check Payee Address of Bank Card

Checks whether withdrawing the given currency to the given bank card requires a payee address, and returns the address fields to fill, the card’s current address, and a prefill address for one-tap filling. This endpoint only reads data.

When to call: when need_payee_address in the pre-check is true, before changing the receiving card of a withdrawal, before confirming a suggested receiving card, and after a withdrawal submission or card change returns business code 2031199. When address_needed is true, render the address form from want_fields and save it with POST /v1/portfolio/withdraw/card/address. When address_valid is false, the address must be completed or corrected before the withdrawal can continue.

POSThttps://api.lbkrs.com/v1/portfolio/withdraw/card/addresscheck

Request body application/json

card_idintegerrequired

Bank card id

currencystringrequired

Currency of this withdrawal, for example USD

Responses

HTTP 200The request succeeded. The response body contains the result of the “Check Payee Address of Bank Card” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
address_neededboolean

Whether this withdrawal to the card requires a payee address; when true, show the address form

address_validboolean

Whether the current address is valid: true means it meets the requirements and the Client only needs to confirm; false means it is missing or no longer meets the rules and must be completed or corrected before withdrawing

want_fieldsarray<string>

Address fields required for the card; the Broker App renders the form in the returned order

now_addressobject

Payee address of a bank card

Child attributes
payee_countrystring

Payee country or region as an ISO 3166-1 alpha-3 code (for example, HKG), taken from code2 of “Get Payee Countries and Regions”

payee_statestring

State, province, or administrative region

payee_citystring

City

payee_streetstring

Street

payee_buildingstring

Building name; required only for some countries or regions

addressstring

Detailed address

payee_postcodestring

Postal code

prefill_addressobject

Payee address of a bank card

Child attributes
payee_countrystring

Payee country or region as an ISO 3166-1 alpha-3 code (for example, HKG), taken from code2 of “Get Payee Countries and Regions”

payee_statestring

State, province, or administrative region

payee_citystring

City

payee_streetstring

Street

payee_buildingstring

Building name; required only for some countries or regions

addressstring

Detailed address

payee_postcodestring

Postal code

Whale Docs