Default icon

getPayoutSchedule

Get payout schedule information at merchant level.

Request parameters

To get the payout schedule information for a merchant, make a POST /getPayoutSchedule specifying:

NameTypeRequiredDescription

accountKey

String
-x-

DEPRECATED
Not used anymore. Do not use.

merchantCode

String
-white_check_mark-

A merchant code string holds a value to identify a merchant.

Format:

  • Either: MerchantAccount.Merchant_Code
  • Or: Merchant_Code

Response parameters

If there are no errors in the request, the call returns a list of configured, unconfirmed deleted, and unconfirmed updated bank accounts belonging to the specified merchant code.

NameTypeReturned by defaultDescription

payoutSchedule

String
-white_check_mark-

Free-text description of the payout schedule.

payoutScheduleDays

int
-white_check_mark-

Number of payout days per week.
Defines how often you want to plan a payout on a weekly basis.
For example, once a week, twice a week, and so on.

Allowed values:
1, 2, 3, 5.

  • 1: on Tuesday at 00:00 CET
  • 2: on Tuesday, Friday at 00:00 CET
  • 3: on Tuesday, Thursday, Friday at 00:00 CET
  • 5: from Monday to Friday at 00:00 CET

pspReference

String
-white_check_mark-

A reference to uniquely identify the request.

warnings

String
-x-

List containing one or more warning messages.
Returned when the request is not correctly processed.

errors

String
-x-

List containing one or more error messages.
Returned when the request fails.

Examples

Request

Response