Cancel a scheduled payment - V1

PUT

/order/v1/banking/subscriptions/payments/{scheduledPaymentId}/cancel

• Production
• Sandbox

Cancel a scheduled payment for an existing subscription.

Authorizations

• Bearer

Parameters

Path Parameters

scheduledPaymentId

required

string

The scheduled payment ID (UUID)

Header Parameters

idempotency-key

required

string

Request Body ^required

object

accountId

required

Receiver account ID that owns subscription

string

Example

37d182d7-3b5c-4a53-ab1b-e4c8125082b7

Responses

202

The resource was returned successfully

object

id

required

The unique identifier of cancellation request

string

Example

1f303a8c-dfd2-44ee-901a-56e33b0be3df

status

required

The status of cancellation request

string

Allowed values: INITIAL PENDING ACCEPTED REJECTED ERROR

Example

PENDING

endToEndId

required

The end-to-end identifier of cancellation request

string

Example

3912bf98-a000-499d-81a9-58794e5e7f0a

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

[]