Validate withdrawal receiver

post

https://api.getorbital.io/crypto/withdrawal/receiver/validation

Checks the Receiver with the counterparty VASP before the merchant creates the payout. Send the wallet address, network, asset, targetVaspCode, a new withdrawalValidationId, and the PPDL beneficiary details.

Unknown wallet and Unhosted wallet are deposit-only. When GTR answers, a withdrawal can return address not found, unsupported network, PII verification failed, PII partial match, target VASP not found, beneficiary rejected, tx id not found, or cancelled by counterparty.

Body Params

Receiver details for an Individual Receiver on a PPDL (Gibraltar) account.

withdrawalValidationId

string

required

Required. New id for this check. Each request requires a new withdrawalValidationId; reusing a stored one returns 400. On sandbox, this id also carries the result marker (tr-match, tr-mismatch, tr-unknown, tr-unhosted).

address

string

required

Required. The Receiver's crypto wallet address.

mainCurrency

string

required

Required. The blockchain network of the receiver address.

For example, if USDT is specified in targetCurrency and ETH here, it signifies USDT on Ethereum.

Allowed networks for USDT: TRX, ETH, MATIC, TON, BNB.

Allowed networks for USDC: SOL, ETH, MATIC, TRX, BNB.

targetCurrency

string

required

Required. The cryptocurrency that would be paid to the Receiver. This call does not move funds.

Accepted: USDT, USDC, ETH, BTC, LTC, BCH.

targetVaspCode

string

required

Required. Counterparty VASP code from GET /crypto/withdrawal/vasps.

firstName

string

required

length ≤ 100

Required. Receiver's first name from the KYC record.

lastName

string

required

length ≤ 100

Required. Receiver's last name from the KYC record.

Note: For customers in countries where last names are not available, pass LNU (Last Name Unavailable) in this field.

dateOfBirth

date

required

Required. Receiver's date of birth (YYYY-MM-DD). Optional only when the date-of-birth feature flag is on. Must be a valid date and the person must be 18 or older.

personType

string

enum

Defaults to naturalPerson

Optional. Indicates the type of Receiver. Defaults to naturalPerson.

Allowed:

Responses

200The check was answered. data.validationResult is the match. This is not the payout.

400Validation error. withdrawalValidationId is required or withdrawalValidationId is already taken returns data: null and the message on message. Address, currency, and Travel Rule person failures return data.type validation_error.

401Unauthorized. The x-api-key header is missing or invalid.

403Withdrawal receiver validation is not enabled for this account. Turn on PMCR-4388.

500The check was not stored. Retry the same withdrawalValidationId.