API referencePay In endpointsInvoices

Create invoice

Creates an invoice in an entrypoint.

Path parameters

entrystringRequired

The paypoint’s entrypoint identifier. Learn more

Headers

requestTokenstringRequired
idempotencyKeystringOptional

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

Query parameters

forceCustomerCreationbooleanOptional

When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to false.

Request

This endpoint expects an object.
customerDataobjectOptional

Object describing the customer/payor. Required for POST requests. Which fields are required depends on the paypoint’s custom identifier settings. See PayorData Object Model for a complete reference.

invoiceDataobjectOptional

Object describing the invoice. Required for POST requests.

scheduledOptionsobjectOptional

Object with options for scheduled invoices.

Response

Success

isSuccessbooleanOptional

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

pageidentifierstringOptional

Auxiliary validation used internally by payment pages and components.

responseCodeintegerOptional

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

responseDatastring or integerOptional

If isSuccess = true, this contains the identifier of the invoice. If isSuccess = false, this contains the reason for the failure.

responseTextstringOptional

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

Errors