Talent

Update a Talent Direct Deposit Account

Updates information about the specified talent direct deposit account.

patch/v1/talent/{talentId}/direct-deposit-accounts/{id}

Request

Base URL
https://api.avionte.com/front-office
URL
https://api.avionte.com/front-office/v1/talent/{talentId}/direct-deposit-accounts/{id}
Auth
- API key in header x-api-key
- or HTTP bearer

Path parameters

talentIdstring required

The identifier for the talent whose direct deposit account is being updated.

idstring required

The identifier for the direct deposit account that is to be updated.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

bankNamestring nullable

The name of the financial institution.

accountTypestring nullable

The type of direct deposit account.

amountTypestring nullable

The calculation used to determine the amount for the direct deposit account.

amountnumber nullable

The amount allocated to the direct deposit account.

routingNumberstring nullable

The routing number for the direct deposit account.

accountNumberstring nullable

The account number for the direct deposit account.

accountOrderinteger nullable

The order in which deposits are made to the talent's accounts. Should be a unique integer within the list of a talent's bank accounts.

isArchivedboolean nullable

An indication of whether the account should be archived. Set to true to archive the account or false to restore it.

institutionNumberstring nullable

The identifier for a financial institution, business, or company. Required to be exactly 3 digits when accountCountry is Canada.

accountCountrystring nullable

The country in which the bank operates.

isActivatedboolean nullable

An indication of whether the account is active. Maps to PayCard active status.

proxyNumberstring nullable

The proxy number for PayCard accounts.

fundingTypestring nullable

The funding type for the account. Applicable to PayCard accounts.

prenoteSentDatestring date-time nullable

The date the prenotification was sent to the bank. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.

prenoteApproveDatestring date-time nullable

The date the prenotification was approved. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.

Example request

{
  "bankName": "First National Bank",
  "accountType": "Checking",
  "amountType": "Percent",
  "amount": 75,
  "routingNumber": "291070001",
  "accountNumber": "234544111",
  "accountOrder": 1,
  "institutionNumber": "001",
  "accountCountry": "Canada",
  "isActivated": true,
  "proxyNumber": "4111111111111111",
  "fundingType": "Card",
  "prenoteSentDate": "2026-05-05T21:12:54.126Z",
  "prenoteApproveDate": "2026-05-12T21:12:54.126Z"
}

Response

The updated direct deposit account.

idinteger

The identifier for the bank account.

accountTypestring required

The account type.

routingNumberstring required

The routing number (9 digits).

accountNumberstring required

The account number.

institutionNumberstring required

The identifier for a financial institution, business, or company.

accountNamestring required

The name of the account.

accountCountrystring required

The country in which the bank operates. A 2-letter ISO 3166-1 alpha-2 code represents the country (e.g., "US", not "USA"). For details, see the <a href="https://developer.avionte.com/docs/general-guidelines#/data-formatting">General Guidelines</a>.

amountTypestring required

The amount type used to calculate the deposit. Options include Remaining Amount, Percent, and Fixed Amount. If Remaining Amount is selected, the amount must be set to 0, and only one of the talent's accounts can use this type.

amountnumber

The dollar amount or percentage that should be distributed to this account. The total percentage for all of the talent's accounts cannot exceed 100%.

accountOrderinteger

The order in which deposits are made to the talent’s accounts. Should be a unique integer within the list of a talent’s bank accounts.

isActivatedboolean

An indication of whether the Pay Card has been activated. If the account type is not Pay Card, this value is always false.

proxyNumberstring required

A short identifier that links a payment account to a unique reference, such as a phone number or email address, enabling transactions without exposing bank account details.

fundingTypestring required

The funding type (available for the rapid! PayCard account type).

isArchivedboolean

An indication of whether the account has been archived (soft-deleted). A value of true indicates the account is archived, and false indicates the account is active. This property is distinct from isActivated, which reflects Pay Card activation state rather than the account's archive state.

prenoteSentDatestring date-time nullable

The date and time the prenotification was sent to the bank. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.

prenoteApproveDatestring date-time nullable

The date and time the prenotification was approved. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.

Example response

{
  "id": 278,
  "accountType": "Checking",
  "routingNumber": "291070001",
  "accountNumber": "234544111",
  "institutionNumber": "2847",
  "accountName": "Checking Account",
  "accountCountry": "US",
  "amountType": "Percent",
  "amount": 75,
  "accountOrder": 1,
  "isActivated": true,
  "proxyNumber": "125362",
  "fundingType": "Instant Payment"
}

Changes

No recorded changes to this operation across all 1 revision of this API.