List all ReceivedDebits
GET / v1 / treasury / received_debits
Returns a list of ReceivedDebits.
Parameters
- financial _ account string The FinancialAccount that funds were pulled from.
- status enum Only return ReceivedDebits that have the given status:
succeededorfailed. Possible enum valuesfailedThe ReceivedDebit was declined, and no Transaction was created.succeededThe ReceivedDebit was approved.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit ReceivedDebits, starting after ReceivedDebit starting_after. Each entry in the array is a separate ReceivedDebit object. If no more ReceivedDebits are available, the resulting array will be empty.
Response
Test mode: Create a ReceivedDebit Test helper
POST / v1 / test_helpers / treasury / received_debits
Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.
Parameters
- amount integer Required Amount (in cents) to be transferred.
- currency enum Required Three-letter ISO currency code, in lowercase. Must be a supported currency.
- financial _ account string Required The FinancialAccount to pull funds from.
- network enum Required Specifies the network rails to be used. If not set, will default to the PaymentMethod’s preferred network. See the docs to learn more about money movement timelines for each network type.
- description string An arbitrary string attached to the object. Often useful for displaying to users.
- initiating _ payment _ method _ details object Initiating payment method details for the object.
Returns
A test mode ReceivedDebit object.
Response