PATCH /transferInstruments/{id}

Updates a transfer instrument.

Servers

Path parameters

Name Type Required Description
id String Yes

The unique identifier of the transfer instrument.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

x-requested-verification-code String No

Use the requested verification code 0_0001 to resolve any suberrors associated with the transfer instrument. Requested verification codes can only be used in your test environment.

Request body fields

Name Type Required Description
bankAccount Object Yes

Contains information about the legal entity's bank account.

bankAccount.bankName String No

The name of the banking institution where the bank account is held.

bankAccount.accountType String No

The type of bank account.

bankAccount.trustedSource Boolean No

Identifies if the bank account was created through instant bank verification.

bankAccount.countryCode String No

The two-character ISO 3166-1 alpha-2 country code where the bank account is registered. For example, NL.

bankAccount.accountIdentification Object No

Identification of the bank account.

type String Yes

The type of transfer instrument.

Possible value: bankAccount.

Possible values:

  • "bankAccount"
  • "recurringDetail"
legalEntityId String Yes

The unique identifier of the legal entity that owns the transfer instrument.

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.