Direct Deposit

Add Direct Deposit Accounts

Uploads direct deposit accounts to associate with the talent.

post/v2/talent/{talentId}/direct-deposit-accounts

Request

  • Base URL
    https://api.avionte.com/talent
  • URL
    https://api.avionte.com/talent/v2/talent/{talentId}/direct-deposit-accounts
  • Auth
    API key in header x-api-key

Path parameters

talentIdstring required

The identifier for the talent.

Headers

RequestIdstring

Allows client-specified request correlation. Provided value must be a valid GUID.

Tenantstring required

A short code that indicates the tenant for which the request is being made.

Authorizationstring required

Contains the caller's access token, in the form "Bearer {token}", without quotes.

Request body

Idstring guid

The identifier for the bank account.

RoutingNumberstring required

The routing number (9 digits).

AccountNumberstring

The account number.

AccountNumberLastFourstring

The last for digits of the account number.

AmountValuenumber required

The amount of a paycheck that should be paid to the account. It could be a fixed dollar amount or a percent, depending on the BankAmountType designated for the account.

BankNamestring required

The name of the bank.

IsActiveboolean required

An indicator of whether the bank account is active for the talent or not.

Sequenceinteger required

The position of the account in relation to other accounts, indicating the order the accounts are paid for a paycheck.

HasDepositsboolean required

An indicator of whether the bank account has deposits or not.

CountryCodestring

The code of the country where the bank operates.

BankAmountType'None' | 'FixedAmount' | 'Percent' | 'RemainingAmount'

The bank amount types available for selection.

BankAccountType'None' | 'Checking' | 'Savings'

The bank account types available for selection.

Response

The sanitized direct deposit accounts.

Idstring guid

The identifier for the bank account.

RoutingNumberstring required

The routing number (9 digits).

AccountNumberstring

The account number.

AccountNumberLastFourstring

The last for digits of the account number.

AmountValuenumber required

The amount of a paycheck that should be paid to the account. It could be a fixed dollar amount or a percent, depending on the BankAmountType designated for the account.

BankNamestring required

The name of the bank.

IsActiveboolean required

An indicator of whether the bank account is active for the talent or not.

Sequenceinteger required

The position of the account in relation to other accounts, indicating the order the accounts are paid for a paycheck.

HasDepositsboolean required

An indicator of whether the bank account has deposits or not.

CountryCodestring

The code of the country where the bank operates.

BankAmountType'None' | 'FixedAmount' | 'Percent' | 'RemainingAmount'

The bank amount types available for selection.

BankAccountType'None' | 'Checking' | 'Savings'

The bank account types available for selection.

Changes

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