POST /v1/test_helpers/treasury/inbound_transfers/{id}/fail

Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

Servers

Path parameters

Name Type Required Description
id String Yes

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
failure_details Object No

Details about a failed InboundTransfer.

failure_details.code String No

Possible values:

  • "account_closed"
  • "incorrect_account_holder_name"
  • "other"
  • "no_account"
  • "bank_account_restricted"
  • "incorrect_account_holder_tax_id"
  • "incorrect_account_holder_address"
  • "invalid_account_number"
  • "debit_not_authorized"
  • "insufficient_funds"
  • "bank_ownership_changed"
  • "invalid_currency"
  • "account_frozen"
expand[] Array No

Specifies which fields in the response should be expanded.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.