POST
/
executePayment

Query Parameters

apiKey
string
required

The API Key of your account.

data
object
required
SessionId
string

The SessionId you have from the initateSession endpoint.

Sample: 783851c4-b10f-4e40-bb2c-fcb657975ffb.

InvoiceValue
string

The invoice total amount that should be paid by the customer.

Sample: 313.14.

Suppliers
array
required
SupplierCode
integer
required

Your Supplier Code (you’ll get it after joining DashPay)

Sample: 123.

test
boolean

Set this property to true to send the request to the development environment.

Response properties

IsSuccess
boolean
required

The response status.

Message
string
required

The description of the response status.

ValidationErrors
array|null
required

List of validation errors (if any).

Data
object
required
InvoiceId
integer
required

A unique integer value of the created invoice.

IsDirectPayment
boolean
required

true or false to indicate if this URL for Direct Payment method.

PaymentURL
string
required

The URL that you should redirect the customer to OR submit the card details to process the payment.

CustomerReference
string
required

Refers to the order or transaction ID in your system that you have sent in the request earlier.

Error Codes

Here’s a list of possible error codes of this endpoint.

CodeDescription
1Missing or invalid api key
2InvoiceValue is a required parameter.
3Suppliers is not valid.
4wrong supplier code.
5An error meessage from the bank.