create_internal_beneficiary
Create a new internal TropiPay beneficiary by providing an alias and email. Use this tool to register a recipient for payments within TropiPay using the required fields.
Instructions
Create a new internal TropiPay beneficiary using TropiPay API.
Required: alias, searchValue (email)
Example:
{
"alias": "MR Buchman",
"searchValue": "wick@gmail.com",
"searchBy": 1
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Auto-set to 9 (Tropipay account). | |
| alias | Yes | Friendly name. REQUIRED. Ex: 'MR Buchman'. | |
| No | Email. Optional if in searchValue. | ||
| state | No | Status (0=Active, 1=Inactive, 2=Deleted). Default: 0. | |
| currency | No | Currency code. Optional. | |
| lastName | No | Last name. Optional. | |
| searchBy | No | Search criteria (1=email). Default: 1. | |
| firstName | No | First name. Optional. | |
| paymentType | No | Auto-set. | |
| searchValue | Yes | Email to search for. REQUIRED. Ex: 'wick@gmail.com'. | |
| accountNumber | No | User email. Optional if searchValue provided. | |
| secondLastName | No | Second last name. Optional. | |
| beneficiaryType | No | Auto-set to 1 (Internal/TropiPay). | |
| userRelationTypeId | No | Relation type (0=myself, 3=commercial). Default: 3. | |
| beneficiaryPersonType | No | Person type (1=individual). Optional. |