Adv. VBAGateway

Process a VBAGateway Request Advanced API

Confirm, Reject, or Hold a VBAGateway Request that will then change the Request Status and update Response information.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
request_Key
integer <int32>

The Request Key from VBAGateway that you want to process.

request_Type
string or null

The Request Type value for the Request being processed.

idCard_Request_Type
string or null

When processing an ID Card Request (either Member or Employer) send the ID Card Request Type to be updated back to VBAGateway

response
string or null

Whether you are confirming, rejecting, or holding the request. Valid values are "CONFIRM", "REJECT", or "HOLD". Any other value will throw an exception.

response_Manual
string or null

"Y" or "N" indicator for whether the processing of this request has been done manually.

response_Subject
string or null

The Subject of the Response record being added to this Request. This is the text that will be sent to the client.

response_Body
string or null

The Body of the Response record being added to this Request. This is the text that will be sent to the client.

Responses
202

Accepted for processing

401

Unauthorized

post/vbagateway-process-request
Request samples
{
  • "request_Key": 0,
  • "request_Type": "string",
  • "idCard_Request_Type": "string",
  • "response": "string",
  • "response_Manual": "string",
  • "response_Subject": "string",
  • "response_Body": "string"
}