Introduction

This API allows you to generate a payment link, capture a payment (in full or in part), cancel a link, and read the current state of a checkout. You create a link for an order, redirect your customer to Yavin's secure checkout to pay by bank card (including American Express, with 3-D Secure and co-badge selection handled for you) or by meal voucher (Conecs, Swile, Edenred), and you are notified of the result by webhook.

<aside> 💡

Field naming is flexible on input: the API accepts both camelCase and snake_case keys (checkoutExternalId and checkout_external_id both work). Responses use snake_case, with one exception: the query parameters appended to your return_url_success and return_url_cancelled URLs stay camelCase (cartId, status) to avoid breaking existing integrations.

</aside>

<aside> 🆕

This documentation covers v5, the current version. New integrations should use checkout_external_id (the deprecated cart_id is kept only as a backwards-compatible alias) and send order_number.

V4

</aside>

Key information

Payment Link lifetime

• Unused Links: Payment links that have no payments associated with them will remain active for a maximum of 72 hours. After this period, the checkout and the link will be canceled.
• Partially Paid Checkouts: Checkouts that have been partially paid will be systematically canceled when the script runs to ensure that funds are released back to the customer, especially if they have paid with titres restaurants.

<aside> 💡 If a payment is still required after a link has been canceled, a new payment link must be generated through the /generate_link/ endpoint.

</aside>

Checkout Status

There is no notion of a 'failed' status. Here's a breakdown of the possible statuses:

• pending: Awaiting payment.
• ok: Successfully paid and captured.
• authorised: Paid but contains one or more authorised transactions that require capturing.
• ko: The checkout has been cancelled.

Amount

• Amounts are always integers in cents and must be positive. The minimum amount on a checkout is 100 (€1.00).

Checkout Representation

• A checkout represents a single payment request. It can contain one or more transactions, allowing customers to pay in part with a meal voucher and top up the rest with another card.
• Whenever the notion of checkout is used, it is referring to a payment request initiated by the /generate_link/ endpoint.