POST
/
Bill
/
approval
/
{idBill}
curl --request POST \
  --url https://api-sandbox.payabli.com/api/Bill/approval/{idBill} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '[
  "<string>"
]'
{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": 6101,
  "pageidentifier": null
}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Headers

idempotencyKey
string

A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Example:

"6B29FC40-CA47-1067-B31D-00DD010662DA"

Path Parameters

idBill
integer
required

Payabli ID for the bill. Get this ID by querying /api/Query/bills/ for the entrypoint or the organization.

Example:

285

Query Parameters

autocreateUser
boolean
default:false

Automatically create the target user for approval if they don't exist.

Body

List of emails or usernames requested to approve the bill.

The body is of type string[].

Response

200
application/json
Success
isSuccess
boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

responseCode
integer | null

Code for the response. Learn more in API Response Codes.

Example:

1

responseData

If isSuccess = true, this contains the bill identifier. If isSuccess = false, this contains the reason for the error.

pageidentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null