Integration Checklist

🟦

The below is a summary of API calls needed to create and manage orders containing clarifications and connections between the different calls.

The complete description of the payment flow you can find in the payment flow overview in the Getting Started section of the Billie Docs.

• General Error Handling
  • unauthorized → Get a new bearer token and re-send the API call
  • Request Validation - missing fields or mal-formatted fields
• Create an order with the widget
  • API Call: Checkout Session Create
  • Checkout Client
  • API Call: Checkout Session Confirm
• Create an order with a Hosted Payment Page
  • API Call: HPP Checkout Session Create (Scope: hpp_ecommerce)
  • Redirect the buyer to the Hosted Payment Page
  • API Call: Get Authorization
  • API Call: Checkout Session Confirm
• Create an order from the backend with a Hosted Payment Page
  • API Call: HPP Checkout Session Create (Scope: hpp_telesales)
  • Send the link to the HPP to the Buyer
  • Consume the Webhook order_created
• Create an order from the backend without buyer presence
  • API Call: Create Order
• Get order details
  • API Call: Get Order
• Update an order
  • API Call: Update Order
    • Update External Order ID
    • Change the amount of the order
• Cancel an order
  • API Call: Cancel Order
    • Cancel a complete order that is not shipped
    • Cancel a complete order an all corresponding invoices
• Ship an order and capture the amount
  • API Call: Create Capture
    • Full amount
    • Partial amount
• Get capture details
  • API Call: Get Capture
• Update capture
  • API Call: Update Capture
    • Invoice ID and / or Invoice URL / sFTP location
• Refund a Capture
  • API Call: Refund against a Capture
    • Full amount
    • Partial amount
  • API Call: Cancel Capture
    • Refunds the full amount
• Confirm Buyer payment to merchant
  • API Call: Confirm Buyer Payment