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.
Path Params
uuid
required
length between 36 and 36

The unique identifier of the capture

Body Params
string
required
length ≤ 255
amount
object
required

The amount object with split values for net, gross and tax

string
length ≤ 255
line_items
array of objects

Line items from the invoice which this credit note is created for.

line_items
Responses

Language
Credentials
OAuth2
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json