Finalizes the cancellation of a periodic payment

put

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

Finalizes the cancellation of a periodic payment

This handles the next steps of cancelling a periodic payment.

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

flow

string | null

Flow context received in the previous call of the flow

dataString

string | null

Data needed to continue teh flow. Depends on the flow type (e.g. for Redirect flow the DataString should be a query string form bank's callback url)

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