STstarkbank
Invoice

Update an Invoice

Update a single invoice. If the invoice has not yet been paid, you can adjust parameters such as the requested amount, the due datetime and the expiration. If the invoice has already been paid, only the amount can be decreased, which will result in a payment reversal.

patch/v2/invoice/{id}

Request

  • Base URL
    https://api.starkbank.com
  • URL
    https://api.starkbank.com/v2/invoice/{id}
  • Auth
    API key in header Digital-Signature

Path parameters

idstring required

Id of the invoice entity.

Request body

amountinteger

New amount that should be charged on payment. If the invoice has already been paid, it is the final amount after reversal. Example: 200 (R$2.00).

duestring date-time

New due datetime. Example: '2020-11-26T17:59:26.000000+00:00'.

expirationinteger

New expiration. Example: 3600 (1 hour).

statusstring

This can be used to cancel the invoice by passing 'canceled' as the status patch.

Response

Successful operation

object required

Changes

No recorded changes to this operation across all 1 revision of this API.