Skip to main content
Een quote wordt eenmalig geprijsd, kan door één betaling worden gebruikt en verloopt. Gebruik de Payment Quotes API om een koper het totaal, de belasting en de valuta te tonen voordat die betaalt, en geef daarna de id van de quote mee als quote_id wanneer je de betaling aanmaakt, zodat precies die quote in rekening wordt gebracht. Vraag opnieuw een quote aan wanneer de winkelwagen, promotiecode of het adres verandert.

Endpoints

Attributen

string
vereist
Payment quote-ID, met prefix pq_.
string
vereist
Het account waarvoor de aankoop wordt geprijsd, met prefix biz_.
object | null
vereist
Het factuuradres waarmee de aankoop is geprijsd, of null. Waar de belasting is berekend wanneer er geen verzendadres is opgegeven, en het adres waartoe de registratie behoort.

Eigenschappen

string | null
vereist
De plaats.
string | null
vereist
De ISO 3166-1 alpha-2-landcode.
string | null
vereist
De eerste adresregel.
string | null
vereist
De tweede adresregel.
string | null
vereist
De naam op het adres.
string | null
vereist
De postcode.
string | null
vereist
De staat, provincie of regio.
string
vereist
ISO 4217-code van drie letters van de eigen valuta van de varianten, in kleine letters. Gelijk aan currency wanneer er niets is omgerekend.
object
vereist
total in base_currency tegen exchange_rate: de eigen prijzen van de varianten na de promotiecode, plus tax_amount omgerekend tegen exchange_rate wanneer belasting erbovenop komt. Gelijk aan total wanneer er niets is omgerekend. De betaling brengt total in rekening, in currency.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string
vereist
Wanneer de quote is geprijsd, als ISO 8601-tijdstempel.
string
vereist
ISO 4217-valutacode van drie letters waarin de aankoop wordt geprijsd en afgerekend, in kleine letters: de eigen valuta van de varianten, of de presentment_currency waarnaar is omgerekend.
object
vereist
Wat de promotiecode eraf haalt. Nul zonder code.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string | null
vereist
Hoeveel eenheden currency één eenheid base_currency oplevert, als decimale string zoals "5.4321": de koers waartegen de prijzen van de varianten zijn omgerekend, vast tot expires_at, en de koers waartegen een betaling die de quote gebruikt wordt afgerekend. Een string, net als geldbedragen, zodat geen float het onderweg afrondt. Null wanneer er niets is omgerekend.
string
vereist
Wanneer de quote niet meer in rekening kan worden gebracht, als ISO 8601-tijdstempel. Vraag daarna opnieuw een quote aan.
object[]
vereist
Eén item per variant, in de opgegeven volgorde, elk met een eigen belasting.

Eigenschappen

object
vereist
Het aandeel van de promotiecode op deze regel. Nul zonder code.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
integer
vereist
Hoeveel eenheden van de variant de regel omvat.
object
vereist
De prijs van de regel vóór het aandeel van de promotiecode en belasting; subtotal min discount is wat de regel na de korting bedraagt. De subtotalen van de regels tellen op tot het subtotal van de quote.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
De belasting op deze regel. Nul wanneer tax_status niet calculated is.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
subtotal min discount, plus tax_amount wanneer belasting erbovenop komt, of zonder wanneer de prijs deze al bevat.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string | null
vereist
De variant die deze regel prijst, met prefix plan_. Null wanneer de aankoop de variant beschrijft via variant en er nog geen variant met die kenmerken bestaat: de betaling die de quote gebruikt, maakt deze aan, en vanaf dan noemt de regel hem.
string | null
vereist
Voor welke locatie de belasting is berekend: shipping_address wanneer dat een land bevat, anders het factuur-address wanneer dat er een bevat, anders het meegestuurde presentment_country, anders het ip_address van de koper. Een quote die via presentment_country of ip_address is gelokaliseerd, is een preview die de belasting schat: een betaling kan deze niet gebruiken, dus vraag opnieuw een quote aan met het adres van de koper om te betalen. Null wanneer niets in het verzoek de koper lokaliseerde, wat alleen kan bij een verkoper die op deze aankoop geen belasting int; tax_status is dan not_applicable.Beschikbare opties: shipping_address, address, presentment_country, ip_address
string | null
vereist
De betaling die deze quote vasthoudt, met prefix pay_, of null zolang de quote niet is gebruikt. Een geweigerde betaling behoudt haar quote en kan opnieuw worden geprobeerd; controleer de status van die betaling.
string | null
vereist
De promotiecode die de quote heeft toegepast, met prefix promo_, of null.
ISO 4217-codes in kleine letters om de koper in een valutakiezer aan te bieden, meest relevante eerst: de valuta van het meegestuurde presentment_country, anders van het land waarin het ip_address van de koper zich bevindt, wanneer deze aankoop ernaar kan worden omgerekend en een betaalmethode die valuta kan innen, daarna base_currency. Vraag opnieuw een quote aan met een van deze als presentment_currency om erin te prijzen. Alleen base_currency wanneer de quote is geprijsd zonder presentment_currency of presentment_country.
object | null
vereist
Het verzendadres waarmee de aankoop is geprijsd, of null. Indien aanwezig is dit de plek waar de belasting is berekend.

Eigenschappen

string | null
vereist
De plaats.
string | null
vereist
De ISO 3166-1 alpha-2-landcode.
string | null
vereist
De eerste adresregel.
string | null
vereist
De tweede adresregel.
string | null
vereist
De naam op het adres.
string | null
vereist
De postcode.
string | null
vereist
De staat, provincie of regio.
object
vereist
De prijs van alle regels vóór promotiecode, belasting en kosten.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
De belasting die een betaling die deze quote gebruikt in rekening brengt. Nul tenzij tax_status calculated is.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string | null
vereist
Of belasting bovenop de prijs komt (exclusive) of er al in zit (inclusive). Null wanneer er geen belasting is berekend.Beschikbare opties: inclusive, exclusive
object[]
vereist
De belastingregistratie van de koper waarmee de quote als zakelijke aankoop is geprijsd. Leeg voor een consumentenaankoop.

Eigenschappen

string
vereist
Het type registratie, zoals eu_vat.Beschikbare opties: ad_nrt, ao_tin, ar_cuit, al_tin, am_tin, aw_tin, au_abn, au_arn, eu_vat, az_tin, bs_tin, bh_vat, bd_bin, bb_tin, by_tin, bj_ifu, bo_tin, ba_tin, br_cnpj, br_cpf, bg_uic, bf_ifu, kh_tin, cm_niu, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cv_nif, cl_tin, cn_tin, co_nit, cd_nif, cr_tin, hr_oib, do_rcn, ec_ruc, eg_tin, sv_nit, et_tin, eu_oss_vat, ge_vat, gh_tin, de_stn, gb_vat, gn_nif, hk_br, hu_tin, is_vat, in_gst, id_npwp, il_vat, jp_cn, jp_rn, jp_trn, kz_bin, ke_pin, kg_tin, la_tin, li_uid, li_vat, my_frp, my_itn, my_sst, mr_nif, mx_rfc, md_vat, me_pib, ma_vat, np_pan, nz_gst, ng_tin, mk_vat, no_vat, no_voec, om_vat, pe_ruc, ph_tin, pl_nip, ro_tin, ru_inn, ru_kpp, sa_vat, sn_ninea, rs_pib, sg_gst, sg_uen, si_tin, za_vat, kr_brn, es_cif, ch_uid, ch_vat, tw_vat, tj_tin, tz_vat, th_vat, tr_tin, ug_tin, ua_vat, ae_trn, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, zm_tin, zw_tin, sr_fin, xi_vat
string
vereist
Het registratienummer zoals de koper het heeft ingevoerd, zonder witruimte (bij eu_vat-waarden worden ook punten en streepjes verwijderd).
string
vereist
calculated: elke regel is geprijsd en een betaling mag de quote gebruiken. not_applicable: deze verkoper int geen belasting op deze aankoop, dus de quote is niets verschuldigd en mag nog steeds worden gebruikt. unavailable: de belasting kon niet worden geprijsd — de provider antwoordde niet, of de belastinginstellingen van deze verkoper kunnen hier geen aankoop prijzen — dus een betaling weigert de quote; vraag opnieuw een quote aan, of reken af zonder quote_id zodat de belasting op het moment van afrekenen wordt berekend.Beschikbare opties: calculated, not_applicable, unavailable
object
vereist
Wat de koper betaalt: het subtotaal min de korting, plus tax_amount wanneer belasting erbovenop komt.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
PaymentQuote