Email deposit instructions to several existing payers

POST 
/wallet/fiat/:currency/payment/bulk-share

Emails VALR's bank details and each payer's existing VPAY reference to that payer's stored email address. Returns a status per payer; a payer that is missing, has no email, or whose email fails does not fail the request. Nothing is persisted.

Up to 100 payers with an email (configurable) are sent before the response. Above that they are queued in batches of that size and reported SENT once queued.

Business/entity (RBAC) only — requires the payments.collections.create permission within the selected entity. Retail (non-RBAC) callers are rejected up front.

Shares the Get Paid feature flag: while disabled the endpoint responds 404, indistinguishable from an unrouted path.

Request

Responses

200

Per-payer results

400

Request validation failed (INVALID_REQUEST, -11), the currency is not fiat (CURRENCY_NOT_SUPPORTED, -112), or the rail is not available (GET_PAID_RAIL_NOT_AVAILABLE, -15452)

401

Missing/invalid JWT or entity selection (RBAC_ENTITY_SELECTION_REQUIRED, -23003)

403

Caller lacks the payments.collections.create permission, or is a non-RBAC caller (RBAC_PERMISSION_DENIED, -23002)

404

The Get Paid feature is disabled — the endpoint is indistinguishable from an unrouted path

500

No deposit bank account is configured for the currency (GET_PAID_NO_BANK_ACCOUNT_CONFIGURED, -15453)

503

Payer references are temporarily disabled (UNIQUE_DEPOSIT_REFERENCES_FEATURE_DISABLED, -15117)