Nothing Found

Refund a line item from an invoice

Performs a full or partial refund on an individual line item. The refunded amount is deducted from your integrator account and refunded to the payment method(s) originally charged.

NOTE: For invoices containing user_to_user line items, funds are deducted from your integrator account, NOT the recipient user's wallet.

Successful completion triggers these notifications
Invoice complete
Refund completed

For more information about event notifications, visit Webhooks.

Securitytilia_auth
Request
Request Body schema: application/json
required

Line item refund

line_item_id
required
string <= 36 characters

ID of the line item to refund

In the case of an escrow transaction, the line_item_id comes from the escrow_invoice_id

amount
required
integer

Amount to refund in the currency's lowest denomination

payment_methods
required
Array of strings

List of payment methods to refund, in order of priority

The payment methods must have been used in the original invoice

reason
required
string

Main reason for performing the refund

Possible values:

  • billing
  • fraud
  • other
  • product_related
sub_reason
string

Secondary reason for performing the refund

note
string

Any additional notes about the refund

Responses
200

Successfully refunded line item

400

Invalid input

401

Unauthorized access.

500

Service unavailable or server error.

post/v2/line-item/refund
Request samples
application/json
{
  • "line_item_id": "inv_2V2XDLW6zogChdShdFh8WKOhHii",
  • "amount": 100,
  • "payment_methods": [
    ],
  • "reason": "billing",
  • "sub_reason": "Charged twice",
  • "note": "Flag account"
}
Response samples
application/json
{
  • "status": "Success",
  • "message": null,
  • "codes": null,
  • "payload": {
    }
}