Payment Object

The Payment object represents a financial transaction in the Tupel system. Payments can be disbursements (sending funds to recipients) or repayments (collecting funds against loans).

Attributes

• uid string
  Unique identifier for the payment.

• type string
  The type of payment. Maximum length: 6 characters. Possible values: DEBIT (money sent out), CREDIT (money collected).

• method string
  The payment method used. Maximum length: 16 characters. Possible values: SEPA, BACS, ACH, WIRE, BECS, PAD, AUTOGIRO, BETALINGSSERVICE.

• status string
  Current status of the payment. Maximum length: 7 characters. Possible values: PENDING, SETTLED, FAILED.

• reason string
  The reason for the payment. Maximum length: 9 characters. Possible values: FEE, PRINCIPAL.

• provider string
  The payment service provider. Possible values: STRIPE, WISE.

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

• amount decimal
  The amount of the payment in the specified currency.

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

• normalized_amount decimal
  The amount of the payment converted to the normalized currency.

• paid_at timestamp
  Time at which the payment was initiated.

• delivered_at nullable timestamp
  Time at which the payment was delivered to the recipient (if applicable).

• failed_at nullable timestamp
  Time at which the payment failed (if applicable).

• created_at timestamp
  Time at which the payment was created in the system.

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

• attachments array of objects
  List of Attachment objects with supporting documentation for this payment.

• fx_rate object
  Foreign exchange rate information for currency conversions. Contains:

• source_currency string - Original currency code.
• target_currency string - Target currency code.
• bid decimal - The bid rate.
• ask decimal - The ask rate.
• mid decimal - The mid-market rate.
• timestamp timestamp - Time when the rate was captured.

Payment Status

Payments can have the following statuses:

• PENDING - The payment has been initiated but not yet settled
• SETTLED - The payment has been successfully completed
• FAILED - The payment failed to process

Payment Types

Payments have several classification attributes:

Transaction Types

• DEBIT - Money sent out (disbursement)
• CREDIT - Money collected (repayment)

Payment Methods

• 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
• BECS - BECS Direct Debit for AU and NZ payments
• PAD - Pre-Authorized Debit for Canadian payments
• AUTOGIRO - Autogiro for Swedish payments
• BETALINGSSERVICE - Betalingsservice for Danish payments

Payment Reasons

• FEE - Payment related to fees
• PRINCIPAL - Payment related to loan principal

Payment Providers

• STRIPE - Payments processed via Stripe
• WISE - Payments processed via Wise
• GOCARDLESS - Payments processed via GoCardless

Currency Handling

Payments in Tupel can involve multiple currencies. When a payment is made in a currency different from your normalized reporting currency:

1. The original amount is stored in amount with its currency
2. The converted amount is stored in normalized_amount with its normalized_currency
3. The exchange rate details are provided in the fx_rate object

Payment Operations

The API provides several endpoints for managing payments:

• Get a Specific Payment - Retrieve a single payment by its UID
• List All Payments - Retrieve a paginated list of payments with filtering options

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