Create a Recipient

Create a new payment recipient by sending a POST request to the recipients endpoint.

Request

POST https://tupel.com/api/recipients/

Authentication

This endpoint requires basic authentication with your Organization ID and API Key.

Request Body Parameters

• entity string Required
  The UID of the entity associated with this recipient. Maximum length: 12 characters.

• currency string Required
  Three-letter ISO currency code. Supported values: USD, EUR, GBP, or other accepted currency codes.

• recipient_type string Required
  The type of recipient. Possible values: BUSINESS, PRIVATE.

• is_owned boolean Required
  Whether the recipient account is owned by the same entity.

• email string Required
  Contact email for the recipient. Must be a valid email format.

• owner string Required
  The name of the account owner. Maximum length: 100 characters.

• account_number string Required
  The recipient's account number. Maximum length: 45 characters. Format depends on currency and country.

• bank_code string Optional
  Bank identifier code. Maximum length: 15 characters. Default: empty string. For USD, this is the routing number; for GBP it's the sort code and for EUR it's not required.

• branch_code string Optional
  Branch identifier code. Maximum length: 15 characters. Default: empty string.

• type string Optional
  The account type. Possible values: CHECKING, SAVINGS, CURRENT. Default: CHECKING.

Currency-Specific Requirements

Different currencies have different validation requirements:

USD (United States Dollar)

• Bank code (routing number): 9 digits
• Account number: 4-17 digits
• Account type: Required (CHECKING or SAVINGS)

EUR (Euro)

• Account number: IBAN format (varies by country, typically 14-34 characters)
• Bank code: Not required when using IBAN

GBP (British Pound)

• Bank code (sort code): 6 digits
• Account number: 8 digits

For detailed validation rules or for currencies not listed above, see the Recipient Validation documentation.

Notes

• Before creating a recipient, it's recommended to check the validation rules for the specific currency.
• Recipients must be created before they can be used in loan creation.
• The entity must exist and be in ACTIVE status to create a recipient.
• The is_owned field indicates whether the account belongs to the entity itself or to a third party.
• Some financial institutions may require additional verification before payments can be sent to a newly created recipient.