Refund status

GET 
/v3/refunds/:refundId/status

Retrieve refund status after the refund request has been submitted

Request

Path Parameters

refundId stringrequired

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

Signature stringrequired

The Signature header is used to ensure the request’s body integrity and to confirm that its content has not changed.

User-Agent string

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.

Accept stringrequired

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

Success

application/json

Schema

Schema

refundId refundIdrequired

Unique ID of a refund generated by Paynow

status RefundStatus (string)required

Current status of the refund. More information you can find here.

Possible values: [NEW, PENDING, SUCCESSFUL, FAILED, CANCELLED]

failureReason FailureReason (string)

Refund failure reason

• CARD_BALANCE_ERROR means that there are insufficient funds in the card balance
• BUYER_ACCOUNT_CLOSED means that buyer's account is closed
• OTHER means other reason

Possible values: [CARD_BALANCE_ERROR, BUYER_ACCOUNT_CLOSED, OTHER]

Example (from schema)

{
  "refundId": "REFA-321-123-888",
  "status": "SUCCESSFUL"
}

401

Unauthorized, invalid or missing credentials

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

oneOf

UnauthorizedErrorDetails

errorType stringrequired

Error type

Possible values: [UNAUTHORIZED]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {}
  ]
}

Example

{
  "statusCode": 401,
  "errors": [
    {
      "errorType": "UNAUTHORIZED",
      "message": "Unauthorized, invalid or missing credentials"
    }
  ]
}

404

Not found

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [NOT_FOUND]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "NOT_FOUND",
      "message": "string"
    }
  ]
}

Example

{
  "statusCode": 404,
  "errors": [
    {
      "errorType": "NOT_FOUND",
      "message": "Resource not found"
    }
  ]
}

500

Internal server error

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [INTERNAL_SERVER_ERROR]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "INTERNAL_SERVER_ERROR",
      "message": "string"
    }
  ]
}

Example

{
  "statusCode": 500,
  "errors": [
    {
      "errorType": "INTERNAL_SERVER_ERROR",
      "message": "Internal server error"
    }
  ]
}

503

Service is temporarily unavailable

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [SYSTEM_TEMPORARILY_UNAVAILABLE]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "SYSTEM_TEMPORARILY_UNAVAILABLE",
      "message": "string"
    }
  ]
}

Example

{
  "statusCode": 503,
  "errors": [
    {
      "errorType": "SYSTEM_TEMPORARILY_UNAVAILABLE",
      "message": "Service is temporarily unavailable"
    }
  ]
}

Loading...