Refund Pix

Refunds API, allows external customers/users to make refunds.

Refunds API

PATCH {api_base_url}api/payin/{externalId}/refund

Headers

Name
Type
Description

Authorization *

String

JWT token in format Bearer eyJ0... For more information about authentication, please refer to Authentication

Request Body

Name
Type
Description

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*

Object

Only mandatory for Brazilian bank accounts. Branch information. Party Object.

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

{
    "externalId": "XXXX",
    "internalId": "{{InternalId}}",
    "status": {
        "code": "902",
        "description": "REFUNDED",
        "detail": "The payin was refunded"
    }
}
curl --location --request PATCH 'https://api.stage.localpayment.com/api/payin/{{externalId}}/refund' \
--header 'x-client-code: 0000' \
--header 'Content-Type: application/json' \
--header 'Authorization:{{Token_Generated}}' \
--data '{
    "comment": "Refund API VA",
    "beneficiary": {
        "type": "Type",
        "name": "Name",
        "lastname": "LastName",
        "document": {
            "type": "DocumentType",
            "id": "DocumentId"
        },
        "bank": {
            "name": "BankName",
            "code": "Code",
            "account": {
                "type": "BankAccountType",
                "number": "AccountNumber"
            }
        }
    }
}'
  • 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