Get periodic payment status

post

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

Get the status of the periodic payment

Can be called multiple time to fetch new status. How long this can be called depends on the bank.

Body Params

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

userContext

string | null

The user context of the bank user.

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 status

400Error