Create a new sub-account

post

https://api.payments.optum.com/v1/accounts/{accountShortCode}/subaccounts

Creates a new sub-account for an account in an organization. If an account for an organization has the same name as an existing sub-account, then a 400 is returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountShortCode

string

required

The short code of the account

Body Params

The new sub-account to create. Anything null will pull from the account

shortCode

string

required

length ≥ 1

Account short code.

name

string

required

length between 1 and 250

Account name.

address

object | null

Account address

faxNumber

string | null

Fax number for the account.

phoneNumber

string | null

Phone number for the account.

contactName

string | null

Contact name for the account.

contactEmail

string | null

Contact email for the account.

tin

string | null

The Tax Identification Number (TIN) for the account.

holdAndRelease

boolean

required

Hold and Release flag for the account.

payer835Id

string | null

The Payer835Id for the account.

claimOfficePhoneNumber

string | null

The Claim Office phone number for the account.

claimOfficePhoneNumberExtension

string | null

The Claim Office phone number extension for the account.

claimOfficeUrl

uri | null

The Claim Office Url for the account.

technicalContactName

string | null

The Technical Contact Name for the account.

technicalPhoneNumber

string | null

The Technical Phone Number for the account.

technicalPhoneNumberExtension

string | null

The Technical Phone Number Extension for the account.

technicalUrl

uri | null

The Technical Url for the account.

technicalFaxNumber

string | null

The Technical Fax Number for the account.

technicalEmailAddress

string | null

The Technical Email Address for the account.

fundingAccounts

object | null

Funding accounts for the sub account.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

application/problem+json

200OK

400Bad Request