API Reference

Create a refund

post
https://api.brinta.com/refunds/

Create a refund

This endpoint creates a refund on Brinta's platform.

You need to send the id of the original transaction to which the refund is linked.

You can create a total or multiple partial refunds.

If no amount is sent, the refund will be total.

If you send the amount, you can choose to send it with or without including taxes.

Regarding its status, only with the values "invoiced" (a credit note has been created) or "voided" (the invoice of the original transaction has been voided) will there be an impact on the tax determination.

The status "refunded" will show there has been just a money movement (an adjustment, a chargeback, etc).

Body Params
string
required

Id of the transaction that will be refunded

string

Id of the refund on the client's system.

string
required

Status of the refund. It can be "pending", "invoiced" (if a credit note is invoiced), "voided" (in case the original invoice is voided) , "refunded" (no impact on taxes), or "rejected".

string
required

Type of the refund. It can be "refund", "chargeback", "adjustment".

float

It appears in RESPONSE. Amount to be refunded excluding taxes.

float

It appears in RESPONSE. Amount to be refunded including taxes.

string

The currency code of the refund amount. It can be the local currency or international_currency set for the transaction owner. Check Country Coverage and currencies. If not sent, will be the same currency used in the original transaction.

string

The exchange rate from the currency to the international currency set for the transaction owner.

string

Additional information regarding the refund.

string

Invoice (credit note) number of the refund.

date

Invoice date of the refund (UTC by default). Required when status is "invoiced".

items
array of objects

Items to be refunded.

items
Responses

Updated about 1 year ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 year ago