Send a 'Get paid' instruction to a payer
POST/get-paid
Resolves the deposit payment details for the requested currency and emails them to the recipient (the payer), echoing the same details back for on-screen display. For fiat this mints a fresh per-instruction VPAY reference and returns VALR's bank details; for crypto it returns a receive address (reusing the existing one for the currency/network, or creating one if absent) plus the network and any memo/tag field. Fire-and-forget: no instruction record is persisted.
Business/entity (RBAC) only — requires the payments.collections.create
permission within the selected entity. Retail (non-RBAC) callers are
rejected up front.
Request
Responses
- 201
- 400
- 401
- 403
- 500
- 503
Instruction resolved and emailed
Request validation failed (INVALID_REQUEST, -11) or unknown currency (INVALID_CURRENCY_SYMBOL, -109)
Missing/invalid JWT or entity selection (RBAC_ENTITY_SELECTION_REQUIRED, -23003)
Caller lacks the payments.collections.create permission, or is a non-RBAC caller (RBAC_PERMISSION_DENIED, -23002)
Could not resolve the payment details: a crypto receive address was unavailable (COULD_NOT_GET_RECEIVE_ADDRESS, -30) or a fiat VPAY reference could not be generated (UNIQUE_DEPOSIT_REFERENCE_GENERATION_FAILED, -15113)
Fiat VPAY references are temporarily disabled (UNIQUE_DEPOSIT_REFERENCES_FEATURE_DISABLED, -15117)