API Reference

Create refund for invoice by transaction id

post
https://api.stg.bavabank.com/pix/v1/accounts//invoices//refunds

Endpoint to create a refund for an existing invoice by transaction id.

Path Params
string
required

A universally unique identifier (UUID) of the account

string
required

The txid field determines the transaction identifier.

It will be the main way to be able to reconcile a receipt

In transactions with online QRCode field will have up to 26-35 characters in offline transactions will have 1-25 characters

Body Params

Invoice refund request data

Request body to create a refund for an invoice by transaction id.

string
required
^\d{1,10}\.\d{2}$

Amount to refund.

string
enum

Refund kind. The available kinds are:

  • ORIGINAL - Original refund
  • RETIRADA - Withdrawal refund
Allowed:
string
length ≤ 140

Description of the refund.

Responses

401

Necessary Authentication token or you pass a invalid Token.

403

Necessary permission scope.

404

Resource not found.

500

Internal server error.

503

Service Unavailable.

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?