API referencePay Out endpointsBills

Send bill for approval

Send a bill to a user or list of users to approve.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

idBillintegerRequired

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

Headers

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

Query parameters

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

Request

This endpoint expects a list of strings.

Response

Success
isSuccessboolean

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

pageidentifierstring
Auxiliary validation used internally by payment pages and components.
responseCodeinteger

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

responseDatastring or integer

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

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

Errors

400
Bad Request Error
400
Bad Request Error
401
Unauthorized Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error