Fiat

Create Fiat Withdrawal

Creates a new withdrawal request to the specified beneficiary.

post/v2/fiat/withdrawals

Request

  • Base URL: https://api.luno.com
  • URL: https://api.luno.com/v2/fiat/withdrawals
  • Auth: none declared

Headers

X-LAPI-KEYstring

API authentication key.

X-LAPI-SIGNATUREstring

Generated signature using request properties. Signed by API secret.

X-LAPI-TIMESTAMPinteger

Current timestamp in unix milliseconds.

Request body

amountstring decimal required
beneficiaryIdstring

The beneficiary ID of the bank account the withdrawal will be paid out to. This parameter is required if the user has set up multiple beneficiaries. The beneficiary ID can be found by using the /fiat/beneficiaries endpoint.

externalIdstring

Optional unique ID to associate with this withdrawal. Useful to prevent duplicate sends. This field supports all alphanumeric characters including "-" and "_".

fastboolean

If true, it will be a fast withdrawal if possible. Fast withdrawals come with a fee. Currently fast withdrawals are only available for type=ZAR_EFT; for other types, an error is returned. Fast withdrawals are not possible for Bank of Baroda, Deutsche Bank, Merrill Lynch South Africa, UBS, Postbank and Tyme Bank. The fee to be charged is the same as when withdrawing from the UI.

typestring required

Withdrawal method

Example request

{
  "beneficiaryId": "012345678901234",
  "externalId": "123e4567-e89b-12d3-a456-426655440000",
  "type": "ZAR_EFT"
}

Response

Withdrawal information

amountstring decimal required
createdTimestampinteger required
currencystring required

Currency of the withdrawal request

externalIdstring

Value that was passed with the withdrawal request to the 3rd party

feestring decimal required
idstring required

Identifier of the withdrawal request

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'CANCELLED' | 'WAITING' | 'CANCELLING' | 'UNKNOWN' required
transferIdstring

Transfer ID is the identifier of the Withdrawal's transfer once it completes.

typestring required

Type distinguishes between different withdrawal methods where more than one is supported for the given currency.

Changes

No recorded changes to this operation across all 1 revision of this API.