Skip to navigation
Yoco API referenceOrders

Introduction

The Orders API lets you create an order and retrieve orders, including their line items, payments, refunds, and total amounts.

Creating an order

Create an order to record a sale that took place outside Yoco, such as on a delivery app. You can include a payment you’ve already collected. Yoco records the payment but doesn’t charge the customer.

A new order starts completed when it’s paid in full, and open otherwise.

Order states

An order can be in one of the following states:

open

The order exists but isn’t yet completed. You can still add or edit items or payments. This isn’t an end state. An order can transition from open to either completed or cancelled.

completed

The order finalises and closes. All related payments complete and the total order amount is fully paid. This is an end state. An order can’t transition from completed to another state.

cancelled

The order voids or cancels before completion. This is an end state. An order can’t transition from cancelled to another state.

After an order is marked completed, the updated_at timestamp may change to reflect post-completion events such as refunds. Use the updated_at field to detect changes after completion.