Marketplace transfer cancellation request

PATCH 
/v3/payments/:paymentId/cancel

Marketplace transfer cancellation request

Request

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.

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

Content-Type stringrequired

The Content-Type entity header is used to indicate the media type of the resource.

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.

application/json

Body

required

Request body for transfer confirmation request

sellers string[]required

Responses

200

Success

400

Bad request

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [CONFLICT, FORBIDDEN, NOT_FOUND, RATE_LIMIT_REACHED, SYSTEM_TEMPORARILY_UNAVAILABLE, VALIDATION_ERROR, VERIFICATION_FAILED, IDEMPOTENCY_KEY_MISSING, SIGNATURE_MISSING, INVALID_PAYMENT_STATUS, INVALID_PAYMENT_TRANSFER_STATUS]

message string

Error description

value string

Object ID related to given error.

]

Example (from schema)

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

Example

{
  "statusCode": 400,
  "errors": [
    {
      "errorType": "VALIDATION_ERROR",
      "message": "Missing field XXX"
    },
    {
      "errorType": "INVALID_PAYMENT_TRANSFER_STATUS",
      "message": "Payment transfer for given seller is in wrong status XXX"
    }
  ]
}

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"
    }
  ]
}

409

Conflict

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [CONFLICT]

message string

Error description

]

Example (from schema)

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

Example

{
  "statusCode": 409,
  "errors": [
    {
      "errorType": "CONFLICT",
      "message": "Payment transfer for given seller is in wrong status {currentStatus=XXX}"
    }
  ]
}

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