Request a payment

Sends a WhatsApp payment request message to a recipient through the WUTS gateway, asking them to pay a given amount in a supported ISO 4217 currency. The amount is supplied in the smallest currency unit (e.g. cents) and an optional expiry timestamp defaults to 7 days from now.

Authorization

bearerAuth

AuthorizationBearer <token>

Per-user API token (UUID v4) sent as Authorization: Bearer <token>. Identifies the tenant and user.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

to*string

Recipient identifier: a phone number in international format or a full WhatsApp JID. Resolved to a sendable JID by the gateway.

amount*integer

Amount in the smallest currency unit (e.g. cents). The gateway converts it to WhatsApp's 1/1000 units internally.

currency*string

ISO 4217 currency code. Must be one of the WUTS-supported currencies.

note_message?string

Optional note or description attached to the payment request.

receiver_jid?string

Optional specific receiver JID.

expiry_timestamp?integer

Optional Unix expiry timestamp for the request. If omitted or 0, the gateway defaults to 7 days from now.

Response Body

`application/json`

curl -X POST "https://example.com/payment/request" \  -H "Content-Type: application/json" \  -d '{    "to": "5511999999999",    "amount": 15000,    "currency": "BRL",    "note_message": "Invoice #4521 - consulting services",    "expiry_timestamp": 1718500000  }'

{  "success": true,  "message_id": "3EB0XXXX1234567890ABCDEF",  "timestamp": "2026-06-15T12:34:56Z",  "message": "Payment request sent successfully",  "amount": "150.00 BRL"}

{  "error": "Invalid currency code"}

{  "error": "unauthorized"}

{  "error": "Failed to send payment request: timeout"}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`