Skip Navigation
Log In Sign Up

Payment Methods

·

The Payment Methods API allows you to manage payment sources within the Tupel platform. Payment methods represent bank accounts and other financial sources from which loan repayments can be collected.

What is a Payment Method?

In Tupel, a payment method represents a financial account associated with an entity that can be used for collecting payments. Each payment method includes:

  • The type of payment source (e.g., bank account)
  • Currency information
  • Partial account information for identification
  • Entity relationship details

Payment Method Types

Tupel supports the following payment method types:

  • SEPA - SEPA Direct Debit for European payments
  • BACS - BACS Direct Debit for UK payments
  • ACH - ACH Direct Debit for US payments
  • WIRE - Wire Transfer for international payments
  • CARD - Credit Card payments

Payment Method Relationships

Payment methods are linked to other resources in Tupel:

  • Entities: Each payment method is associated with an entity
  • Loans: When creating a loan, a payment method is specified for collecting repayments

Available Endpoints

Endpoint Description
Retrieve a Payment Method Get details about a specific payment method
List All Payment Methods Get a paginated list of payment methods with filtering options

Security Considerations

Payment methods contain sensitive financial information. Tupel employs several security measures:

  • Full account numbers are never exposed through the API
  • Only the last 4 digits (last4) are provided for identification
  • All requests must be authenticated and authorized
  • Only payment methods belonging to your organization are accessible

Best Practices

  • Verify payment method details before creating loans
  • Store the payment method UID in your system for future reference
  • Use filtering to efficiently find payment methods that match specific criteria
  • Ensure the payment method currency matches the loan currency
  • For recurring operations, cache payment method information but periodically refresh it
  • Entities - Organizations associated with payment methods
  • Loans - Financial products that specify payment methods for repayment
  • Payments - Transactions that use payment methods as sources

Common Use Cases

Finding Payment Methods for Loan Creation

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

Currency-Specific Payment Methods

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

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

Verifying Payment Method Details

Before creating a loan, verify the payment method details:

# Retrieve a specific payment method
curl -X GET "https://tupel.com/api/methods/2qP3o/" \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>