Initiate bulk payments

post

https://example.com/ob/Pis/payments/bulk

Initiate a new bulk payments for a specific bank

This is the first step of the flow to do a bulk payments for a user.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Object containing the bulk payment initiation request.

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

The tpp context. Contains arbitrary data that can be used for later reference in calls reported in our report system.

connectorId

int32

enum

The id of the connector you want to initiate the bulk payment with.

flow

string | null

Optional flow context received in previous call to PUT /ob/pis/accounts.

In case this is the first call of the payment, the flow context may be omitted.
Never pass the flow context of a previous call to payment init or payment finalize!!!

bulkPaymentInitiationRequest

object | null

The actual bulk payment request that contains the data of the bulk payment.

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.

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200Bulk Payments flow data

400Error

422Error while checking the given model against the options of the connector