API Reference
Log In
API Reference

Update Bank

Introduction

This endpoint allows you to update the preferred settlement speed for an external contact’s specific bank account. If the external contact will receive a payment to this account, and fees are configured to be borne by the recipient, the recipient will be charged according to their selected settlement speed.

Data Requirements

Provide the following data requirements when sending a PUT request to the Update Bank endpoint.

The body of the request should contain the following properties for the values you wish to update:

Parameter Required? Description Type
bankAccountId Yes The unique identifier of the bank account associated with the external contact. This ID is used to specify which bank account the preferred settlement speed update should apply to. String
settlementSpeed Yes Specifies the preferred speed at which the payment should be settled to the external contact’s bank account. This value determines how quickly funds are transferred when the recipient is responsible for any associated fees. String

The url of this request should contain the following path parameter:

Parameter Required? Description Type
handle Yes Account @handle of the external contact without the “@” symbol. Special characters must be URL-encoded before using in the endpoint URL (e.g., ^example => %5Eexample). Read more about borderless™ @handles. String
Language
Credentials
Bearer
JWT
URL
Click Try It! to start a request and see the response here!