Retrieve a Refund

HTTP Request

GET /v1/payments/charges/refund/{{idempotencyKey}}

RequestResponse

Request Headers

{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}

Content-Type: application/json

{
    "transferStatusCode": 200,
    "transferErrorMsg": null,
    "idempotencyKey": "2022030214000007-1",
    "referenceId": "2022030214000007",
    "paymentMethod": "CREDIT_CARD",
    "amount": 300,
    "currency": "BRL",
    "country": "BR",
    "finalAmount": 100,
    "finalCurrency": "BRL",
    "createTime": "2022-03-01 21:18:56 GMT-08:00",
    "scheduledTime": "2022-03-01 21:18:56 GMT-08:00",
    "finalStatusTime": "2022-03-01 21:18:58 GMT-08:00",
    "payer": {
        "name": "username",
        "document": null,
        "email": "account@example.com",
        "phone": "+55 81987654321",
        "billingAddress": {  
            "zipCode": "04849333",
            "state": "SP",
            "city": "sao paulo",
            "district": "Jardim Gaivotas",
            "street": "Rua 9 de setembro",
            "number": "15",
            "complement": "casa",
            "country": "BR"
        }
    },
    "transferStatus": "SETTLED",
    "description": "refund test",
    "callbackUrl": "https://api.client.com/callback/"
}

HTTP Headers Details

Key	Value
Authorization	"bearer" + " " + {{access_token}}
x-api-key	{{api_key}}

PATH and Query Parameters

Parameter	Type	Description
idempotencyKey	String	The idempotency key of the refund

Response Body Details

Parameter	Type	Description
idempotencyKey	String	Unique key of refund record.
referenceId	String	Unique key of payment record which refunded.
amount	Long	The refund amount
country	String	country code
currency	String	The currency of the transferred fund
finalAmount	Long	The final amount that is used for creating the charge order. EX: for charge orders with FX conversion, this field represents the converted amount from the original requested amount.
finalCurrency	String	The currency code of the finalAmount.
createTime	String	The creation time of refund request
scheduledTime	String	Transfer ticket scheduled time
finalStatusTime	String	The settled or failed time of refund transaction
transferStatus	String	Transfer status, SETTLED, IN_PROGRESS, FAILED
transferStatusCode	Integer	Transfer status code, 200 transaction SETTLED or IN_PROGRESS or FAILED
transferErrorMsg	String	Transfer error message if failed