Wiki source code of Backend API
Last modified by Asbjørn Ulsberg on 2018/07/05 12:48
| 1 | 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. |
| 2 | |
| 3 | = Backend API Urls = |
| 4 | |
| 5 | (% style="width:473px" %) |
| 6 | |=(% style="width: 107px;" %)Environment|=(% style="width: 363px;" %)Url |
| 7 | |(% style="width:107px" %)Test|(% style="width:363px" %)[[https:~~/~~/api.externalintegration.payex.com/psp/checkout>>https://api.externalintegration.payex.com/psp/checkout]] |
| 8 | |(% style="width:107px" %)Production|(% style="width:363px" %)https://api.payex.com/psp/checkout/ |
| 9 | |
| 10 | = Authentication = |
| 11 | |
| 12 | The authentication for the API uses the Merchant token issued through the PayEx Merchant Administration web interface. This token is sent as a HTTP {{code}}Authorization{{/code}} header like this: |
| 13 | |
| 14 | {{code}} |
| 15 | Authorization: Bearer <access_token> |
| 16 | {{/code}} |
| 17 | |
| 18 | Any requests without the correct authentication will result in a {{code}}401 Unauthorized{{/code}} response from the PayEx Checkout API. |
| 19 | |
| 20 | = Resources = |
| 21 | |
| 22 | (% style="width:100%" %) |
| 23 | |=(% style="width: 20%;" %)Resource|=(% style="width: 80%;" %)Usage |
| 24 | |[[Home>>Sandbox.payex-checkout-v1.Introduction.Home.WebHome]]|Used to retrieve information about the PayEx Checkout API and to discover the URL of the Payment Session resource. |
| 25 | |[[Payment Session>>Sandbox.payex-checkout-v1.Introduction.Payment-session.WebHome]]|Used to create a Payment Session and to retrieve status about the associated Payment and Payer. |
| 26 | |[[Payment>>Sandbox.payex-checkout-v1.Introduction.Payment.WebHome]]|Used to retrieve information about the payment and to perform additional operations on the payment, such as Capture. |
| 27 | |[[Addressee>>Sandbox.payex-checkout-v1.Introduction.Payer.WebHome]]|Used to retrieve adressee information (physical or digital delivery address) about the person who paid for the goods or service. |
| 28 | |[[Callbacks>>Sandbox.payex-checkout-v1.Introduction.Callbacks.WebHome]]|Used to retrieve information about the payment when payment changes status. |