Retrieve a ReceivedCredit
GET / v1 / treasury / received_credits /:id
Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
Parameters
No parameters.
Returns
Returns a ReceivedCredit object.
Response
List all ReceivedCredits
GET / v1 / treasury / received_credits
Returns a list of ReceivedCredits.
Parameters
- financial _ account string The FinancialAccount that received the funds.
- linked _ flows object Only return ReceivedCredits described by the flow.
- status enum Only return ReceivedCredits that have the given status:
succeededorfailed. Possible enum valuesfailedThe ReceivedCredit was declined, and no Transaction was created.succeededThe ReceivedCredit 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 ReceivedCredits, starting after ReceivedCredit starting_after. Each entry in the array is a separate ReceivedCredit object. If no more ReceivedCredits are available, the resulting array will be empty.
Response
Test mode: Create a ReceivedCredit Test helper
POST / v1 / test_helpers / treasury / received_credits
Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits 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 send funds to.
- 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 ReceivedCredit object.
Response