Refund status
GET/v3/refunds/:refundId/status
Retrieve refund status after the refund request has been submitted
Request
Path Parameters
Possible values: >= 16 characters
and <= 16 characters
, Value must match regular expression ^([a-zA-Z0-9]{4}(-[a-zA-Z0-9]{3}){3})$
Unique ID of a refund generated by Paynow
Header Parameters
The Signature header is used to ensure the request’s body integrity and to confirm that its content has not changed.
The User-Agent request header contains a characteristic string that allows the network protocol peers to identify the application type, operating system, software vendor or software version of the requesting software user agent.
The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand. Can be set to */*
.
Responses
- 200
- 401
- 404
- 500
- 503
Success
- application/json
- Schema
- Example (from schema)
Schema
CARD_BALANCE_ERROR
means that there are insufficient funds in the card balanceBUYER_ACCOUNT_CLOSED
means that buyer's account is closedOTHER
means other reason
Unique ID of a refund generated by Paynow
Possible values: [NEW
, PENDING
, SUCCESSFUL
, FAILED
, CANCELLED
]
Current status of the refund. More information you can find here.
Possible values: [CARD_BALANCE_ERROR
, BUYER_ACCOUNT_CLOSED
, OTHER
]
Refund failure reason
{
"refundId": "REFA-321-123-888",
"status": "SUCCESSFUL"
}
Unauthorized, invalid or missing credentials
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
- UnauthorizedErrorDetails
]
Error status code
errors
object[]
required
oneOf
Possible values: [UNAUTHORIZED
]
Error type
Error description
{
"statusCode": 0,
"errors": [
{}
]
}
{
"statusCode": 401,
"errors": [
{
"errorType": "UNAUTHORIZED",
"message": "Unauthorized, invalid or missing credentials"
}
]
}
Not found
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
Error status code
errors
object[]
required
Possible values: [NOT_FOUND
]
Error type
Error description
{
"statusCode": 0,
"errors": [
{
"errorType": "NOT_FOUND",
"message": "string"
}
]
}
{
"statusCode": 404,
"errors": [
{
"errorType": "NOT_FOUND",
"message": "Resource not found"
}
]
}
Internal server error
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
Error status code
errors
object[]
required
Possible values: [INTERNAL_SERVER_ERROR
]
Error type
Error description
{
"statusCode": 0,
"errors": [
{
"errorType": "INTERNAL_SERVER_ERROR",
"message": "string"
}
]
}
{
"statusCode": 500,
"errors": [
{
"errorType": "INTERNAL_SERVER_ERROR",
"message": "Internal server error"
}
]
}
Service is temporarily unavailable
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
Error status code
errors
object[]
required
Possible values: [SYSTEM_TEMPORARILY_UNAVAILABLE
]
Error type
Error description
{
"statusCode": 0,
"errors": [
{
"errorType": "SYSTEM_TEMPORARILY_UNAVAILABLE",
"message": "string"
}
]
}
{
"statusCode": 503,
"errors": [
{
"errorType": "SYSTEM_TEMPORARILY_UNAVAILABLE",
"message": "Service is temporarily unavailable"
}
]
}