Create a top-up
Sells credit: CHARGE bills a saved payment method now, SEND_INVOICE grants it once paid. The
credit is PAID and applies to ALL charges. Currency credit is sold one for one, untaxed, as
its usage is taxed when invoiced. With credit_unit, sells credits of that unit at its
selling price in the customer’s currency, taxed at purchase under the unit’s product; refused
when the unit has no price in that currency or no product. Without a saved payment method,
CHARGE returns a hosted checkout_url where the customer pays.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Required; reuse it only to retry the same request
Path Parameters
Customer ID or alias
Body
Credit sold to the customer, charged or invoiced.
Credit to buy, positive, applying to ALL charges. In minor units of currency, charged
one for one without tax: the usage it pays is taxed on the invoice that bills it. With
credit_unit, in minor units of that unit (e.g. 500000 is 5,000.00 credits of a unit with
precision 2), charged at the unit's price per credit in the customer's currency, plus tax
under the unit's product.
CHARGE (default) charges a saved payment method now; SEND_INVOICE issues an invoice and grants the credit once it is paid.
CHARGE, SEND_INVOICE Buy credits of this credit unit (its code) instead of money; excludes currency. They are
charged in the customer's currency at the customer's agreed price for the unit (the
wallet's unit_price), else its list price, plus tax, under the unit's product.
Defaults to the customer's currency. SEND_INVOICE sells only in the customer's currency.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNH, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL "EUR"
Absolute expiry of the purchased credit; unset never expires.
CHARGE only; defaults to the customer's default payment method.
With credit_unit: the negotiated price of one credit for this purchase, in major units of
the customer's currency, as a decimal string (e.g. "0.0008"). Defaults to the wallet's
unit_price when set, else the list price; the unit must still have a list price in that
currency.
Response
Top-up paid, settling, or awaiting the customer
Where a top-up stands. Its credit is granted once it is paid; wallet.funded reports it.
Credit bought, in minor units of currency, or of credit_unit when set.
The money the top-up is charged in.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNH, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL "EUR"
SUCCEEDED once paid; otherwise what the payment is waiting for.
SUCCEEDED, PENDING, REQUIRES_CUSTOMER_ACTION, AWAITING_PAYMENT Charged to the payment method, tax included, in minor units of currency; absent until a
charge is made.
Hosted page where the customer completes the payment; present while it awaits them.
Set when credits of this credit unit were bought: amount is in its minor units.
The invoice documenting the purchase.
The charge made on the payment method; absent until a charge is made.