Funding source schema

Property Type Description

id

string

method

string

You can pay for rewards using different payment methods on Tremendous:

Payment Method	Description
`balance`	Pre-funded balance in your Tremendous account to draw funds from to send rewards to recipients.
`bank_account`	Bank account to draw funds from to send rewards to recipients.
`credit_card`	Credit card to draw funds from to send rewards to recipients.
`invoice`	Send rewards to recipients and pay by invoice.

usage_permissions

array string

Indicates which actions this funding source can perform.

Permission	Description
`api_orders`	Usable for orders via API.
`dashboard_orders`	Usable for orders via Tremendous dashboard.
`balance_funding`	Usable to add funds to a balance (via dashboard or API).

status

string

Status of the funding_source

Status	Description
`active`	Ready for use.
`deleted`	Manually removed, and not usable.
`failed`	Last payment attempt failed, and not usable (contact Tremendous support to reinstate).

type

string

Only available when method is set to invoice.

meta

object

Show object properties

Property Type Description

available_amount

number double

Only exists for balance and commercial invoicing.

For balance: available amount denominated in currency_code.

For commercial invoicing: available credit amount denominated in currency_code, calculated as (credit limit - outstanding balance).

Caution: In the "list funding sources" endpoint this value is cached and may not be up to date. Use the "get funding source" endpoint to get the most up to date value.

available_cents

integer

Same as available_amount, but in cents.

currency_code

string

Only exists for balance and commercial invoicing.

The currency of the balance or credit amounts (e.g. available_amount, pending_amount, credit_limit_amount).

Always matches the organization's currency.

pending_amount

number double

Only available when method is set to balance.

Funds registered on your Tremendous account but not yet deposited in your account (e.g. payments that need to be manually reviewed by our ops team). Denominated in currency_code.

pending_cents

integer

Same as pending_amount, but in cents.

credit_limit_amount

number double

Only exists for commercial invoicing.

Available credit limit denominated in currency_code.

credit_limit_cents

integer

Same as credit_limit_amount, but in cents.

accountholder_name

string

Only available when method is set to bank_account or credit_card.

Name of the holder of the bank account or credit_card

account_type

string

Only available when method is set to bank_account.

Is this a checking or savings account

bank_name

string

Only available when method is set to bank_account.

Name of the bank

account_number_mask

string

Only available when method is set to bank_account.

Last 4 digits of the account number

account_routing_mask

string

Only available when method is set to bank_account.

Last 4 digits of the routing number

refundable

boolean

Only available when method is set to bank_account.

Can refunds be deposited to this bank account

network

string

Only available when method is set to credit_card.

Network of the credit card

last4

string

Only available when method is set to credit_card.

Last 4 digits of the credit card number

expired

boolean

Only available when method is set to credit_card.

Is this credit card expired

year

string

Only available when method is set to credit_card.

Year part of card's expiration date

month

string

Only available when method is set to credit_card.

Month part of card's expiration date

last_payment_failed_at

string date-time

Only available when method is set to bank_account or credit_card.

Point in time when the last order failed using this bank account or credit card as a funding source.

invoice_type

string

Only available when method is set to invoice.

Type of invoice account (e.g., commercial, pro_forma, prefunding_only)

interval

string

Only available when method is set to invoice and invoice_type is commercial.

Billing interval for commercial invoice generation (daily, weekly, monthly, twice_monthly, or quarterly). Returns null for pro forma invoices.

day_of_week

string

Deprecated: Use days_of_week instead.

Only available when method is set to invoice and invoice_type is commercial.

Day of the week when commercial invoices are generated ("0"=Sunday, "1"=Monday, etc.). Accounts with weekly commercial invoicing can have invoices generated on one or two days of the week. Returns the scheduled day when there is one day, and an empty string when there are two days and for non-weekly / pro forma invoices.

days_of_week

array string

Only available when method is set to invoice and invoice_type is commercial.

Days of the week when commercial invoices are generated ("0"=Sunday, "1"=Monday, etc.). Accounts with weekly commercial invoicing can have invoices generated on one or two days of the week. Returns an empty array for non-weekly and for pro forma invoices.

net

string

Only available when method is set to invoice.

Net payment terms in days (e.g., "30" for Net 30)

company_name

string

Only available when method is set to invoice.

Company name for invoice billing

address_1

string

Only available when method is set to invoice.

Primary billing address line

address_2

string

Only available when method is set to invoice.

Secondary billing address line

city

string

Only available when method is set to invoice.

Billing address city

state

string

Only available when method is set to invoice.

Billing address state or province

zip

string

Only available when method is set to invoice.

Billing address postal code

phone

string

Only available when method is set to invoice.

Contact phone number for billing

emails

string

Only available when method is set to invoice.

Email addresses for invoice delivery (comma-separated)

failure_details

object

Show object properties

Property	Type	Description
`return_code`	string	Payment error code
`description`	string	Explanation of the payment error