Bestellingen
Accountscope vereist: voeg de header X-Auth-Account toe met je Account-ID. Opvragen en bekijken vereisen de OAuth-scope billing:read. Aanmaken, bijwerken en verwijderen zijn niet beschikbaar via OAuth; die vereisen een sessie- of API-sleutel-credential.
Bestellingen verlopen via het cart- en facturatiesysteem. Elke bestelling wordt vooraf betaald met de opgeslagen creditcard van het betalende account, op een latere factuur gezet (post-pay), of gefactureerd om per bankoverschrijving te betalen. Zie Afrekenroutes.
POST /api/orders bestelt WordPress-sites. POST /api/orders/domain registreert of verhuist een domein. Beide geven altijd een 202 cart-envelop terug.
Alle bestellingen van een account opvragen
GET /api/orders
Params (optioneel)
- page: Integer | paginanummer (standaard: 1)
- per_page: Integer | records per pagina (standaard: 50, max: 100)
Teruggegeven params
- orders: Array
- id: String | uuid
- status: String
- created_at: DateTime
- updated_at: DateTime
- location: String | location short_name, of
nullvoor bestellingen zonder locatie (bijv. domeinregistratiebestellingen) - failure_reason: Object |
null, tenzij de registrar de bestelling heeft geweigerd om een reden die we toelichten; zie Waarom een domeinbestelling mislukte- code: String
- message: String
- account: Object
- id: String
- name: String
Een bestelling bekijken
GET /api/orders/:id
Poll dit endpoint totdat status een eindwaarde bereikt (completed,
failed, cancelled).
Teruggegeven params
- order: Object
- id: String | uuid
- status: String
- created_at: DateTime
- updated_at: DateTime
- location: String | location short_name, of
nullvoor bestellingen zonder locatie (bijv. domeinregistratiebestellingen) - failure_reason: Object |
null, tenzij de registrar de bestelling heeft geweigerd om een reden die we toelichten; zie Waarom een domeinbestelling mislukte- code: String
- message: String
- tasks: Array
- id: Integer
- status: String
- site: Object | aanwezig wanneer de bestelling een site heeft voorzien
- id: String
- name: String
- domain: String
- variant: String
- location: String
- ssh_data: Object |
nullwanneer de site geen SFTP-gegevens heeft- ipaddr: String
- username: String
- password: String
- port: Integer
- subscription: Object | aanwezig wanneer de bestelling een onderliggend abonnement heeft
- id: Integer | intern numeriek ID; wordt niet geaccepteerd door
/api/subscriptions/:id(zie de opmerking hieronder) - status: String
- bucket_type: String
- bucket_year: Integer
- bucket_month: Integer
- stripe_id: String
- id: Integer | intern numeriek ID; wordt niet geaccepteerd door
- domain: Object | aanwezig wanneer de bestelling een domein heeft geregistreerd of verhuisd
- name: String
- action: String |
registeroftransfer - registration: Object | het domeinregistratierecord — zie Domeinregistratie.
nulltijdens het asynchrone venster, totdat de registrar-aanroep slaagt - provisioning_status: String | alleen aanwezig zolang
registrationnullis; spiegelt destatusvan de bestelling
- payment: Object
- mode: String |
postpayvoor een bestelling die op een latere factuur wordt gezet (bij het afrekenen is niets belast),upfrontvoor elke andere bestelling - status: String |
pending,processing,succeeded,awaiting_authentication,awaiting_bank_transfer,on_next_invoiceoffailed; zie Waarden van de betalingsstatus - method_type: String | het betaalmethodetype (bijvoorbeeld
cardofsepa_debit), ofnull. Andere waarden zijn mogelijk; hardcode geen lijst - invoice_date: Date | alleen bij post-pay-bestellingen: de datum van de factuur waarop de bestelling wordt gezet (
YYYY-MM-DD), daarna de datum van de factuur zelf - hosted_invoice_url: String | null — ook
nullzolang een betaling van die factuur wordt verwerkt, zodat een klant niet twee keer betaalt - amount_charged_cents: Integer | wat de betaalmethode heeft betaald.
nulltotdat de factuur beschikbaar is. Bij een post-pay-bestelling alleen de regels van deze bestelling (inclusief btw, na kortingen) ennulltotdat de factuur is betaald - credit_applied_cents: Integer | tegoed dat de factuur heeft verbruikt (nooit negatief).
nulltotdat de factuur beschikbaar is, en altijdnullbij een post-pay-bestelling - first_term_credit_cents: Integer | het resize-tegoed voor de eerste termijn dat de factuur als negatieve regel bevat, inclusief btw, als positief geheel getal (
0als er geen is).nulltotdat de factuur beschikbaar is. Het factuurtotaal is er al mee verminderd - method: String | alleen voor bestellingen per bankoverschrijving:
bank_transfer— met de overige bankoverschrijvingsvelden
- mode: String |
- account: Object | Zie accounts#show
- user: Object | Zie users#show
subscription.id is niet het ID dat /api/subscriptions/:id accepteert
GET /api/subscriptions/:id verwacht het id dat Abonnementen opvragen teruggeeft, niet dit ID, en geeft er 404 voor terug. Vraag de abonnementen van het account op om het juiste te vinden.
payment.status gebruikt bij het bekijken van een bestelling en in de cart-envelop licht afwijkende waarden. Zie Waarden van de betalingsstatus.
Waarom een domeinbestelling mislukte
Als een domeinregistratie of -verhuizing mislukt doordat de registrar de bestelling
heeft geweigerd om een reden die we kunnen toelichten, bevat de bestelling
failure_reason met een code en een message. Anders dan andere foutmeldingen in de API, die altijd in het Engels zijn, volgt message de Accept-Language-header van het verzoek (standaard Engels, Nederlands bij nl). In alle
andere gevallen, ook bij een mislukte bestelling waarvan we de reden niet toelichten,
is failure_reason null: lees status om te zien of een bestelling is mislukt.
code |
Betekenis |
|---|---|
invalid_authcode |
De autorisatiecode van de verhuizing is onjuist. Vraag een nieuwe code op bij de huidige provider en plaats een nieuwe verhuisbestelling |
transfer_prohibited |
Het domein heeft een verhuisblokkade. Vraag de huidige provider die op te heffen en plaats daarna een nieuwe verhuisbestelling |
invalid_contact |
Het register heeft de contactgegevens van het domein afgewezen. Corrigeer ze en plaats een nieuwe bestelling |
already_registered |
Een registratie is geweigerd omdat het domein al geregistreerd is |
nameserver_not_found |
Een van de nameservers bestaat niet. Controleer ze en plaats een nieuwe bestelling |
Vang onbekende code-waarden op en toon message ongewijzigd aan je gebruiker.
Een nieuwe site bestellen
POST /api/orders
Belast de standaard betaalmethode van het facturatieaccount en voorziet asynchroon een WordPress-site. Het endpoint geeft altijd 202 Accepted terug met een polling-envelop.
Locatie- en plannamen vind je door het /api/about-endpoint te bevragen.
Het facturatieaccount moet klaar zijn om te belasten: een opgeslagen standaard betaalmethode en een volledig facturatiecontact. Anders is het antwoord 400 no_default_payment_method en wordt er geen bestelling aangemaakt. Extern gefactureerde accounts en workspaces die per bankoverschrijving betalen hebben geen opgeslagen betaalmethode nodig; zie Afrekenroutes.
Params
- site: Object (required)
- name: String | wordt geaccepteerd maar genegeerd; zie de opmerking hieronder
- variant: String (required) | vanilla, extendify
- location: String (required) | Location short_name (bijv. "pdx")
- plan: String (required) | Product short_name (bijv. "basic")
- term: String (required) | monthly of annual
- callback: Object | optionele uitgaande melding die wordt ge-POST wanneer de asynchrone task van de bestelling klaar is — zie Callbacks
- authorization: String | volledige waarde van de Authorization-header. Voorbeeld:
Bearer 12345 - url: String | volledig gekwalificeerde URL
- authorization: String | volledige waarde van de Authorization-header. Voorbeeld:
Je kunt de site geen naam geven
De site wordt vernoemd naar een domein dat in hetzelfde verzoek is besteld; anders krijgt hij een gegenereerde naam. Lees de echte naam uit de bestelling zodra die is voorzien.
Teruggegeven params (altijd 202 Accepted)
- status: String |
"accepted" - cart: Object
- token: String
- status: String |
active,processing,checked_out - rollup_status: String |
pending,processing,completed, ... - poll_url: String | absolute URL, bijv.
https://your-instance/api/carts/<token>
- payment: Object
- mode: String |
postpay— alleen aanwezig wanneer de bestellingen van de cart op een latere factuur worden gezet - status: String |
processing,succeeded,awaiting_authentication,awaiting_bank_transfer,on_next_invoice,pendingoffailed; zie Waarden van de betalingsstatus - method_type: String | het betaalmethodetype (bijvoorbeeld
cardofsepa_debit), ofnull. Andere waarden zijn mogelijk; hardcode geen lijst - invoice_date: Date | alleen aanwezig bij een post-pay-cart: de datum van de factuur (
YYYY-MM-DD) - hosted_invoice_url: String | null
- method: String | alleen voor bestellingen per bankoverschrijving:
bank_transfer— met de overige bankoverschrijvingsvelden
- mode: String |
- orders: Array
- id: String | uuid
- status: String |
pending - poll_url: String | absolute URL, bijv.
https://your-instance/api/orders/<id>
- billing: Object | alleen aanwezig wanneer de bestelling post-pay is geplaatst — zie Post-pay-bestellingen
Poll cart.poll_url (of de poll_url van elke bestelling) totdat de bestellingen een eindtoestand bereiken. orders is eerst leeg; het bestellings-ID krijg je door de cart te pollen.
Fouten
Elke 4xx draagt naast errors een machineleesbare code. Er wordt niets
belast en er wordt geen bestelling aangemaakt.
- 400
missing_account| de headerX-Auth-Accountontbreekt - 400
account_cannot_order| het account mag geen bestellingen aanmaken - 400
unknown_variant|variantis geen bekend varianttype - 400
unknown_location|locationis geen bekende publieke locatie - 400
over_capacity| de variant heeft geen voorraad op die locatie — opnieuw te proberen - 400
unknown_term|termis nietmonthlyofannual - 400
unknown_product|planis niet bestelbaar op het facturatieplan van het account - 400
no_price_for_plan| geen prijs voorplanbij de gevraagdeterm - 400
item_add_failed| de cart weigerde het site-item - 400
no_default_payment_method| facturatieaccount niet klaar om te belasten - 422
cart_pay_failed| de betaling kon niet worden gestart
Weigeringen van de afrekenroutes (bijvoorbeeld billing_permission_required, outstanding_balance_exceeded, recent_dispute) staan onder Afrekenroutes en weigeringen.
Een domein registreren of verhuizen
POST /api/orders/domain
Registreert of verhuist een domein en belast de standaard betaalmethode van het account, en maakt daarna een verlengingsabonnement en DNS-zone aan. Geeft altijd 202 Accepted terug met de gedeelde cart-envelop; poll /api/orders/:id (dat een domain-blok bevat) totdat status een eindwaarde heeft.
Vereist een user-scoped credential (een system API key zonder gebruiker geeft 401 user_required terug) en de header X-Auth-Account. Geeft 503 feature_disabled terug wanneer domeinregistratie niet is ingeschakeld, en 403 trial_account voor trial-accounts.
Params
- domain: Object (required)
- name: String (required) | volledig gekwalificeerd, bijv.
example.com - action: String (optional) |
register(standaard) oftransfer - authcode: String | vereist voor verhuizingen wanneer de TLD een authcode vereist
- nameserver_mode: String (optional) |
default(onze nameservers; ook gebruikt als het ontbreekt),keep(alleen bij verhuizen: houd de huidige nameservers van het domein) ofcustom - nameservers: Array | vereist bij
nameserver_modecustomen anders geweigerd: 2–4 hostnamen, geen enkele binnen het bestelde domein.keepencustommaken geen DNS-zone aan, omdat het domein extern wordt gehost - contact: Object | inline registrant; vereist tenzij
contact_sourceis opgegeven- first_name: String | minstens één van
first_nameenlast_nameis vereist; zet een naam van één woord inlast_name - last_name: String | zie
first_name - organization: String (optional)
- street_address: String (required)
- post_code: String (required)
- city: String (required)
- state: String (optional/required per TLD)
- country: String (required) | tweeletterige ISO-code
- email: String (required)
- phone: String (required) | E.164, bijv.
+1.5555555555 - extra_properties: Object | TLD-specifieke registryvelden (bijv.
.itentityType)
- first_name: String | minstens één van
- contact_source: Object | hergebruik de contacten van een eigen registratie in plaats van
contact- registration_id: Integer (required) | een eigen DomainRegistration met een owner-contact
- role_contacts: Object (optional) |
admin/billing/tech; elk:- source: String |
same_as_owner(standaard),existing, ofnew - source_registration_id: Integer | wanneer
sourceexistingis - first_name, last_name, ... | dezelfde contactvelden als hierboven, wanneer
sourcenewis
- source: String |
- name: String (required) | volledig gekwalificeerd, bijv.
- callback: Object (optional) | hetzelfde callback-contract als
POST /api/orders— zie Callbacks- authorization: String | volledige waarde van de Authorization-header. Voorbeeld:
Bearer 12345 - url: String | volledig gekwalificeerde URL
- authorization: String | volledige waarde van de Authorization-header. Voorbeeld:
Geef de registrant op met een inline contact-object of met contact_source.registration_id (om de contacten van een eigen registratie te hergebruiken), niet beide.
Teruggegeven params (altijd 202 Accepted)
Identieke envelop als POST /api/orders:
- status: String |
"accepted" - cart: Object |
{ token, status, rollup_status, poll_url } - payment: Object |
{ status, method_type, hosted_invoice_url } - orders: Array |
[{ id, status, poll_url }](leeg tijdens het asynchrone venster)
Fouten
Autorisatie / gating:
- 401
user_required| system Account-bearer key (geen gebruiker) - 503
feature_disabled| domeinregistratie niet ingeschakeld - 403
trial_account| trial-accounts kunnen geen domeinen bestellen
Validatie (400, geen belasting / geen bestelling aangemaakt):
missing_account| de headerX-Auth-Accountontbreektaccount_cannot_order| het account mag geen bestellingen aanmakeninvalid_action|actionnietregisteroftransferinvalid_domain| naam faalde bij normalisatie/validatieunsupported_tld| geen geconfigureerde TLD voor de naampricing_unavailable| geen bestelbare prijs voor het facturatieplan van het accountauthcode_required| verhuizing van een TLD die een authcode vereist, maar geen opgegeveninvalid_nameservers| onbekendenameserver_mode,keepbij een registratie, een ongeldigecustom-lijst, ofnameserversmeegestuurd zondernameserver_modecustomincomplete_contact| inline contact mist verplichte velden (inclusief zowelfirst_namealslast_name)invalid_contact| inline contact heeft een onjuiste waarde (bijv.countryniet 2 letters)invalid_contact_source|contact_source.registration_idniet gevonden of zonder owner-contactno_default_payment_method| facturatieaccount niet klaar om te belasten
Weigeringen van de afrekenroutes gebruiken dezelfde codes
als POST /api/orders — zie
Afrekenroutes en weigeringen.
Verwerking (422):
domain_unavailable| registry zegt dat de naam niet registreerbaar is (alleen register)domain_availability_unknown| de beschikbaarheidscontrole is mislukt, dus het is onbekend of de naam registreerbaar is; probeer het opnieuw (alleen register)domain_add_failed| cart weigerde het domein (bijv. al in eigendom)domain_contact_invalid| registrant-contact geweigerd (body bevatviolations)domain_contact_needs_augmentation| TLD heeft extra contactvelden nodig (body bevatneeds_augmentation)cart_pay_failed| de betaling kon niet worden gestart
domain_unavailable is niet hetzelfde als domain_availability_unknown
Alleen domain_unavailable betekent dat de naam niet geregistreerd kan worden. Probeer bij domain_availability_unknown opnieuw in plaats van de klant te vertellen dat de naam bezet is.
Afrekenroutes en weigeringen
Elk betaald endpoint dat met de cart-envelop antwoordt (POST /api/orders, POST /api/orders/domain, domeinregistraties, en het aanmaken of resizen van sites, cPanel-accounts en mailspaces) betaalt op een van drie manieren: vooraf met een creditcard, post-pay op een latere factuur, of per bankoverschrijving. De route wordt per bestelling bepaald op basis van de facturatiestatus van het betalende account; je kunt ze niet in het verzoek kiezen.
De 202-envelop en GET /api/orders/:id laten zien welke route een bestelling nam:
| Route | Wat het antwoord laat zien |
|---|---|
| Post-pay | payment.mode: "postpay", payment.status on_next_invoice totdat de bestelling is gefactureerd, en in de 202-envelope een billing-object |
| Bankoverschrijving | payment.method: "bank_transfer", payment.status awaiting_bank_transfer totdat de factuur is betaald, en de overschrijvingsgegevens |
| Vooraf | geen van beide |
GET /api/orders/:id en een houderwijziging van een domein bevatten geen billing; ze tonen post-pay alleen via payment.mode.
Post-pay-bestellingen
Bij een geslaagde post-pay-bestelling wordt de gebruikelijke envelop teruggegeven met
payment.mode: "postpay" en payment.invoice_date, plus:
Teruggegeven params (billing)
- billing: Object
- mode: String |
postpay - invoice_date: Date | de factuur waarop de bestelling wordt gezet (
YYYY-MM-DD) - entries: Array | de kosten die deze cart toevoegt, zonder terugboekingen. Bedragen zijn centen exclusief btw
- id: Integer
- workspace_id: String | de API-
idvan de workspace - order_id: String | uuid, of
null - kind: String
- description: String
- amount_cents: Integer
- discount_cents: Integer
- tax_estimate_cents: Integer | een schatting; de factuur legt de btw vast
- currency: String
- period_start: DateTime | of
null - period_end: DateTime | of
null - state: String
- mode: String |
Velden van de betaling per bankoverschrijving
Voor een bestelling per bankoverschrijving voegt het payment-blok van de
cart-envelop en van GET /api/orders/:id het volgende toe. De factuurvelden zijn
null totdat de factuur beschikbaar is.
Teruggegeven params (payment, bankoverschrijving)
- payment: Object
- method: String |
bank_transfer - invoice_id: String | ons factuur-ID
- invoice_number: String | ook de betalingsreferentie
- amount_due_cents: Integer | wat nog openstaat
- currency: String | ISO-code in kleine letters
- due_date: Date |
YYYY-MM-DD - instructions: Object |
nullzodra de factuur is betaald of vervallen, en voor een mislukte of geannuleerde bestelling- type: String |
eu_bank_transferofus_bank_transfer - reference: String
- account_holder_name: String | alleen
eu_bank_transfer - iban: String | alleen
eu_bank_transfer - bic: String | alleen
eu_bank_transfer - country: String | alleen
eu_bank_transfer - bank_name: String | alleen
us_bank_transfer - routing_number: String | alleen
us_bank_transfer - account_number: String | alleen
us_bank_transfer
- type: String |
- method: String |
Zijn alle bestellingen van een cart voor bankoverschrijving mislukt of geannuleerd, dan
is payment.status failed, is instructions null en wordt er geen betaallink
teruggegeven.
Waarden van de betalingsstatus
payment.status heeft deze waarden:
| Waarde | Betekenis | Bestelling bekijken | Cart-envelop |
|---|---|---|---|
pending |
Er is nog niets betaald | Ja | Alleen post-pay-carts |
processing |
Een betaling is onderweg | Ja | Ja. Ook de status van elke cart die nog niet is afgerekend |
succeeded |
Volledig betaald | Ja | Ja, zodra de cart is afgerekend |
awaiting_authentication |
De bank vereist dat de klant de betaling bevestigt. Verwijs hem naar hosted_invoice_url |
Ja | Ja |
awaiting_bank_transfer |
Een factuur voor bankoverschrijving staat open met nog een openstaand bedrag. succeeded zodra die is betaald |
Ja | Ja |
on_next_invoice |
Post-pay-bestelling die nog niet is gefactureerd (zie invoice_date). Daarna de eigen status van de factuur |
Ja | Ja |
failed |
Geweigerd, teruggeboekt of geannuleerd. Ook wanneer alle bestellingen van een cart voor bankoverschrijving zijn mislukt of geannuleerd | Ja | Ja |
Bij het bekijken van een bestelling wordt de waarde per bestelling afgeleid uit de toestand van die bestelling; de cart-envelop leidt hem af voor de hele cart. Beide kunnen op hetzelfde moment verschillen, dus handel de status af waar je hem leest. Voor extern gefactureerde accounts blijft de envelop op processing staan en bereikt nooit succeeded; let in plaats daarvan op orders[].status die completed bereikt.
Als een incasso na het voorzien van de bestelling wordt teruggeboekt, blijft de bestelling completed, maar payment.status volgt de factuur: failed met hosted_invoice_url ingesteld zolang die openstaat, processing (geen link) terwijl een nieuwe betaling onderweg is, en succeeded zodra die is betaald.
Weigeringscodes
Een geweigerde bestelling geeft errors en een machineleesbare code terug; de
meeste codes voegen een remediation-tekst toe.
| Status | Code | Betekenis en wat te doen |
|---|---|---|
| 409 | postpay_busy, bank_transfer_busy, sepa_checkout_busy |
Er wordt al een andere bestelling van dezelfde betaler geplaatst. Probeer het over enkele seconden opnieuw |
| 422 | postpay_route_changed |
De route veranderde terwijl de bestelling werd geplaatst. Probeer het verzoek opnieuw |
| 422 | postpay_promo_invalid |
De actiecode van de cart kan niet meer worden gebruikt; reason zegt waarom. Verwijder de code en bestel opnieuw, of probeer het bij reason: "unavailable" opnieuw |
| 422 | postpay_pay_open_invoices |
De bestelling kan pas worden geplaatst als de openstaande facturen van het betalende account zijn betaald; reason zegt waarom ze geblokkeerd is. invoices somt ze op, oudste eerst (id, number, amount_cents (het nog openstaande bedrag), currency, due_date, pay_url), alleen voor een gebruiker die de facturatie van het betalende account kan beheren. Voor anderen vraagt remediation om zo'n gebruiker |
| 422 | postpay_contact_support |
De bestelling kan nu niet worden geplaatst en alleen support kan dat oplossen; neem contact op met support |
| 422 | postpay_payment_in_progress |
Een eerdere betaling van het betalende account wordt nog verwerkt, of de betaalmethode kon niet worden gecontroleerd. Probeer het over enkele minuten opnieuw |
| 422 | postpay_add_payment_method |
Een resize of planwijziging op een betalend account zonder opgeslagen betaalmethode. Voeg een standaardbetaalmethode toe en probeer het opnieuw |
| 403 | billing_permission_required |
De workspace betaalt per bankoverschrijving en de gebruiker kan de facturatie van het betalende account niet beheren. Bestel als een gebruiker die dat wel kan |
| 400 | billing_details_incomplete |
Het facturatiecontact van het betalende account mist adres, plaats of land. Vul dat aan en bestel opnieuw |
| 422 | payer_in_dunning |
Het betalende account heeft een achterstallige factuur. Betaal de openstaande facturen en bestel opnieuw |
| 422 | outstanding_balance_exceeded, in_flight_limit_exceeded |
De bestelling zou wat de betaler verschuldigd is boven de limiet brengen. Betaal de openstaande facturen; support kan de limiet verhogen |
| 422 | instant_payment_method_required |
De bestelling moet vooraf worden betaald en de standaard van het betalende account is geen creditcard. Maak een creditcard de standaard, of bestel in het dashboard en betaal met creditcard of iDEAL |
| 422 | sepa_not_trusted |
De bestelling kan nog niet per incasso worden betaald. Maak een creditcard de standaard, of betaal een eerste bestelling met iDEAL of Bancontact |
| 422 | recent_dispute |
Een teruggeboekte betaling of chargeback in de afgelopen 90 dagen. Maak een creditcard de standaard, of neem contact op met support |
| 422 | bank_transfer_refused |
De bestelling kan niet per bankoverschrijving worden gefactureerd. Neem contact op met support |
| 422 | postpay_change_refused, first_term_credit_blocked |
Een formaat- of pakketwijziging die nu niet kan worden doorgevoerd. Neem contact op met support |
| 409 | bank_transfer_in_progress |
Een eerdere bestelling van de betaler is nooit afgerond. Bestel niet opnieuw; neem contact op met support |
| 422 | bank_transfer_failed |
De bestelling is gestopt nadat ze was gefactureerd. Herhaal het verzoek niet — dat zou een tweede bestelling plaatsen. Neem contact op met support |
| 422 | postpay_failed |
De bestelling is halverwege gestopt. Controleer de bestellingen van het account voordat je het verzoek herhaalt, zodat ze niet twee keer wordt geplaatst |
De weigeringen postpay_pay_open_invoices, postpay_contact_support, postpay_payment_in_progress en postpay_add_payment_method plaatsen geen bestelling, dus je kunt het verzoek herhalen zodra de oorzaak is weggenomen. Alle vier kunnen reason bevatten.
De limietcodes kunnen outstanding_cents, limit_cents, order_cents en
currency toevoegen.
Een bestelling annuleren
Annuleert een lopende bestelling.
DELETE /api/orders/:id
Geeft 202 terug.
Fouten
- 422
payment_processing| een incasso voor de bestelling is nog niet afgewikkeld; de bestelling kan pas worden geannuleerd zodra die is afgewikkeld
PATCH is een no-op
PATCH /api/orders/:id is gereserveerd en geeft 400 terug.
Carts
Poll de cart-status tijdens het asynchrone venster na POST /api/orders, een
planwijziging van een site, of elk ander
betaald endpoint dat met dezelfde cart-envelop antwoordt.
Accountscope vereist (X-Auth-Account). Scope: billing:read. Carts zijn gescoped
naar je eigen account; een onbekend token geeft 404 terug.
GET /api/carts/:token
Het cart-token komt uit de create-response (cart.token / cart.poll_url). De
responsstructuur weerspiegelt POST /api/orders, zodat je dezelfde parser kunt
hergebruiken:
Teruggegeven params
- status: String |
"accepted" - cart: Object
- token: String
- status: String
- rollup_status: String
- poll_url: String
- payment: Object
- status: String
- method_type: String | het betaalmethodetype (bijvoorbeeld
cardofsepa_debit), ofnull. Andere waarden zijn mogelijk; hardcode geen lijst - hosted_invoice_url: String | null
- orders: Array
- id: String | uuid
- status: String
- poll_url: String
Het payment-blok bevat ook mode en invoice_date voor een post-pay-cart en de
bankoverschrijvingsvelden voor een
cart per bankoverschrijving, precies zoals bij POST /api/orders.