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.
Servers
- https://api.stripe.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
network |
String | Yes |
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. Possible values:
|
description |
String | No |
An arbitrary string attached to the object. Often useful for displaying to users. |
amount |
Integer | Yes |
Amount (in cents) to be transferred. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
financial_account |
String | Yes |
The FinancialAccount to send funds to. |
currency |
String | Yes |
Three-letter ISO currency code, in lowercase. Must be a supported currency. |
initiating_payment_method_details |
Object | No |
Initiating payment method details for the object. |
initiating_payment_method_details.type |
String | Yes |
Possible values:
|
initiating_payment_method_details.us_bank_account |
Object | No | |
initiating_payment_method_details.us_bank_account.routing_number |
String | No | |
initiating_payment_method_details.us_bank_account.account_number |
String | No | |
initiating_payment_method_details.us_bank_account.account_holder_name |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.