Skip Navigation
Log In Sign Up

Payment Method Object

·

The Payment Method object represents a source for collecting payments in the Tupel system. Payment methods are used to specify how repayments should be collected for loans and other financial transactions.

Attributes

  • uid string
    Unique identifier for the payment method.

  • entity object
    The Entity object representing the organization associated with this payment method.

  • type string
    The type of payment method. Maximum length: 4 characters. Possible values: SEPA, BACS, ACH, WIRE, CARD.

  • currency string
    Three-letter ISO currency code of the payment method which can be any of the accepted currency codes. Maximum length: 3 characters. Example: USD.

  • last4 string
    The last 4 digits of the account number. Default: empty string.

  • created_at timestamp
    Time at which the payment method was created.

  • updated_at timestamp
    Time at which the payment method was last updated.

Payment Method Types

Tupel supports the following payment method types:

  • SEPA - SEPA Direct Debit
  • BACS - BACS Direct Debit
  • ACH - ACH Direct Debit
  • WIRE - Wire Transfer
  • CARD - Credit Card

Security Features

For security, full account numbers are never exposed in the API. Instead:

  • The last4 field provides a masked reference to help identify the account
  • The payment method type and currency provide additional context

Payment Method Operations

The API provides several endpoints for managing payment methods:

  • Get a Specific Payment Method - Retrieve a single payment method by its UID
  • List All Payment Methods - Retrieve a paginated list of payment methods with filtering options

For detailed information about these operations, refer to the Payment Methods documentation.

Example Payment Method Object

{
  "uid": "2qP3o",
  "entity": {
    "uid": "7aB9cD",
    "name": "Acme Corporation",
    "jurisdiction": "US",
    "incorporated_at": "2018-05-12",
    "status": "ACTIVE",
    "type": "LTD",
    "registration_number": "US12345678",
    "tax_number": "987654321",
    "email": "finance@acmecorp.com",
    "created_at": "2023-01-15T14:32:17Z",
    "updated_at": "2023-01-15T14:32:17Z"
  },
  "type": "ACH",
  "currency": "USD",
  "last4": "3210",
  "created_at": "2023-01-22T11:45:36Z",
  "updated_at": "2023-01-22T11:45:36Z"
}

Using Payment Methods

Payment methods are primarily used when creating loans to specify how repayments should be collected:

{
  "entity": "7aB9cD",
  "currency": "USD",
  "principal": "50000.00",
  "pay_at": "2023-04-01T12:00:00Z",
  "due_at": "2023-10-01T23:59:59Z",
  "recipient": "3xY4z",
  "payment_method": "2qP3o"
}

When loan repayments are due, funds are collected from the specified payment method account.