Test in sandbox

You can test account update errors in the sandbox. If you want to understand the response if you updated an account without adding a required data point, exclude the data point from your update calls.

The default state for updating bank accounts in the sandbox is a happy path because we cannot verify test data. To test negative scenarios, use a simulation keyword for the specific use case, as shown in the following examples.

Incorrect business information

Use case scenario: Update an account that previously completed KYC verification with incorrect merchant name or business information.

Simulation code: The business_name in the patch must be DECLINED.

[
    {
        "op": "replace",
        "path": "/business_entity/names/@id=='S7S37669QZ2BN'",
        "value": {
            "business_name": "DECLINED",
            "type": "LEGAL"
        }
    }
]

Incorrect primary authorized user name

Use case: Update a sole proprietor account that has already completed KYC verification with an incorrect primary authorized name.

Simulation code:

[
    {
        "op": "replace",
        "path": "/individual_owners/@id=='{{account_id}}'/names/@id=='HMWK8QBM8V5W'",
        "value": {
            "given_name": "James DECLINED",
            "surname": "DECLINED",
            "type": "LEGAL"
        }
    }
]

Incorrect beneficial owner

Use case scenario: Update a merchant account with an incorrect beneficial owner name.

Simulation code: The given_name and surname for the beneficial owner (office_bearers or beneficial_owners) must be "DECLINED".

[
    {
        "op":"replace",
         "path":"/business_entity/office_bearers/individuals/@id=='{{ob_id}}'/names",
         "value": [{
             "type": "LEGAL",
             "given_name": "Another DECLINED",
              "surname": "DECLINED"
          }]
     }
]

Incorrect beneficial owner address

Use case scenario: Update a merchant account with incorrect beneficial owner or office bearer address.

Simulation code: For stakeholders (office_bearers or beneficial_owners):

[
  {
    "op": "replace",
    "path": "/business_entity/office_bearers/individuals/@id=='{{ob_id}}'/addresses",
    "value": [
      {
        "type": "HOME",
        "address_line_1": "Campus 611",
        "address_line_1": "300"
        "admin_area_2": "300",
        "postal_code": "12345",
        "country_code": "US"
      }
    ]
  }
]

Incorrect business name and beneficial owner name

Use case scenario: Update a merchant account with an incorrect business name and beneficial owner name.

Simulation code:

[
    {
        "op": "replace",
        "path": "/business_entity/names/@id=='S7S37669QZ2BN'",
        "value": {
            "business_name": "DECLINED",
            "type": "LEGAL"
        }
    },
    {
        "op":"replace",
         "path":"/business_entity/beneficial_owners/individuals/@id=='{{bo_id}}'/names",
         "value": [{
             "type": "LEGAL",
             "given_name": "Another DECLINED",
             "surname": "DECLINED"
          }]
     }
]

Incorrect beneficial owner address and primary authorized user information

Use case scenario: Update a merchant account with an incorrect beneficial owner address, incorrect primary authorized user information, and missing primary authorized user information.

Simulation code:

[
    {
        "op": "replace",
        "path": "/individual_owners/@id=='{{account_id}}'/names/@id=='HMWK8QBM8V5W'",
        "value": {
            "given_name": "James DECLINED",
            "surname": "Collins",
            "type": "LEGAL"
        }
    },
    {
        "op":"replace",
         "path":"/business_entity/beneficial_owners/individuals/@id=='{{bo_id}}'/names",
         "value": [{
             "type": "LEGAL",
             "given_name": "Another DECLINED",
             "surname": "DECLINED"
          }]
     }
]

Simulate limitations in sandbox

Use case scenario: Update a key value on the merchant account and trigger a re-verification failure. The system will apply a limitation after 30 days.

You don't have to wait 30 days to verify the limitation. Instead, you can complete the following steps to advance all the limitation counters on a merchant account:

When processed, the PATCH request advances the counter, but the email address is not stored and does not affect the account.

Simulation code:

Note: Do not combine the passage of time simulation with other operations in the same PATCH request. For example, you cannot add an email address and phone number in the same request.

[
    {
        "op": "add",
        "path": "/individual_owners/@id=='{id}'/emails/-",
        "value": {
            "email": "paypaltimetravel.30@paypal.com"
        }
    }
]

Next steps:

When you receive an account status updated webhook, complete a GET request to confirm that all transactions and withdrawals are blocked.