Sign in

v1

latestOpenAPI 3.0.0© Billie GmbH, 20202026-07-24143643.6 KB
Captures

Create Credit Note

Purpose:

To refund against a previous capture. This can be done against part of the captured amount (partial refund) or its entire amount (full refund).

Preconditions:

  • captureId: The unique identifier of the capture
  • amount: The amount to be refunded

Success:

  • Response Code: HTTP 201

Attention:

  • The amount provided in the refund request does not exceed the amount of the capture.
post/invoices/{captureId}/credit-notes

Path parameters

captureIdstring uuid required
Example:12345667-890a-bcde-f123-34567890abcd

The unique identifier of the capture

Request body

external_codestring required
commentstring

Example request

{
  "amount": {
    "gross": 260.27,
    "net": 200.12,
    "tax": 60.15
  }
}

Response

Credit note successfully created

uuidstring uuid required

Example response

{
  "uuid": "12345667-890a-bcde-f123-34567890abcd"
}