Create refund

post

https://api.frisbii.com/v1/refund

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

invoice

string

required

length ≥ 1

Handle or id for invoice/charge to refund

key

string

Optional idempotency key. Only one refund can be performed for the same key. An idempotency key identifies uniquely the request and multiple requests with the same key and invoice will yield the same result. In case of networking errors the same request with same key can safely be retried.

amount

int32

≥ 1

Optional amount in the smallest unit for the account currency. Either amount or note_lines can be provided, if neither is provided the full refundable amount is refunded.

vat

float

Optional vat for this refund.

text

string

Optional refund text to use on credit note. Used in conjunction with amount. Ignored if note_lines is provided.

amount_incl_vat

boolean

Whether the amount is including VAT. Default true.

note_lines

array of objects

length between 1 and 2147483647

Refund credit note lines to give detailed information for credit note. Alternative to amount.

note_lines

manual_transfer

object

Optional manual transfer. If given no refund will be performed on potential online settled transaction like card transaction.

acquirer_reference

string

Optional reference for the transaction at the acquirer. Notice the following about this argument:

It only works for some acquirers.
Acquirers may have rigid rules on the content of the acquirer reference. Not complying to these rules can result in declined payments.
It is already possible to define custom acquirer reference using templating in the Frisbii Administration. Contact support for help. We highly recommend to only supply this argument if absolutely necessary, and the templated default acquirer reference is not sufficient. Maximum length is 128, but most acquirers require a maximum length of 22 characters. Truncating will be applied if too long for specific acquirer. Characters must match regex [\x20-\x7F]

Responses

200Successful operation

400Invalid request, see error codes at https://api.frisbii.com/v1/error_codes

401None or invalid credentials provided in access to secured resource

403Not authorized to perform resource operation

404Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes

429Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123

500Internal service error, error is reported automatically to Frisbii