Payment Methods

Create PaymentMethod

Creates a new PaymentMethod

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
payment_Method
required
string [ 1 .. 20 ] characters

The primary key of the payment method

description
string or null <= 512 characters

The description of the payment method

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

payment_Method_ACH
required
boolean

Flag identifying the Payment Method as an ACH transaction Note: This field is marked as NOT NULL in the database and therefore required by the API.

payment_Method_Check
required
boolean

Flag identifying the Payment Method as a check Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/payment-methods
Request samples
{
  • "payment_Method": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payment_Method_ACH": true,
  • "payment_Method_Check": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PaymentMethod

Lists all PaymentMethod

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/payment-methods
Request samples 
Response samples 
No sample
Get PaymentMethod
Gets PaymentMethod


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Payment_Method
required
string
Payment Method


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payment-methods/{Payment_Method}
Request samples 
Response samples 
No sample
Update PaymentMethod
Updates a specific PaymentMethod.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Payment_Method
required
string
Payment Method


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payment_Method
required
string  [ 1 .. 20 ] characters 
The primary key of the payment method


 
description
string or null  <= 512 characters 
The description of the payment method


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


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


 
payment_Method_ACH
required
boolean
Flag identifying the Payment Method as an ACH transaction Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
payment_Method_Check
required
boolean
Flag identifying the Payment Method as a check Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


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


 
Responses 
200
Success


401
Unauthorized


put/payment-methods/{Payment_Method}
Request samples 
{
  • "payment_Method": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payment_Method_ACH": true,
  • "payment_Method_Check": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PaymentMethod
Deletes an PaymentMethod


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Payment_Method
required
string
Payment Method


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/payment-methods/{Payment_Method}
Request samples 
Create or Update Batch PaymentMethod
Create or Update multiple PaymentMethod at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
payment_Method
required
string  [ 1 .. 20 ] characters 
The primary key of the payment method


 
description
string or null  <= 512 characters 
The description of the payment method


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


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


 
payment_Method_ACH
required
boolean
Flag identifying the Payment Method as an ACH transaction Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
payment_Method_Check
required
boolean
Flag identifying the Payment Method as a check Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


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


 
Responses 
207
Success


401
Unauthorized


put/payment-methods-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
List Payment Methods by Subscriber
Based on the submitted Subscriber ID, list Payment Methods for that Subscribers latest enrollment and Billing Cycle.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberId
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payment-methods-by-subscriber/{subscriberId}
Request samples 
Response samples 
No sample