Refund Pix

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

Refunds API

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

Headers

Request Body

{
    "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