Payments Refunds

Get the status of a Payment Refund

Changed on

This endpoint allows you to get the status of a payment refund

get/payments-refund/{refundId}/status

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: ApiKey, MerchantId, Environment

Path parameters

refundIdnumber required

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

status'created' | 'pending' | 'pending_manual' | 'failed' | 'successful' required

The refund status

Example response

{
  "status": "created"
}

Changes