Cancel a subscription - V1

PUT

/order/v1/banking/subscriptions/{id}/cancel

• Sandbox

  Request to cancel a subscription.

  

NOTE: Please, to authenticate use the scope: “api://app-order-hml”

Authorizations

• Bearer

Parameters

Path Parameters

id

required

string

The subscription ID (UUID)

Header Parameters

idempotency-key

required

string

Request Body ^required

object

accountId

required

Receiver account ID that owns the subscription

string

Example

dea4bfa5-8c57-4116-ab4f-242045d07697

Responses

202

The resource was returned successfully

object

id

required

The unique identifier of the cancellation request

string

Example

47381474-8849-45ba-92d1-79cdf1ad743f

status

required

The status of the cancellation request

string

Allowed values: INITIAL PENDING ACCEPTED REJECTED ERROR

Example

PENDING

400

object

error

string

Example

INVALID_REQUEST

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[
  {
    "field": "field_name",
    "issue": "INVALID",
    "description": "Field is invalid"
  }
]

401

Unauthorized Request

object

error

string

Example

UNAUTHORIZED

message

string

Example

Unauthorized Request

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

403

object

error

string

Example

FORBIDDEN_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

404

Resource not found

object

error

string

Example

NOT_FOUND

message

string

Example

Resource not found

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

500

object

error

string

Example

INTERNAL_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]