curl --request POST \
  --url https://api.next.orenda.finance/v1/customers/{customerId}/batch-payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "verify",
  "payments": [
    {
      "payer": {
        "account": {
          "type": "uk",
          "sortCode": "010203",
          "accountNumber": "12345678"
        }
      },
      "payee": {
        "name": "Ada Lovelace",
        "account": {
          "type": "uk",
          "sortCode": "040506",
          "accountNumber": "87654321"
        },
        "accountType": "CONSUMER"
      },
      "reference": "Invoice 1024",
      "amount": "150.00"
    },
    {
      "payer": {
        "account": {
          "type": "iban",
          "iban": "DE89370400440532013000"
        }
      },
      "payee": {
        "name": "Grace Hopper",
        "account": {
          "type": "iban",
          "iban": "FR7630006000011234567890189",
          "bic": "AGRIFRPP"
        }
      },
      "reference": "Invoice 1025",
      "amount": "200.00"
    }
  ]
}
'

{
  "success": true,
  "requestId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "status": "PENDING"
}

Batch payments

Batch action (verify / initiate / submit)

A single endpoint that drives the whole batch flow; the action field selects the step.

verify — submit the items for validation and name-checking (COP for UK, VOP for EU). Returns a requestId; poll verify status until it completes.
initiate — get the totalAmount, currency, and an scaChallenge for the verified set.
passkey-challenge — get a passkey challenge to satisfy SCA with a passkey.
submit — send the batch with SCA: a confirmation object with method: "passkey", "totp", or "pin". Returns the batchId.

Use the examples dropdown below to see each action’s request and response.

POST

customers

{customerId}

batch-payments

curl --request POST \
  --url https://api.next.orenda.finance/v1/customers/{customerId}/batch-payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "verify",
  "payments": [
    {
      "payer": {
        "account": {
          "type": "uk",
          "sortCode": "010203",
          "accountNumber": "12345678"
        }
      },
      "payee": {
        "name": "Ada Lovelace",
        "account": {
          "type": "uk",
          "sortCode": "040506",
          "accountNumber": "87654321"
        },
        "accountType": "CONSUMER"
      },
      "reference": "Invoice 1024",
      "amount": "150.00"
    },
    {
      "payer": {
        "account": {
          "type": "iban",
          "iban": "DE89370400440532013000"
        }
      },
      "payee": {
        "name": "Grace Hopper",
        "account": {
          "type": "iban",
          "iban": "FR7630006000011234567890189",
          "bic": "AGRIFRPP"
        }
      },
      "reference": "Invoice 1025",
      "amount": "200.00"
    }
  ]
}
'

{
  "success": true,
  "requestId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "status": "PENDING"
}

Authorizations

Authorization

string

header

required

The user's access_token. The program and environment come from the token.

Path Parameters

customerId

string

required

The customer id.

Body

application/json

action

enum<string>

required

The step to run.

Available options:

verify,

initiate,

passkey-challenge,

submit

payments

object[]

The payment items. Required for verify, initiate, and submit.

Show child attributes

scaChallenge

object

The strong-customer-authentication challenge from initiate. Pass it back on submit.

Show child attributes

confirmation

Passkey · object

Step-up confirmation (for submit). Set method to passkey, totp, or pin and include that method's fields. pin is a program capability — see Program capabilities.

Passkey
2FA code
PIN

Show child attributes

idempotencyKey

string<uuid>

Optional. Reuse the same key to make submit safe to retry.

Response

Result for the requested action

The response is of type object.

Generate a statement Get verify status