v1

latestOpenAPI 3.1.02026-07-202961265.4 KB
Transfer instruments

Update a transfer instrument

Updates a transfer instrument.

Requests to this endpoint are subject to rate limits:

  • Live environments: 700 requests per 5 seconds.

  • Test environments: 200 requests per 5 seconds.

  • Failed requests are subject to a limit of 5 failures per 10 seconds.

patch/transferInstruments/{id}

Path parameters

idstring required

The unique identifier of the transfer instrument.

Headers

x-requested-verification-codestring

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

legalEntityIdstring required

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

type'bankAccount' | 'recurringDetail' required

The type of transfer instrument.

Possible value: bankAccount.

Response

OK - the request has succeeded.

idstring required

The unique identifier of the transfer instrument.

legalEntityIdstring required

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

type'bankAccount' | 'recurringDetail' required

The type of transfer instrument.

Possible value: bankAccount.