Introduction

This API allows you to generate a payment link, capture a transactions or cancel a link in order to

<aside> 💡 This API accepts parameters following both the camelCase and the snake_case convention

• All parameters have been converted from camelCase to snake_case for better legibility.
• The query params in the response_url_success and response_url_cancel will remain cameCase in order to prevent introducing breaking changes. </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 cart and the link will be canceled.
• Partially Paid Carts: Carts 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>

Cart Status

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

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

Cart Representation

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

Carts with auto_capture set to False

Every day at 05:00 GMT we run a script which will:

• Automatically capture all transactions for fully paid carts with a status of authorised.