Refund Pix
Refunds API, allows external customers/users to make refunds.
Refunds API
PATCH
{api_base_url}api/payin/{externalId}/refund
Headers
Authorization *
String
JWT token in format Bearer eyJ0... For more information about authentication, please refer to Authentication
Request Body
externalId*
String
An ID that is meaningful to you and your system. Must be unique.
comment
String
Add any relevant information
beneficiary
Object
Party Object
type
String
Possible values: COMPANY
, INDIVIDUAL
name
String
Individual / company
name
lastName
String
INDIVIDUAL type
/ Ignored for COMPANY
document
Object
Optional. Party Object.
document.type
String
Optional. Document type (related to the beneficiary's residence)
document.id
String
Identity document id. Usually numbers or combination of numbers and letters.
bank*
Object
Mandatory. Party Object. Payer account data.
bank.name*
String
Mandatory. Bank name.
bank.branch.code*
String
Branch code. Only Brazil.
bank.branch.name*
String
Branch name. Only Brazil.
bank.account*
Object
Mandatory. Party Object. Payer account information.
bank.account.number*
String
Mandatory. Payer account number
The transaction can only be refunded if the status is completed.
The refund must be made to the total amount of the payin.
The beneficiary's destination account information is mandatory and must match the original payment information.
Last updated