Collect Account Details

post

https://app.moderntreasury.com/api/counterparties/{id}/collect_account

Send an email requesting account details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The id of the counterparty

Body Params

direction

string

required

One of credit or debit. Use credit when you want to pay a counterparty. Use debit when you need to charge a counterparty. This field helps us send a more tailored email to your counterparties.

send_email

boolean

Defaults to true

By default, Modern Treasury will send an email to your counterparty that includes a link to the form they must fill out. However, if you would like to send the counterparty the link, you can set this parameter to false. The JSON body will include the link to the secure Modern Treasury form.

fields

array of strings

The list of fields you want on the form. This field is optional and if it is not set, will default to ["nameOnAccount", "accountType", "accountNumber", "routingNumber", "address"]. The full list of supported options is [ "name", "nameOnAccount", "taxpayerIdentifier", "accountType", "accountNumber", "ibanNumber", "clabeNumber", "walletAddress", "panNumber", "routingNumber", "abaWireRoutingNumber", "swiftCode", "auBsb", "caCpa", "cnaps", "gbSortCode", "inIfsc", "myBranchCode", "brCodigo", "routingNumberType", "address", "jpZenginCode", "seBankgiroClearingCode", "nzNationalClearingCode", "hkInterbankClearingCode", "huInterbankClearingCode", "dkInterbankClearingCode", "idSknbiCode" ]. Field names must be camel-cased.

fields

custom_redirect

string

The URL you want your customer to visit upon filling out the form. By default, they will be sent to a Modern Treasury landing page. This must be a valid HTTPS URL if set.

Response

200200