API Payments

This guide explains how to use the dashboard to create an API Payment that you need to process payments on your app using our API endpoints.

1. Navigate to XPay dashboard through the follwing Urls:

• Testing dashboard

• Testing dashboard

2. Enter your credentials and click on Log in.

3. Navigate to API Payment under API Integrations section in the side menu.

4. Click on add variable amount button in the top right corner.

5. Fill in the name and description that describe your payment type.

6. check Is active option.

7. if you want your payments to require a <member_id> field, check Require member id, this id will not be validated, it will just be an internal info in your business, if you don't need it.. uncheck it.

8. if you want the payment iframe to redirect to a specific page after payment is done, fill in the url to redirect to in Redirect url field. In the redirected url you will have the status of the transaction, the transaction id, and the member id if provided.

9. If you want the payment server to send a POST request to another server with transaction status, and details, after payment is done, fill in Callback url field. The POST request body will have the status of the transaction, the transaction id, and the member id if provided.

info

The callback URL is only called when the transaction is accepted by our system, meaning the user completed the payment and received a response indicating the transaction was successful for a card payment or pending for kiosk / cash collection

10. click Save.

11. you will be redirected back to API Payment, the new created template will appear.

12. save the value in the ID column for later.