Skip Navigation
Log In Sign Up

Loans

·

The Loans API allows you to create and manage loans through the Tupel platform. Use these endpoints to establish credit facilities, disburse funds, track payments, and monitor loan statuses.

The Loan Lifecycle

A typical loan in Tupel follows this lifecycle:

  1. Creation: A loan is created with specific terms, a designated recipient, and a payment method
  2. Disbursement: Funds are transferred to the recipient on the specified pay date
  3. Repayments: Payments are collected according to the installment schedule
  4. Closure: The loan is marked as closed when fully repaid

Loan Status

Loans can have the following statuses:

  • PENDING - The loan has been created but funds have not yet been disbursed
  • OPEN - The loan is active with an outstanding balance
  • OVERDUE - Payments are past their due date
  • CLOSED - The loan has been fully repaid

Key Concepts

  • Entity: The organization (borrower) associated with the loan
  • Recipient: The bank account where loan funds are disbursed
  • Payment Method: The method used to collect repayments
  • Installments: Payment installments with specific due dates
  • Attachments: Supporting documentation associated with the loan

Available Endpoints

Endpoint Description
Create a Loan Create a new loan with specific terms
Retrieve a Loan Get details about a specific loan
List All Loans Get a paginated list of loans with filtering options
Repay a Loan Repay (part of) the outstanding loan balance before schedule

Best Practices

  • Create an entity, recipient and payment method before attempting to create loans
  • Use meaningful reference strings to help identify loans in your system
  • Regularly poll the status of active loans to sync with your internal systems
  • Store the loan UID in your system for future reference
  • Use appropriate filtering when listing loans to improve performance

Common Use Cases

Extending Credit to Customers

curl -X POST https://tupel.com/api/loans/ \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY> \
  -H "Content-Type: application/json" \
  -d '{
    "entity": "7aB9cD",
    "currency": "USD",
    "principal": "10000.00",
    "pay_at": "2023-04-01T12:00:00Z",
    "due_at": "2023-10-01T23:59:59Z",
    "recipient": "3xY4zW",
    "payment_method": "2qP3oN"
  }'

Setting Up Installment Plans

For loans with multiple payments, specify the installments parameter:

curl -X POST https://tupel.com/api/loans/ \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY> \
  -H "Content-Type: application/json" \
  -d '{
    "entity": "7aB9cD",
    "currency": "USD",
    "principal": "50000.00",
    "pay_at": "2023-04-01T12:00:00Z",
    "due_at": "2023-10-01T23:59:59Z",
    "recipient": "3xY4zW",
    "payment_method": "2qP3oN",
    "installments": 4
  }'

Monitoring Loan Status and Repayments

Regularly check loan details to track payment status:

curl -X GET https://tupel.com/api/loans/9hK7jL6m/ \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>