The Order Management and Checkout services are built to work together but can also be used independently.Documentation Index
Fetch the complete documentation index at: https://docs.dintero.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorization
Create an API Client with the following scopes:admin:checkoutadmin:shopping
client_id and client_secret for use in the examples below.
Steps
Create a draft order
Create a draft order with line items. The order is not yet active and can be freely modified.Orders API POST /accounts/{aid}/shopping/draft_ordersExample request body:
Complete the draft order
Complete the draft to make the order active and assign it an
order_id.Orders API PUT /accounts/{aid}/shopping/draft_orders/{id}/completeCreate a checkout session
Create a checkout session, using the Create the session:See Display Checkout for how to present the session to the customer.When payment completes, poll the transaction status and confirm it is
order_id as merchant_reference.Checkout API POST /sessions-profileExample request body:profile_id may vary. Check Backoffice for the correct value.AUTHORIZED before proceeding.Mark the order as authorized
Record the authorization on the order to mark funds as reserved.Orders API POST /accounts/{aid}/shopping/orders/{order_id}/authorizationsExample request body:
Capture the transaction
Once items are ready to ship, capture the payment in the Checkout service. Then record the capture on the order to keep state in sync.Checkout API POST /transactions/{id}/captureOrders API POST /accounts/{aid}/shopping/orders/{order_id}/capturesExample request body for the Orders API call:
Refund the transaction
If the customer requests a refund, refund the payment in the Checkout service first. Then record the refund on the order.Checkout API POST /transactions/{id}/refundOrders API POST /accounts/{aid}/shopping/orders/{order_id}/refundsExample request body for the Orders API call: