API Reference

Notify invoice by transaction id

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

Endpoint to notify an existing invoice by transaction id.

This notification forwards the invoice data to the payer by sharing the QRCode or "copy and paste".

For the notification to occur, it is necessary to send the object to which the notification will be forwarded.

It can be SMS or Email.

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 notification request data

string
required
length ≤ 200

Display name of payer

string
enum
required

Notification type. The available notification types are:

  • EMAIL - Email message
Allowed:
string
length ≤ 128

Email to notify. Mandatory if notify_type is EMAIL

string

Phone number to notify - in e164 format. Future parameter for new notification types

Responses
204

Success - No Content

401

Necessary Authentication token or you pass a invalid Token.

403

Necessary permission scope.

404

Resource not found.

406

Not acceptable for the Server.

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?