Quote a withdrawal
Returns what a withdrawal would cost, priced by the same code that charges it, without creating anything. Type exactly one of sourceAmount (what you send) or destinationAmount (what the recipient receives); the other is derived from it. The side you type is returned as anchor.
rate, fee and the amounts mean exactly what they mean on the transaction a create returns, so a create with the same inputs charges the quoted amounts. A quote does not check limits or customer verification and does not need an idempotency key or reference; those apply when you create the transaction, so a quote can succeed where the create is refused. Quotes are not reserved: rates and promotions can change before you create.
Name the destination either with destinationId (a saved payment method) or with destinationChannel and destinationCountry (when the customer has no account to send to yet), not both. destinationCountry can be left out for SWIFT and CRYPTO. A quote priced from a channel alone comes back with indicative: true: the account is not known, so the payout route, and any fee that depends on it, may differ when you create. customerId is optional; without it the quote is priced for the business owner, so a fee or promotion that depends on the customer's country can differ when you create.
Request
- Base URLhttps://sandbox.api.afriex.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The customer the withdrawal is for. Omit it to price the quote for the business owner.
The destination payment method the funds would be sent to. Send this or destinationChannel, not both.
The channel the funds would be sent over, when there is no saved payment method yet. Send this or destinationId, not both. Case-insensitive.
The destination country (ISO 3166-1 alpha-2, case-insensitive), required with destinationChannel except for SWIFT and CRYPTO. It can only be sent together with destinationChannel.
The currency debited from your wallet.
The currency the recipient receives.
The amount you send. Send this or destinationAmount, not both.
The amount the recipient receives. Send this or sourceAmount, not both.
Response
The quote.
Changes
No recorded changes to this operation across all 1 revision of this API.