Email deposit instructions to an existing payer

POST 
/wallet/fiat/:currency/payment/references/:referenceCode/share

Emails VALR's bank details and the payer's existing VPAY reference to the payer's stored email address. Uses the Get Paid email. Nothing is persisted.

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

204

Instructions emailed

400

Request validation failed (INVALID_REQUEST, -11), the currency is not fiat (CURRENCY_NOT_SUPPORTED, -112), the payer has no email (UNIQUE_DEPOSIT_REFERENCE_NO_EMAIL, -15125), 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

No live payer with this reference in this currency on the entity (UNIQUE_DEPOSIT_REFERENCE_NOT_FOUND, -15114), or the Get Paid feature is disabled

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)