Register PayID on payment route
register_route_payidRegisters a PayID for an activated AUD payment route so payers can use an email-style alias instead of BSB and account details. Returns the existing PayID if one is already registered.
Instructions
Register a PayID for an activated AUD payment route, so payers can send to an email-style alias instead of a BSB and account number. Calling it again on a route that already has one returns the existing PayID.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"customerId": "<customerId>",
"virtualAccountId": "<virtualAccountId>"
},
"name": "register_route_payid"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| customerId | Yes | The customer ID | |
| virtualAccountId | Yes | The AUD payment route (virtual account) ID |