# AddBankAccount API Operation (/api/nvp-soap/add-bank-account)



> **Note:** **Important:** The Adaptive Platform API is not available for new integrations. PayPal provides this documentation to support existing integrations. If you're starting an integration, [we recommend our latest solutions](/).

Sets up bank accounts as funding sources for PayPal accounts.

## AddBankAccount Request [#addbankaccount-request]

### AddBankAccount Request Fields [#addbankaccount-request-fields]

| Field                            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountHolderDateofBirth`<br /> | `xs:date`<br /&#x3E; &#x2A;(Optional)* The date of birth of the account holder in YYYY-MM-DDZ format, for example 1970-01-01Z.<br />                                                                                                                                                                                                                                                                                                                                                       |
| `accountId`<br />                | `xs:string`<br /&#x3E; &#x2A;(Optional)* The identification number of the PayPal account for which a bank account is added. You must specify either the `accountId` or `emailAddress` for this request.<br />                                                                                                                                                                                                                                                                              |
| `agencyNumber`<br />             | `xs:string`<br /&#x3E; &#x2A;(Optional)* For the Brazil Agency Number.<br />                                                                                                                                                                                                                                                                                                                                                                                                               |
| `bankAccountNumber`<br />        | `xs:string`<br /&#x3E; &#x2A;(Optional)* The account number (BBAN) of the bank account to be added.<br />                                                                                                                                                                                                                                                                                                                                                                                  |
| `bankAccountType`<br />          | `aa:BankAccountType`<br /> The type of bank account to be added. Allowable values are:<br /> <br />`CHECKING`<br />`SAVINGS`<br />`BUSINESS_SAVINGS`<br />`BUSINESS_CHECKINGS`<br />`NORMAL`<br />`UNKNOWN`<br />                                                                                                                                                                                                                                                                          |
| `bankCode`<br />                 | `xs:string`<br /&#x3E; &#x2A;(Optional)* The code that identifies the bank where the account is held.<br />                                                                                                                                                                                                                                                                                                                                                                                |
| `bankCountryCode`<br />          | `xs:string`<br /&#x3E; &#x2A;(Required)* The country code. See [Country Codes](/api/nvp-soap/country-codes/) for allowed values.<br />                                                                                                                                                                                                                                                                                                                                                     |
| `bankName`<br />                 | `xs:string`<br /&#x3E; &#x2A;(Optional)* The default value is UNKNOWN.<br />                                                                                                                                                                                                                                                                                                                                                                                                               |
| `bankTransitNumber`<br />        | `xs:string`<br /&#x3E; &#x2A;(Optional)* The transit number of the bank.<br />                                                                                                                                                                                                                                                                                                                                                                                                             |
| `branchCode`<br />               | `xs:string`<br /&#x3E; &#x2A;(Optional)* The branch code for the bank.<br />                                                                                                                                                                                                                                                                                                                                                                                                               |
| `branchLocation`<br />           | `xs:string`<br /&#x3E; &#x2A;(Optional)* The branch location.<br />                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `bsbNumber`<br />                | `xs:string`<br /&#x3E; &#x2A;(Optional)* The Bank/State/Branch number for the bank.<br />                                                                                                                                                                                                                                                                                                                                                                                                  |
| `clabe`<br />                    | `xs:string`<br /> CLABE represents the bank information for countries like Mexico.<br />                                                                                                                                                                                                                                                                                                                                                                                                   |
| `confirmationType`<br />         | `aa:ConfirmationType`<br /> (Required) Whether PayPal account holders are redirected to PayPal.com to confirm the payment card addition. When you pass NONE for this element, the addition is made without the account holder's explicit confirmation. If you pass WEB, a URL is returned.<br /> Allowable string values are:<br /> <br />WEB<br />NONE<br /> > **Note:** &#x2A;*Note:** `ConfirmationType` NONE requires advanced permission levels. You must pass the createAccount key. |
| `controlDigit`<br />             | `xs:string`<br /&#x3E; &#x2A;(Optional)* The control digits for the bank.<br />                                                                                                                                                                                                                                                                                                                                                                                                            |
| `emailAddress`<br />             | `xs:string`<br /&#x3E; &#x2A;(Optional)* The email address for the PayPal account. You must specify either the `accountId` or `emailAddress` for this request.<br />                                                                                                                                                                                                                                                                                                                       |
| `iban`<br />                     | `xs:string`<br /&#x3E; &#x2A;(Optional)* The IBAN for the bank.<br />                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `institionNumber`<br />          | `xs:string`<br /&#x3E; &#x2A;(Optional)* The institution number for the bank.<br />                                                                                                                                                                                                                                                                                                                                                                                                        |
| `partnerInfo`<br />              | `xs:string`<br /&#x3E; &#x2A;(Optional)* The partner information for the bank.<br />                                                                                                                                                                                                                                                                                                                                                                                                       |
| `requestEnvelope`<br />          | `common:RequestEnvelope`<br /&#x3E; &#x2A;(Required)* Information common to each API operation, such as the language in which an error message is returned.<br />                                                                                                                                                                                                                                                                                                                          |
| `ribkey`<br />                   | `xs:string`<br /&#x3E; &#x2A;(Optional)* The RIB key for the bank.<br />                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `routingNumber`<br />            | `xs:string`<br /&#x3E; &#x2A;(Optional)* The bank's routing number.<br />                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `sortCode`<br />                 | `xs:string`<br /&#x3E; &#x2A;(Optional)* The branch sort code.<br />                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `taxIdType`<br />                | `xs:string`<br /&#x3E; &#x2A;(Optional)* Tax id type of CNPJ or CPF, only supported for Brazil.<br />                                                                                                                                                                                                                                                                                                                                                                                      |
| `taxIdNumber`<br />              | `xs:string`<br /&#x3E; &#x2A;(Optional)* Tax id number for Brazil.<br />                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `webOptionsType`<br />           | `aa:WebOptionsType`<br /&#x3E; &#x2A;(Optional)* Additional structure to define the URLs for the cancellation and return web flows.<br />                                                                                                                                                                                                                                                                                                                                                  |

### WebOptionsType Fields [#weboptionstype-fields]

| Field                        | Description                                                                                                                                               |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cancelUrl`<br />            | `xs:string`<br /&#x3E; &#x2A;(Optional)* The URL to which bank account/payment card holders return when they cancel the bank account addition flow.<br /> |
| `cancelUrlDescription`<br /> | `xs:string`<br /&#x3E; &#x2A;(Optional)* A description of the cancellation URL.<br />                                                                     |
| `returnUrl`<br />            | `xs:string`<br /&#x3E; &#x2A;(Optional)* The URL to which bank account/payment card holders return after they add the account or payment card.<br />      |
| `returnUrlDescription`<br /> | `xs:string`<br /&#x3E; &#x2A;(Optional)* A description of the return URL.<br />                                                                           |

### RequestEnvelope Fields [#requestenvelope-fields]

| Field                 | Description<br />                                                                                                                                                                                                                  |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `detailLevel`<br />   | `common:DetailLevelCode`<br /> The level of detail required by the client application for component such as Item, Transaction. Value is:<br /> <br />`ReturnAll` — This value provides the maximum level of detail (default)<br /> |
| `errorLanguage`<br /> | `xs:string`<br /> The RFC 3066 language in which error messages are returned; by default it is `en_US`, which is the only language currently supported<br />                                                                       |

## AddBankAccount Response [#addbankaccount-response]

### AddBankAccount Response Fields [#addbankaccount-response-fields]

| Field                    | Definition                                                                                                                                     |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `execStatus`<br />       | `xs:string`<br /> Execution status for the request. Value is:<br /> <br />`COMPLETED`<br />`CREATED`<br />`CREATED PENDING VERIFICATION`<br /> |
| `fundingSourceKey`<br /> | `xs:string`<br /> The key for the funding source to use in subsequent Adaptive Accounts API request messages.<br />                            |
| `redirectURL`<br />      | `xs:string`<br /> The URL to direct the PayPal account holder to redirection after the Add Bank Account web flow is completed.<br />           |
| `responseEnvelope`<br /> | `common:ResponseEnvelope`<br /> Common response information, including a timestamp and the response acknowledgment status.<br />               |

### ResponseEnvelope Fields [#responseenvelope-fields]

| Field                 | Description                                                                                                                                                                                                                                                                                                                                           |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ack`<br />           | `common:AckCode`<br /> Acknowledgment code. Value is:<br /> <br />`Success` — Operation completed successfully<br />`Failure` — Operation failed<br />`Warning` — warning<br />`SuccessWithWarning` — Operation completed successfully; however, there is a warning message<br />`FailureWithWarning` — Operation failed with a warning message<br /> |
| `build`<br />         | Build number; used only by Merchant Technical Support.<br />                                                                                                                                                                                                                                                                                          |
| `correlationId`<br /> | Correlation ID; used only by Merchant Technical Support.<br />                                                                                                                                                                                                                                                                                        |
| `timestamp`<br />     | The date on which the response was sent. The time is not supported.<br />                                                                                                                                                                                                                                                                             |

## AddBankAccount Errors [#addbankaccount-errors]

| Variable     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |   |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - |
| 500000<br /> | Framework failure. Retry.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |   |
| 520002<br /> | Internal error                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |   |
| 520003<br /> | Invalid credentials.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |   |
| 550001<br /> | User is not allowed to perform this action                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |   |
| 560022<br /> | Invalid header.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |   |
| 560029       | The required \<name> header is missing from the HTTP request                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |   |
| 580001       | Invalid request:<br /> <br />PA\_Invalid\_Currency<br />Maximum attempts of Random deposits reached<br />Invalid request parameter: bankAccountType<br />Invalid request parameter: accountNumber<br />Unsupported countryCode<br />Invalid request parameter: countryCode<br />Invalid input<br />Invalid request parameter: dateOfBirth<br />Missing required request parameter: countryCode<br />There are maximum number of bank accounts<br />The bank account is already associated with another PayPal account<br />Bank account is already a part of the end user PayPal account<br />AddBankAccount has been rejected<br />Invalid bank account information<br />More than one inactive bank account matches the routing number and the account number<br />Invalid beneficiary ID<br />PayPal account specified in the request is locked<br />PayPal account specified in the request is closed<br />Operation is not supported: PA\_Replaceable\_Value<br />Invalid request: PA\_Replaceable\_Value<br /> |   |
| 580022<br /> | Request parameter is invalid:<br /> <br />Invalid request parameter: PA\_Replaceable\_Value<br />Expired createAccountKey<br />Invalid request parameter: ipAddressExpired createAccountKey<br />Invalid request parameter: createAccountKey<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |   |
| 580023<br /> | The argument is inconsistent with the rest of the request.<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |   |