API referencePay In endpointsInvoices

Update invoice

Updates details for a single invoice in an entrypoint.

Path parameters

idInvoiceintegerRequired

Invoice ID

Headers

requestTokenstringRequired

Query parameters

forceCustomerCreationbooleanOptionalDefaults to false

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

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