Object

The deposit instructions object

How to pay in. The type field says which variant you have: bank details with a reference, a mobile-money merchant code, or a PayPal approval link.

Fields

typestringrequired
currencystringrequiredbank: Lower-case ISO 4217 fiat currency code.
railstringrequiredbank: A payment rail code, published by GET /routes. Not an enum by design.
bank_namestringrequiredbank
bank_addressstringbank
account_namestringrequiredbank
account_numberstringrequiredbank
routing_codestringbank: Branch, sort or routing code where the rail uses one.
swift_bicstringbank
referencestringrequiredbank: Reference the sender must quote so the deposit is matched.
amountstringbank: One-off on-ramps only. The amount to send.
expires_attimestampbank: One-off on-ramps only. After this the transfer is canceled and late funds are returned.
currencystringrequiredmobile_money: Lower-case ISO 4217 fiat currency code.
railstringrequiredmobile_money: A payment rail code, published by GET /routes. Not an enum by design.
providerstringrequiredmobile_money
merchant_codestringmobile_money: Merchant, till or paybill number to pay.
phone_numberstringmobile_money: Number to pay, where the provider uses one instead of a merchant code.
referencestringrequiredmobile_money
amountstringmobile_money: Non-negative decimal string. Precision is limited per asset or currency (see Route).
expires_attimestampmobile_money
currencystringrequiredpaypal: Lower-case ISO 4217 fiat currency code.
railstringrequiredpaypal: A payment rail code, published by GET /routes. Not an enum by design.
approval_urlstringrequiredpaypal: PayPal's hosted approval page for this payment. Send the payer here.
referencestringrequiredpaypal
amountstringrequiredpaypal: Non-negative decimal string. Precision is limited per asset or currency (see Route).
expires_attimestamprequiredpaypal: After this the approval link stops working and the transfer is canceled.

Example

{
  "type": "bank",
  "currency": "zar",
  "rail": "absa_eft",
  "bank_name": "Absa Bank",
  "bank_address": "15 Troye Street, Johannesburg",
  "account_name": "Ndeipi Payments (Pty) Ltd",
  "account_number": "4091234567",
  "routing_code": "632005",
  "swift_bic": "ABSAZAJJ",
  "reference": "ND7K3Q9P"
}