| additionalData |
object |
This field contains additional data, which may be required for a particular request. |
| amount |
object |
A container object for the payable amount information of the transaction. |
| dateOfBirth |
string |
The date of birth. Format: ISO-8601; example: YYYY-MM-DD For Paysafecard it must be the same as used when registering the Paysafecard account. > This field is mandatory for natural persons. > This fie |
| entityType |
string |
The type of the entity the payout is processed for. Allowed values: * NaturalPerson * Company > This field is required to update the existing `entityType` that is associated with this recurring contra |
| fraudOffset |
integer |
An integer value that is added to the normal fraud score. The value can be either positive or negative. |
| merchantAccount |
string |
The merchant account identifier you want to process the transaction request with. |
| nationality |
string |
The shopper's nationality. A valid value is an ISO 2-character country code (e.g. 'NL'). > This field is required to update the existing nationality that is associated with this recurring contract. |
| recurring |
object |
A container for the type of recurring contract to be retrieved. The `recurring.contract` must be set to "PAYOUT". |
| reference |
string |
The merchant reference for this payout. This reference will be used in all communication to the merchant about the status of the payout. Although it is a good idea to make sure it is unique, this is n |
| selectedRecurringDetailReference |
string |
This is the `recurringDetailReference` you want to use for this payout. You can use the value LATEST to select the most recently used recurring detail. |
| shopperEmail |
string |
The shopper's email address. |
| shopperName |
object |
The shopper's name. In case the `entityType` is `Company`, the `shopperName.lastName` must contain the company name. > This field is required to update the existing `shopperName` associated with a rec |
| shopperReference |
string |
The shopper's reference for the payout transaction. |
| shopperStatement |
string |
The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). |
| socialSecurityNumber |
string |
The shopper's social security number. |