The backend API is the part of PayEx Checkout that is responsible for handling communication with the backend code of the client implementation, such as the web shop. The backend API is used to create a Payment Session associated with a purchase button, to check status of the Payment and to perform additional operations on the payment, such as Capture.

Backend API Urls

EnvironmentUrl
Testhttps://api.externalintegration.payex.com/psp/checkout
Productionhttps://api.payex.com/psp/checkout/

Authentication

The authentication for the API uses the Merchant token issued through the PayEx Merchant Administration web interface. This token is sent as a HTTP Authorization header like this:

Authorization: Bearer <merchantToken>

Any requests without the correct authentication will result in a 401 Unauthorized response from the PayEx Checkout API.

Resources

ResourceUsage
HomeUsed to retrieve information about the PayEx Checkout API and to discover the URL of the Payment Session resource.
Payment SessionUsed to create a Payment Session and to retrieve status about the associated Payment and Payer.
PaymentUsed to retrieve information about the payment and to perform additional operations on the payment, such as Capture.
TransactionUsed to retrieve detailed information about the transactions that has been performed on a Payment.
AddresseeUsed to retrieve adressee information (physical or digital delivery address) about the person who paid for the goods or service.
CallbacksUsed to retrieve information about the payment when payment changes status.
Created by Helge Dahl on 2018/01/22 15:48
   

Tips

You can click on the arrows next to the breadcrumb elements to quickly navigate to sibling and children pages.

Need help?

If you need help with XWiki you can contact: