Provider Account

Create Provider Account

Creates a new Provider Account

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerAccount_Key
required
integer <int32>

Unique identifier for each account record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

account_Key
required
integer <int32>

References the FundingAccount.Account_Key record for account details. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
string or null <date-time>

Date when the Provider account becomes/became effective.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

provider_ID
required
string [ 1 .. 20 ] characters

Unique idenfitier assigned to the Proivider record.

term_Date
string or null <date-time>

Date when the Provider account expires/expired.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

wire_Transfer
required
boolean

Indicates if this account accepts wire transfers. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/providers/{providerID}/accounts
Request samples
{
  • "providerAccount_Key": 0,
  • "account_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "provider_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "wire_Transfer": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Provider Accounts

List Provider Accounts for a specific Provider ID.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/providers/{providerID}/accounts
Request samples 
Response samples 
No sample
Get Provider Account
Gets Provider Account


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
providerAccountKey
required
integer <int32> 
ProviderAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/providers/{providerID}/accounts/{providerAccountKey}
Request samples 
Response samples 
No sample
Update Provider Account
Updates a specific Provider Account.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
providerAccountKey
required
integer <int32> 
ProviderAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
providerAccount_Key
required
integer <int32> 
Unique identifier for each account record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
required
integer <int32> 
References the FundingAccount.Account_Key record for account details. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
Date when the Provider account becomes/became effective.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
provider_ID
required
string  [ 1 .. 20 ] characters 
Unique idenfitier assigned to the Proivider record.


 
term_Date
string or null <date-time> 
Date when the Provider account expires/expired.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
wire_Transfer
required
boolean
Indicates if this account accepts wire transfers. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/providers/{providerID}/accounts/{providerAccountKey}
Request samples 
{
  • "providerAccount_Key": 0,
  • "account_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "provider_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "wire_Transfer": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Provider Account
Deletes a Provider Account


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
providerAccountKey
required
integer <int32> 
ProviderAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerID}/accounts/{providerAccountKey}
Request samples 
Create or Update Batch Provider Account
Create or Update multiple Provider Accounts at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
providerAccount_Key
required
integer <int32> 
Unique identifier for each account record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
required
integer <int32> 
References the FundingAccount.Account_Key record for account details. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
Date when the Provider account becomes/became effective.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
provider_ID
required
string  [ 1 .. 20 ] characters 
Unique idenfitier assigned to the Proivider record.


 
term_Date
string or null <date-time> 
Date when the Provider account expires/expired.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
wire_Transfer
required
boolean
Indicates if this account accepts wire transfers. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


put/providers/{providerID}/accounts-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}