Refund Cash

The "Refunds" functionality allows external customers/users to request a refund of the amount paid. It is available through API or Front

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.code*	String	Mandatory. Bank code, according to Localpayment bank codes list.
bank.branch*	Object	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.type*	String	Mandatory. Payer account type, according to Localpayment typification
bank.account.number*	String	Mandatory. Payer account number

200: OK Payin refunded

{
    "externalId": "XXXX",
    "internalId": "{{InternalId}}",
    "status": {
        "code": "902",
        "description": "REFUNDED",
        "detail": "The payin was refunded"
    }
}

400: Bad Request Payin not found

{
    "status": {
        "code": "400",
        "description": "ERROR",
        "detail": "Invalid operation"
    }
}

Request

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 '{
    "externalId": "{{externalId}}",
    "comment": "Refund Cash",
    "beneficiary": {
        "type": "INDIVIDUAL",
        "name": "Name",
        "lastname": "LastName",
        "document": {
            "type": "{{DocumentType}}",
            "id": "{{id}}"
        },
        "bank": {
            "name": "{{bankName}}",
            "code": "007",
            "account": {
                "type": "type",
                "number": "{{AccountNumber}}"
            }
        }
    }
}'

Status OK

{
    "externalId": "{{externalId}}",
    "internalId": "{{InternalId}}",
    "status": {
        "code": "902",
        "description": "REFUNDED",
        "detail": "The payin was refunded"
    }
}

Bad Request

{
    "status": {
        "code": "400",
        "description": "ERROR",
        "detail": "Invalid operation"
    }
}

Create Refund Cash

Authorization Refund Cash