On this page
No Headings
Last updated: June 3, 2026
You can set up daily automatic withdrawals for your merchants to transfer their money to their associated bank accounts. The payout transfer frequency is daily. The cutoff is aligned from midnight to midnight (24 hours), and the balance from the previous day's transactions is withdrawn to the attached bank account.
Scheduled payouts support only one currency for each merchant.
Use the merchant onboarding API to set up auto-withdrawals for your merchants.
curl --location --request POST '{{host}}/v3/customer/managed-accounts' \
--header 'Authorization: Bearer ACCESS-TOKEN' \
--header 'Content-Type: application/json' \
--data '
{
"external_id": "{{$guid}}",
"legal_country_code": "US",
"individual_owners": [
{
"citizenship": "US",
"names": [
{
"type": "LEGAL",
"given_name": "John",
"surname": "Doe"
}
],
"addresses": [
{
"type": "HOME",
"address_line_1": "7700 Eastport Pkwy",
"admin_area_2": "La Vista",
"admin_area_1": "NE",
"postal_code": "68128",
"country_code": "US"
}
],
"birth_details": {
"date_of_birth": "1970-04-01"
},
"identification_documents": [
{
"type": "SOCIAL_SECURITY_NUMBER",
"issuing_country_code": "US",
"identification_number": "718913411"
}
]
}
],
"business_entity": {
"type": "CORPORATION",
"merchant_category_code": "0742",
"incorporation_details": {
"incorporation_country_code": "US",
"incorporation_date": "2010-06-01"
},
"names": [
{
"type": "LEGAL",
"business_name": "Generic Merchant"
}
],
"addresses": [
{
"type": "BUSINESS",
"address_line_1": "7702 Eastport Pkwy",
"admin_area_2": "La Vista",
"admin_area_1": "NE",
"postal_code": "68128",
"country_code": "US"
}
],
"office_bearers": [
{
"addresses": [
{
"address_line_1": "7701 Eastport Pkwy",
"admin_area_1": "NE",
"admin_area_2": "La Vista",
"country_code": "US",
"postal_code": "68128",
"type": "HOME"
}
],
"birth_details": {
"date_of_birth": "1970-06-01"
},
"citizenship": "US",
"identification_documents": [
{
"identification_number": "323964099",
"issuing_country_code": "US",
"type": "SOCIAL_SECURITY_NUMBER"
}
],
"names": [
{
"given_name": "Jane",
"surname": "Doe",
"type": "LEGAL"
}
],
"role": "DIRECTOR"
}
],
"beneficial_owners": {
"individuals": [
{
"addresses": [
{
"address_line_1": "7703 Eastport Pkwy",
"admin_area_1": "NE",
"admin_area_2": "La Vista",
"country_code": "US",
"postal_code": "68128",
"type": "HOME"
}
],
"birth_details": {
"date_of_birth": "1970-01-01"
},
"citizenship": "US",
"names": [
{
"given_name": "Justin",
"surname": "Doe",
"type": "LEGAL"
}
],
"percentage_of_ownership": "75",
"identification_documents": [
{
"identification_number": "501985796",
"issuing_country_code": "US",
"type": "SOCIAL_SECURITY_NUMBER"
}
]
}
]
},
"declarations": [
{
"name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",
"value": "YES"
}
],
"identification_documents": [
{
"type": "EMPLOYER_IDENTIFICATION_NUMBER",
"identification_number": "111222333",
"issuing_country_code": "US"
}
]
},
"financial_instruments": {
"banks": [
{
"country_code": "US",
"type": "CHECKING",
"account_number": "78868666",
"account_number_type": "ALL_BANKS",
"currency_code": "USD",
"routing_number": "074001048",
"statement_descriptor": "Order payment",
"mandate": {
"consent_to_debit": true
}
}
]
},
"agreements": [
{
"type": "TERMS_ACCEPTED",
"accepted_time": "2023-06-02T01:23:45Z"
}
],
"attributes": [
{
"name": "SELF_CERTIFICATION",
"value": "true"
}
],
"organization": "US_1"
}'Use the PATCH API to add a bank account to a merchant's auto-withdrawal setup. The following examples show how to add bank accounts for merchants in the US and France.
curl --location --request PATCH '{{host}}/v3/customer/managed-accounts/{id}' --header 'Authorization: Bearer ACCESS-TOKEN' --header 'Content-Type: application/json '
[
{
"op": "add",
"path": "/financial_instruments/banks",
"value": [
{
"country_code": "US",
"account_holder_details": {
"name": "Mary Collins"
},
"account_number_type": "BASIC_BANK_ACCOUNT_NUMBER",
"account_number": "89935377",
"account_type": "checking",
"currency_code": "USD",
"routing_number": "082900429",
"bank_name": "Bank of America",
"statement_descriptor": "Order payment"
}
]
}
]Use the PATCH API to remove the bank account associated with the auto-withdrawal setup.
curl --location --request PATCH '{{host}}/v3/customer/managed-accounts/{id}' \
--header 'Authorization: Bearer ACCESS-TOKEN' \
--header 'Content-Type: application/json'
[
{
"op": "remove",
"path": "/financial_instruments/banks/@id=='BA-37VRDBLJDASQU'"
}
]Scheduled payouts do not have a lifecycle and do not generate a payout reference ID. As a result, you cannot query the status of a payout using a GET API.
Scheduled payouts do not provide notifications. Events such as configuration changes, payout processing status, and so on are not available for these payouts.
PayPal provides access to specific payout reconciliation report and settlement report, enabling merchants to reconcile pay-ins with payouts.