Skip to content

Create AuthCode

Request

Creates a new AuthCode.

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
auth_Codestring, [ 1 .. 8 ] charactersrequired

Code that indicates the authorization status.

auth_Actionstring 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.

descriptionstring or null, <= 64 characters

Description of the authorization status tied to the associated code.

curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/auth-codes \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "auth_Code": "string",
    "auth_Action": "s",
    "description": "string"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}