Cancels a periodic payment

post

https://example.com/ob/Pis/payments/periodic/cancel

Cancels a periodic payment for a specific bank

This is the first step of the flow to cancel a periodic payment for a user.

Body Params

userContext

string

required

length ≥ 1

The user context of the bank user.

bankSettings

object | null

The settings of the bank, only used if you are accredited as TPP.

bankSettingsCode

string | null

tppContext

object | null

Additional data to be used by TPP for tracking purposes

connectorId

int32

enum

required

Enum listing all the available banks in the SDK

paymentId

string | null

Id of the payment

flow

string

required

length ≥ 1

Last flow context received during payment flow

Headers

X-Request-ID

string

length ≤ 50

Request identifier, unique to the call, as determined by the client. Maximum length of 50 characters.

X-Correlation-ID

string

length ≤ 50

Unique identifier for all the calls of the same flow. Determined by the client in direct/TPP mode, ignored in Gateway mode. Maximum length of 50 characters.

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Payment flow data

400Error