Sign in

v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Collect Account Details

Send an email requesting account details.

post/counterparties/{id}/collect_account

Path parameters

idstring required

The id of the counterparty

Request body

directionstring 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_emailboolean

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.

fieldsstring[]

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.

custom_redirectstring

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

200

idstring
is_resendboolean
form_linkstring

Example response

{
  "id": "928db55e-6552-4aaf-96d7-10c693922b1f",
  "form_link": "https://app.moderntreasury.com/public/counterparties/f6a4feae-3c66-46d1-80f4-ca10efdf6gec/account_details?token=NBa9B7HVNRFTa2ocaXFq46FqmFLuGm19w5BiRB5zgikkw5mjrRkBx5f9JprgixUh"
}