Refund Capture

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

API Refund Capture

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.

200: OK Payin refunded

{
    "externalId": "ExternalId",
    "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 '{

  }'

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

Manual Transaction Refund Capture