Request a New Transfer

This endpoint is used only for requesting an outgoing (withdrawal) wire transfer at this moment. For the wire transfer, you need to create a bank resource first using the Bank API. For more on how to fund an account in sandbox see the Transfer simulation API.

Path Params
uuid
required
Body Params

Request body for initiating an outgoing wire withdrawal from an account.

string | null

Additional details for when type = wire

string
required

Must be > 0.00

uuid

Required if type = wire

The bank_relationship created for the account_id

string
enum
required
  • INCOMING
    Funds incoming to user's account (deposit).
  • OUTGOING
    Funds outgoing from user's account (withdrawal).
Allowed:
string

Only outgoing wire fees are currently supported for automated processing.

  • user The end user will pay any applicable fees
  • invoice Any applicable fees will be billed to the client in the following monthly invoice
ira
object

This field is used for IRA Account only

uuid

Required if type = ach

The ach_relationship created for the account_id

string
enum
deprecated

Deprecated. Not honored by the API; values sent are silently ignored and this field will be removed.

Allowed:
string
enum
required

Only wire is currently supported.

Allowed:
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json