Batch

Submit dozens of operations in a single signed request. One batch can mix user creation, account opening, card issuing, card lifecycle and transfers — Paynetics validates the file, queues every item, and streams progress back through webhooks.

What can go in a batch?

A batch is an ordered array of typed operations. Each entry must declare exactly one operation key. Mix and match freely — useful when onboarding a cohort of users or fanning out a payroll run.

Onboarding
user_create
account_create
Card lifecycle
card_create
card_activate
card_status
card_renew
card_group_update
card_assign
Money movement
transfer

Lifecycle

Every batch flows through five deterministic states. Listen on the batch.* webhook family to follow progress without polling.

  1. 1

    Submitted

    You POST the array to /v2/batch. We assign a batch token and acknowledge synchronously.

  2. 2

    Validated

    Schema, signing key and product entitlements are checked for every item. Invalid items are rejected up-front; valid ones move on.

  3. 3

    Queued

    Items are dispatched to their respective core services in submission order. Idempotency keys are honoured end-to-end.

  4. 4

    Executed

    Each item gets its own outcome record with a token, status and error (if any). Partial success is the norm — the batch never fails as a whole.

  5. 5

    Settled

    A final batch.completed webhook fires with item-level outcomes and aggregate counts.

Limits and quotas are agreed per integration.

Maximum items per request, payload size, throughput and idempotency window are configured on your program. Contact your account manager or check the request response for the exact values that apply to your account.

Batch — POST /v2/batch

POST /v2/batch
Operation batch_create

Example request

[
    {
        "user_create": {
            "email": "string",
            "first_name": "string",
            "last_name": "string",
            "dob": "string",
            "phone": "string"
        },
        "account_create": {
            "program": "string",
            "merchant": "string",
            "user": "string"
        },
        "card_create": {
            "instance": "string",
            "account": "string",
            "program": "string",
            "merchant": "string",
            "user": "string",
            "emboss_name": "string",
            "emboss_name_line4": "string",
            "delivery_details": {
                "city": "string",
                "country": "string",
                "zip": "string",
                "county": "string",
                "code": "string",
                "method": "string",
                "address1": "string",
                "address2": "string",
                "address3": "string",
                "mobile_phone": "string"
            },
            "pin": "string",
            "fulfil1": "string",
            "fulfil2": "string",
            "thermal_line1": "string",
            "thermal_line2": "string",
            "type": "string"
        },
        "card_activate": {
            "card": "string"
        },
        "card_status": {
            "card": "string",
            "status": "string"
        },
        "card_renew": {
            "card": "string",
            "mode": "string"
        },
        "card_group_update": {
            "card": "string",
            "group": "string",
            "group_type": "string"
        },
        "card_assign": {
            "card": "string",
            "merchant": "string",
            "user": "string",
            "branch_code": "string"
        },
        "transfer": {
            "amount": 1.23,
            "currency": "EUR",
            "instance": "string",
            "code": "string",
            "link": "520bec3b-8051-4a2b-928c-81d32b6bfa41",
            "reference": "Payment for goods",
            "reference2": "Items 1,2,3",
            "reference3": "Additional Info",
            "reference4": "Additional Info",
            "origin_of_funds": "string",
            "description": "Merchant 123",
            "is_instant": false,
            "debtor": {
                "balance": "444f4f2c-6a05-43bb-93ab-7ab76ce5658c",
                "external_identifier": "123456789",
                "iban": "BG85PATC40021918158842",
                "sort_code": "123456",
                "account_number": "12345678",
                "address": "BG, Sofia, James Bouchier 76 A",
                "name": "John Doe",
                "country": "BG"
            },
            "creditor": {
                "balance": "444f4f2c-6a05-43bb-93ab-7ab76ce5658c",
                "external_identifier": "123456789",
                "iban": "BG85PATC40021918158842",
                "sort_code": "123456",
                "account_number": "12345678",
                "address": "BG, Sofia, James Bouchier 76 A",
                "name": "John Doe",
                "country": "BG"
            },
            "cop": "a5b968e4-ec62-4072-a37f-6b59e35a4e36",
            "vop": "a5b968e4-ec62-4072-a37f-6b59e35a4e36",
            "client_details": {
                "type": "string",
                "imei": "string",
                "ip_address": "string",
                "info": null
            },
            "extended_data": {
                "name": "string",
                "type": "string",
                "tax_number": "string",
                "iban": "string",
                "bic": "string",
                "account_number": "string",
                "sort_code": "string",
                "address": "string",
                "city": "string",
                "country_code": "string",
                "postal_code": "string",
                "routing_number": "string",
                "bsb_code": "string"
            }
        }
    }
]

Response

Field Type Description
code integer (0,any)

Example response

{
    "code": 0,
    "data": {
        "token": "0ba5e81d-c43b-4008-b2d6-0d390f6f8c08"
    }
}
esc
↑↓ navigate ↵ open esc close
Copied