{"title":"getPayoutSchedule","category":"default","creationDate":1776961629,"content":"

Request parameters<\/h2>\n

To get the payout schedule information for a merchant, make a POST \/getPayoutSchedule<\/code> specifying:<\/p>\n\n \n \n
Name<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>\n
\n

accountKey<\/code><\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n
\"-x-\"<\/center>\n<\/td>\n
\n

DEPRECATED
\nNot used anymore. Do not use.<\/p>\n<\/td>\n <\/tr>\n

\n

merchantCode<\/code><\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n
\"-white_check_mark-\"<\/center>\n<\/td>\n
\n

A merchant code string holds a value to identify a merchant.<\/p>\n

Format:<\/p>\n

    \n
  • Either: MerchantAccount.Merchant_Code<\/code><\/li>\n
  • Or: Merchant_Code<\/code><\/li>\n<\/ul>\n<\/td>\n <\/tr>\n<\/tbody><\/table>\n

    Response parameters<\/h2>\n

    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.<\/p>\n
    Name<\/th>Type<\/th>Returned\u00a0by\u00a0default<\/th>Description<\/th><\/tr><\/thead>
    \n

    payoutSchedule<\/code><\/p>\n<\/td>

    		\n

    String<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    Free-text description of the payout schedule.<\/p>\n<\/td><\/tr>

    \n

    payoutScheduleDays<\/code><\/p>\n<\/td>

    		\n

    int<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    Number of payout days per week.
    \nDefines how often you want to plan a payout on a weekly basis.
    \nFor example, once a week, twice a week, and so on.<\/p>\n

    Allowed values:
    \n1, 2, 3, 5<\/em>.<\/p>\n

      \n
    • 1<\/em>: on Tuesday at 00:00 CET<\/li>\n
    • 2<\/em>: on Tuesday, Friday at 00:00 CET<\/li>\n
    • 3<\/em>: on Tuesday, Thursday, Friday at 00:00 CET<\/li>\n
    • 5<\/em>: from Monday to Friday at 00:00 CET<\/li>\n<\/ul>\n<\/td>
    		\n\n<\/td><\/tr>
    \n

    pspReference<\/code><\/p>\n<\/td>

    		\n

    String<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    A reference to uniquely identify the request.<\/p>\n<\/td><\/tr>

    \n

    warnings<\/code><\/p>\n<\/td>

    		\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    List containing one or more warning messages.
    \nReturned when the request is not correctly processed.<\/p>\n<\/td><\/tr>

    \n

    errors<\/code><\/p>\n<\/td>

    		\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    List containing one or more error messages.
    \nReturned when the request fails.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

    Examples<\/h2>\n

    Request<\/h3>\n
    \n <\/code-sample>\n<\/div>\n

    Response<\/h3>\n
    \n <\/code-sample>\n<\/div>","url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-bank-accounts-and-payouts\/getpayoutschedule","articleFields":{"id":"25134990","type":"page","description":"Get payout schedule information at merchant level.","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-bank-accounts-and-payouts\/getpayoutschedule","title":"getPayoutSchedule","content":"Request parameters\nTo get the payout schedule information for a merchant, make a POST \/getPayoutSchedule specifying:\nNameTypeRequiredDescription\n\n \n \naccountKey\n\n \nString\n\n \n\n\n \nDEPRECATED\nNot used anymore. Do not use.\n\n \n \n \nmerchantCode\n\n \nString\n\n \n\n\n \nA merchant code string holds a value to identify a merchant.\nFormat:\n\nEither: MerchantAccount.Merchant_Code\nOr: Merchant_Code\n\n\n \n\nResponse parameters\nIf 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.\nNameTypeReturned\u00a0by\u00a0defaultDescription\npayoutSchedule\n\nString\n\n\n\nFree-text description of the payout schedule.\n\npayoutScheduleDays\n\nint\n\n\n\nNumber of payout days per week.\nDefines how often you want to plan a payout on a weekly basis.\nFor example, once a week, twice a week, and so on.\nAllowed values:\n1, 2, 3, 5.\n\n1: on Tuesday at 00:00 CET\n2: on Tuesday, Friday at 00:00 CET\n3: on Tuesday, Thursday, Friday at 00:00 CET\n5: from Monday to Friday at 00:00 CET\n\n\n\n\npspReference\n\nString\n\n\n\nA reference to uniquely identify the request.\n\nwarnings\n\nString\n\n\n\nList containing one or more warning messages.\nReturned when the request is not correctly processed.\n\nerrors\n\nString\n\n\n\nList containing one or more error messages.\nReturned when the request fails.\n\nExamples\nRequest\n\n \n\nResponse\n\n \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Account management API","lvl2":"Manage bank accounts and payouts","lvl3":"getPayoutSchedule"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/account-management-api","lvl2":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-bank-accounts-and-payouts","lvl3":"\/pt\/account-management-api\/manage-bank-accounts-and-payouts\/getpayoutschedule"},"levels":4,"category":"","category_color":"","tags":["getPayoutSchedule"]},"articleFiles":{"838733029.json":"

    838733029.json<\/p>","1795925655.json":"

    1795925655.json<\/p>"}}