Create bulk action for payee verification requests

post

https://sandbox.numeral.io/v1/bulk_actions/payee_verification_requests

Create up to 5,000 payee verification requests in a single bulk action. Requests are processed asynchronously and you can choose whether to fail immediately on validation errors, or process valid items while marking invalid ones as failed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

fail_on_validation_error

boolean

Defaults to true

If true, all items must pass validation or the request returns a 400 error. If false, items that fail validation are marked as failed, and valid items are processed. Default is true.

items

array of objects

required

length ≥ 1

Array of payee verification requests to create in bulk.

items*

idempotency_key

string

length ≤ 255

Optional idempotency key for this specific item.

scheme

string

enum

required

The scheme on which the request will be sent. Only vop is supported today.

Allowed:

payee_identification_type

string

enum

required

The type of identification used in the request. See Supported identification type for more information.

payee_identification

string

required

The identification of the payee.

payee_account_number

string

required

The account number of the payee. Must be an IBAN.

payee_additional_information

string

length ≤ 140

Additional information about the payee.

requesting_agent_bank_code

string

The BIC11 you want to use to send your request.

metadata

object

Additional client data in JSON format. See Metadata.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Successfully created bulk action

400Validation error.

500Internal server error.