Search

Are you looking for test card numbers?

Would you like to contact support?

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:

Name Type Required Description
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.

Name Type Returned by default Description
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

{  
   "accountKey":"TestMerchant"
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <getPayoutSchedule xmlns="http://caaccount.services.adyen.com">
      <request>
        <merchantCode>TestMerchant</merchantCode>
      </request>
    </getPayoutSchedule>
  </soap:Body>
</soap:Envelope>

Response

{  
   "pspReference":"9914526950630294",
   "payoutSchedule":"1 time per week (Tuesday) at 0:00 CET",
   "payoutScheduleDays":1
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns0="http://caaccount.services.adyen.com" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns0:blockPayoutResponse>
      <ns0:response>
        <ns0:pspReference>9914140758760046</ns0:pspReference>
        <ns0:payoutSchedule>2 times per week (Tuesday, Friday) at 0:00 CET</ns0:payoutSchedule>
        <ns0:payoutScheduleDays>2</ns0:payoutScheduleDays>
      </ns0:response>
    </ns0:blockPayoutResponse>
  </soap:Body>
</soap:Envelope>