Skip Navigation
Log In Sign Up

Recipients

·

The Recipients API allows you to manage payment destinations within the Tupel platform. Recipients represent bank accounts and other financial destinations where loan funds can be disbursed or payments can be sent.

What is a Recipient?

In Tupel, a recipient represents a payment destination associated with an entity. Each recipient includes:

  • Banking details (account number, bank codes)
  • Ownership information
  • Currency and account type details
  • Contact information

Recipient Types

Recipients can be categorized as:

  • BUSINESS - A business account
  • PRIVATE - A personal/private account

Account Types

Tupel supports the following account types:

  • CHECKING - Checking account (primarily used in the US)
  • SAVINGS - Savings account
  • CURRENT - Current account (primarily used in the UK and Europe)

Recipient Relationships

Recipients are linked to other resources in Tupel:

  • Entities: Each recipient is associated with an entity
  • Loans: When creating a loan, a recipient is specified as the disbursement destination

Available Endpoints

Endpoint Description
Create a Recipient Create a recipient
Retrieve a Recipient Get details about a specific recipient
List All Recipients Get a paginated list of recipients with filtering options
Recipient Validation Get the specific recipient validation rules across currencies

Best Practices

  • Validate recipient details before initiating transactions
  • Store the recipient UID in your system for future reference
  • Use filtering to efficiently find recipients that match specific criteria
  • Regularly verify that recipient information is up-to-date
  • For recurring transactions, cache recipient information but periodically refresh it
  • Entities - Organizations associated with recipients
  • Loans - Financial products that specify recipients for disbursement
  • Payments - Transactions that use recipients as destinations

Common Use Cases

Finding Recipients for Loan Disbursement

# List all recipients for a specific entity
curl -X GET "https://tupel.com/api/recipients/?entity=ent_7aB9cD2eF4gH6iJ" \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Currency-Specific Recipients

When creating a loan in a specific currency, you'll need to find recipients that support that currency:

# Find all EUR recipients
curl -X GET "https://tupel.com/api/recipients/?currency=EUR" \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Verifying Recipient Details

Before initiating a transaction, verify the recipient details:

# Retrieve a specific recipient
curl -X GET "https://tupel.com/api/recipients/rcpt_3xY4zW5vU6tS7rQ/" \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>