Documentation

A payment can be prepared using the API - Payment entity.

POST payment/invoice

Used for

Preparing a payment. With the data, a payment can be offered to the user, for example via a web form. This allows the payment process to be included in a website or in an app.

Authentication

User must be logged in at administrator level

Parameters

Parameter Description Mandatory Example

method

Payment method / provider Yes INGENICO

invoice_number

The invoice number Yes 1234

Example

Create payment for reservation.

POST api/rest/payment/invoice
request: {
   "method": "INGENICO",
   "invoice_number": 33388,
   "pay_id": 0
}
Reply: {
   "PSPID": "teqainformatics",
   "ORDERID": "20093094",
   "AMOUNT": 37500,
   "CURRENCY": "EUR",
   "PARAMVAR": "33388_0",
   "LANGUAGE": "en",
   "url": "https://secure.ogone.com/ncol/test/orderstandard.asp",
   "SHASign": "21E90410DC5E18E405C7C751E08CD96AB9D3CA68E3C3CCDD21309827E759BBD6187413A4A239A9A47C7AE3746F64118F29273208D859AC7C670254EB2D271 EC0"
}

The following right may be necessary in order to use this functionality.