Payment
Request parameters
| Name | Type | Details | Mandatory | Description |
|---|---|---|---|---|
| reference | string | UNIQUE, [ -~] + (max: 85 ascii printable characters) | Y | Your own payment identifier for the request. |
| amount | int | Y | The payment amount in cents (500 XXX = 5.00 XXX). | |
| currency | string | [A-Z] 3 | Y | The currency in which the payment should be processed. The payment currency (ISO-4217). This will also be the default currency for the created mandate. |
| preauth | boolean | N* | This parameter determines whether the payment request should be fully processed or only authorized. * Defaults to false. | |
| capture_date | unix timestamp | N | This parameter determines when the pre-authorization will be automatically captured (if applicable). | |
| recipient_map | array | N | Paying out to other accounts. See section below. |
Paying out to other accounts
You have the possibility to automatically pay out a share or the entire amount of a payment (oneshot or rebill) to one or multiple accounts. For example you could send a given percentage of a sale to an account dedicated to taxes, a fixed amount to another one dedicated to a charity, or both.
In order to do so, your payment object must contain a recipient_map array made of recipients with the following properties:
| Name | Type | Details | Mandatory | Description |
|---|---|---|---|---|
| account_id | int | Y | The SysPay account id of the recipient (the account could belong to another user) | |
| user_id | int | Y | The SysPay user id of the owner of the recipient account (to prevent paying out a wrong account) | |
| calc_type | string | fixed | percent | Y | The way the pay out is calculated |
| value | integer | Y | If calc_type is percent, this is the percentage * 100 to subtract off the full payment amount (100 == 1%), if calc_type is fixed, this will be a fixed amount. | |
| currency | string | Y* | This value must be the same as the currency of the payment. * If calc_type is fixed. | |
| settlement_delay | int | N | A number of seconds the pay out settlement will be delayed for compared to the actual payment settlement |
Example
{
"reference": "65ea2474792d8",
"amount": 10000,
"currency": "EUR",
"preauth": false
}