Cancel refund

POST 
/v3/refunds/:refundId/cancel

Cancel refund (only awaiting refund with status NEW)

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

Api-Key stringrequired

Unique key used to authenticate API requests.

Signature stringrequired

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

Idempotency-Key stringrequired

Possible values: <= 45 characters

A unique identifier used to ensure idempotent behavior. If the business application request fails or you receive a timeout you can retry the request with the same Idempotency-Key to guarantee that only one business object is created.

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

401

Unauthorized, invalid or missing credentials

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

oneOf

UnauthorizedErrorDetails

Error details

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...