create_external_beneficiary
Create a new external bank account beneficiary for TropiPay. Provide name, account number, currency, and country to enable international transfers.
Instructions
Create a new external bank account beneficiary using TropiPay API.
Required: firstName, lastName, accountNumber, currency, countryDestinationId/countryISO
Example:
{
"firstName": "Panfilo",
"lastName": "Epifanio",
"accountNumber": "ES91 2100 0418 4502 0005 1332",
"currency": "EUR",
"countryDestinationId": 1,
"swift": "CAIXESBBXXX",
"address": "Gran Via de les Corts Catalanes, 765",
"city": "Barcelona",
"province": "Barcelona",
"postalCode": "08013"
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | No | City name. Recommended for international transfers. | |
| type | No | Auto-set to 7 (External account). | |
| alias | No | Friendly name. Optional. | |
| No | Email. Optional. | ||
| phone | No | Phone number. Format: '+343487879879'. | |
| state | No | Status (0=Active, 1=Inactive, 2=Deleted). Default: 0. | |
| swift | No | SWIFT/BIC code. Recommended for international transfers. | |
| address | No | Address. REQUIRED when userRelationTypeId ≠ 0. | |
| currency | Yes | Currency code. REQUIRED. | |
| lastName | Yes | Last name. REQUIRED. | |
| province | No | Province/State. Recommended for international transfers. | |
| searchBy | No | Search criteria type. Optional. | |
| firstName | Yes | First name. REQUIRED. | |
| countryISO | No | Country ISO code. REQUIRED if countryDestinationId not provided. | |
| postalCode | No | Postal/ZIP code. REQUIRED when userRelationTypeId ≠ 0. | |
| paymentType | No | Auto-set to 2 (Bank Deposit). | |
| searchValue | No | Search value. Optional. | |
| accountNumber | Yes | IBAN or account number. REQUIRED. | |
| correspondent | No | Correspondent bank info. Optional for international transfers. | |
| routingNumber | No | Bank routing number. REQUIRED for US accounts. | |
| secondLastName | No | Second last name. Optional. | |
| beneficiaryType | No | Auto-set to 2 (External). | |
| userRelationTypeId | No | Relation type (0=myself, 3=commercial). Default: 3. | |
| countryDestinationId | No | Country ID. REQUIRED if countryISO not provided. | |
| beneficiaryPersonType | No | Person type (1=individual). Optional. | |
| documentExpirationDate | No | Document expiration date. Optional. |