Skip to main content
GET
/
refunds
/
{refundId}
Check refund status
curl --request GET \
  --url https://api.sandbox.pawapay.io/refunds/{refundId} \
  --header 'Authorization: Bearer <token>'
[
  {
    "refundId": "8917c345-4791-4285-a416-62f24b6982db",
    "status": "COMPLETED",
    "amount": "123.45",
    "currency": "ZMW",
    "country": "ZMB",
    "correspondent": "MTN_MOMO_ZMB",
    "recipient": {
      "type": "MSISDN",
      "address": {
        "value": "260763456789"
      }
    },
    "customerTimestamp": "2020-10-19T08:17:00Z",
    "statementDescription": "From ACME company",
    "created": "2020-10-19T08:17:01Z",
    "receivedByRecipient": "2020-10-19T08:17:02Z",
    "correspondentIds": {
      "SOME_CORRESPONDENT_ID": "12356789"
    },
    "metadata": {
      "orderId": "ORD-123456789",
      "customerId": "customer@email.com"
    }
  }
]
Get refund status by the refundId from your initial refund request. A list with at most one Refund is returned. This operation can be used to confirm the current status of a refund.

Authorizations

​
Authorization
string
header
required

Path Parameters

​
refundId
string<uuid>
required
Required string length: 36

Response

​
refundId
string<uuid>
required
Required string length: 36
Example:
​
status
enum<string>
required
Available options:
ACCEPTED,
SUBMITTED,
ENQUEUED,
COMPLETED,
FAILED
​
amount
string
required
Required string length: 1 - 23
Example:
​
currency
string
required
Example:
​
country
string
required
Example:
​
correspondent
string
required
Example:
​
recipient
object
required
​
customerTimestamp
string<date-time>
required
Example:
​
created
string<date-time>
required
Example:
​
statementDescription
string
Required string length: 4 - 22
Example:
​
receivedByRecipient
string<date-time>
Example:
​
correspondentIds
object
Example:
​
failureReason
object
​
metadata
object
Example: