Auth Code

Create AuthCode

Creates a new AuthCode.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
auth_Code
required
string [ 1 .. 8 ] characters

Code that indicates the authorization status.

auth_Action
string or null <= 1 characters

Specifies what action will be applied by the associated status code: Approved - full authorization amount will be approved. Denied - full authorization amount will be denied. Pended - requested authorization amount has been pended for review. Voided - authorization has been removed. Partial Approval - only a partial amount of the authorization has been approved.

description
string or null <= 64 characters

Description of the authorization status tied to the associated code.

Responses
200

Success

401

Unauthorized

post/auth-codes
Request samples
{
  • "auth_Code": "string",
  • "auth_Action": "s",
  • "description": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get AuthCode

Gets AuthCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
authCode
required
string

Auth Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/auth-codes/{authCode}
Request samples 
Response samples 
No sample
Update AuthCode
Updates a specific AuthCode.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
authCode
required
string
Auth Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
auth_Code
required
string  [ 1 .. 8 ] characters 
Code that indicates the authorization status.


 
auth_Action
string or null  <= 1 characters 
Specifies what action will be applied by the associated status code: Approved - full authorization amount will be approved. Denied - full authorization amount will be denied. Pended - requested authorization amount has been pended for review. Voided - authorization has been removed. Partial Approval - only a partial amount of the authorization has been approved.


 
description
string or null  <= 64 characters 
Description of the authorization status tied to the associated code.


 
Responses 
200
Success


401
Unauthorized


put/auth-codes/{authCode}
Request samples 
{
  • "auth_Code": "string",
  • "auth_Action": "s",
  • "description": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete AuthCode
Deletes an AuthCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
authCode
required
string
Auth Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/auth-codes/{authCode}
Request samples 
Update Batch AuthCode
Updates a multiple AuthCode.


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


 
Request Body schema: 
required
 Array 
auth_Code
required
string  [ 1 .. 8 ] characters 
Code that indicates the authorization status.


 
auth_Action
string or null  <= 1 characters 
Specifies what action will be applied by the associated status code: Approved - full authorization amount will be approved. Denied - full authorization amount will be denied. Pended - requested authorization amount has been pended for review. Voided - authorization has been removed. Partial Approval - only a partial amount of the authorization has been approved.


 
description
string or null  <= 64 characters 
Description of the authorization status tied to the associated code.


 
Responses 
207
Success


401
Unauthorized


put/auth-codes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}