Initiate Session
Initiate new session for a payment. This endpoint will help you get the paymentURL that you can use to redirect the customer to in order to complete the payment.
Query Parameters
The API Key of your account.
The URL that will be used to redirect the customer after the payment process is done.
The URL that will be used to redirect the customer after the payment process is failed.
Any value you want to store with the invoice (you can get it later using the Payment Inquiry method). This can be a user identifier or a transaction Id in your system.
The total amount you want the customer to pay.
Your Supplier Code (you’ll get it after joining DashPay)
Sample: 123.
Set this property to true to send the request to the development
environment.
Response properties
A boolean value indicates the response status.
A boolean value indicates the development environment status.
The payment URL that you’ll use to redirect the cusotmer to complete the payment. It’s a link for a hosted page that will provide multiple payment methods that can be choosed by the customer to pay the invoice.
Error Codes
Here’s a list of possible error codes of this endpoint.
| Code | Description |
|---|---|
| 1 | Missing or invalid api key |
| 2 | CallBackUrl is a required parameter. |
| 3 | UserDefinedField is a required parameter. |
| 4 | InvoiceValue is a required parameter. |
| 5 | Suppliers is a required parameter. |
| 6 | ErrorUrl is a required parameter. |
| 7 | CallBackUrl should be a valid URL. |
| 8 | UserDefinedField should be an array. |
| 9 | InvoiceValue should be greater than zero. |
| 10 | Suppliers should be an array. |
| 11 | ErrorUrl should be a valid URL. |