This class contains data that should be passed in the /storeDetailAndSubmitThirdParty request to initiate a payout.

Field Type Required Description
additionalData Object (error)

This field contains additional data, which may be required for a particular request.

amount Amount (tick)

A container object for the payable amount information of the transaction.

BankAccount (error)

A container for bank account data.

This field is mandatory if the card details are not provided.

billingAddress Address (error) The billing address.
card Card (error)

A container for card data.

This field is mandatory if bank details are not provided.

dateOfBirth Date (error)

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. 

entityType String (tick)

The type of the entity the payout is processed for.

Allowed values:

  • NaturalPerson
  • Company
fraudOffset Int (error)

An integer value that is added to the normal fraud score. The value can be either positive or negative.

merchantAccount String (tick)

The merchant account identifier you want to process the (transaction) request with.

nationality String (tick)

The shopper's nationality.

A valid value is an ISO 2-character country code (e.g. 'NL').

recurring Object (tick)

A container for the type of recurring contract to be retrieved.

The recurring.contract must be set to PAYOUT.

reference String (tick) The (merchant) reference for this payment. This reference will be used in all communication to the merchant about the status of the Payout payment. Although it is a good idea to make sure it is unique, this is not a requirement.
String (error)

The name of the brand to make a payout to.

For Paysafecard it must be set to paysafecard.

shopperEmail String (tick)

The shopper's email address.

shopperName Name (tick)

The shopper's name.

If the entityType is Company, submit the company name in the shopperName.lastName field.

shopperReference String (tick)

The shopper's reference for the payment transaction.

shopperStatement String (error)

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 (error) The shopper's social security number.