API Reference
Log In
API Reference

Learn how to accept payments with Rootline's integration options

With Rootline Payments, you're on your way to providing a seamless and secure payment experience to customers.

In the core, Rootline's Payment API is designed to handle various steps required to convert a payment. Think of collecting payment details, or redirecting a customer to an external page.

You may choose to leverage Rootline's checkout pages to handle the different steps in the payment process. This will allow you to keep the integration light-weight and to get up-and-running quickly. We call this A quick integration.

Alternatively, you may choose to integrate deeper into the API's and build out your own checkout page powered by A custom integration. This gives you a way to fully control the look-and-feel of your checkout, while accepting payments with Rootline in a secure way.

More details on each way of integrating can be found under The Payment API.

Checkout statuses

One important indicator in accepting payments to take note of is the checkout_status. It is the principle status of a payment, and it will tell you whether or not the payment was successful.

Below is an overview of a payment's checkout_status and a description of each checkout_status.

checkout_statusDescription
OpenThe payment is still open. An action needs to be taken to complete the payment authorization process.
SucceededThe payment is successfully authorized. The authorization object contains more details about the result the payment acquirer gave back to Rootline.
FailedThere was an authorization attempt, but it is declined or has an error.

If you are receiving a failed checkout status, and want to know in more detail why the payment failed, you can zoom in to the authorization object where you will find a status of the authorization attempt, and decline_details or error_details which tell you more about the decline or error, respectively.

Authorization status

The checkout_status is dependent on the authorization.status of the latest authorization attempt. With each payment attempt, an authorization object will be created.

🚧

Currently each payment only has one authorization. With a decline or error, the payment will be closed with a failed checkout_status

authorization.statusDescription
createdAn authorization attempt was started, but there is no final result yet
pendingPayment finalization was started, but there is no final result known to Rootline yet
approvedThe authorization attempt was approved by the scheme owner, acquirer or issuer
declinedThe authorization attempt was declined by the scheme owner, acquirer or issuer
errorAn error occurred during the authorization process

Mapping of checkout_statuses and authorization.statuses

The checkout_status is your principle status to determine whether or not you want to proceed with the delivery of good or services. The checkout_status is determined by the outcome of the authorization process.

Scenarioauthorization.statuscheckout_status
The payment has no authorization object yet-open
An authorization attempt was started, but there is no final result yetcreatedopen
Payment finalization was started, but there is no final result known to Rootline yetpendingopen
The authorization attempt was approved by the scheme owner, acquirer or issuerapprovedsucceeded
The authorization attempt was declined by the scheme owner, acquirer or issuerdeclinedfailed
An error occurred during the authorization processerrorfailed