Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
payee-verification-requests

Create payee verification requests in bulk

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.

post/bulk_actions/payee_verification_requests

Request body

fail_on_validation_errorboolean

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.

Example request

{
  "items": [
    {
      "idempotency_key": "test-bulk-1",
      "scheme": "vop",
      "payee_identification_type": "name",
      "payee_identification": "Test Company Ltd",
      "payee_account_number": "FR1420041010050500013M02606",
      "payee_additional_information": "Account 123-ABC",
      "requesting_agent_bank_code": "BANKITPPXXX",
      "metadata": {
        "property_a": true,
        "property_b": "false"
      }
    }
  ]
}

Response

Successfully created bulk action

idstring required

The bulk action ID.

objectstring required

Type of the object, bulk_action.

target_object'payment_order' | 'internal_account' required

The object related to the bulk action.

action'create' | 'approve' | 'cancel' required

The action to execute on the items included in the bulk action.

If target_action is payment_order, can be create, approve or cancel. If target_action is internal_account, can be create.

status'created' | 'processing' | 'executed' required

The status of the bulk action. Either created, processing, or executed.

total_itemsinteger required

The number of items included in the bulk action.

total_successfulinteger required

The number of items successfully processed.

total_failedinteger required

The number of items that failed to be processed.

processed_atstring date-time nullable required

The UTC timestamp when the bulk action was processed.

created_atstring date-time required

The UTC timestamp of the creation of the bulk action.

Example response

{
  "object": "bulk_action",
  "status": "processing",
  "total_items": 50,
  "total_successful": 24,
  "total_failed": 2,
  "created_at": "2024-01-03T11:53:19.734182Z"
}