Store payout details


Stores payment details under the PAYOUT recurring contract. These payment details can be used later to submit a payout via the /submitThirdParty call.

Endpoint destination URL
Click to copy

Request Parameters


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


A container for bank account data.

This field is mandatory if card is not provided.


The billing address.

The billingAddress object is required for cross-border payouts to and from Canada. Include all of the fields within this object.


A container for card data.

This field is mandatory if bank is not provided.


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.


The type of the entity the payout is processed for.


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


The merchant account identifier, with which you want to process the transaction.

Max length: 2

The shopper's nationality.

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


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

The recurring.contract must be set to PAYOUT


The name of the brand to make a payout to.

For Paysafecard it must be set to paysafecard.


The shopper's email address.


The shopper's name.

When the entityType is Company, the shopperName.lastName must contain the company name.


The shopper's reference for the payment transaction.


The shopper's social security number.


The shopper's phone number.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less