MsgVariantWebChattPaymentRequest
paymentRequest objectrequired
Currency defaults to BRL; integer values named Cents use the declared offset (default 100). PIX/boleto require BRL; payment_link supports the documented ISO 4217 codes. Web Chatt displays a currency-aware card. For non-BRL links WhatsApp sends a CTA URL message with bodyText, reference and total plus a localized payment button (language pt/en/es, default pt), subject to the customer-service window; it never downgrades to plain text. The rendered WhatsApp CTA body is limited to 1024 characters. This is not a native Brazil order_details card. No currency conversion or payment issuance.
- Option 1
- Option 2
- Option 3
- Option 4
Possible values: [BIF, CLP, DJF, GNF, ISK, JPY, KMF, KRW, PYG, RWF, UGX, UYI, VND, VUV, XAF, XOF, XPF]
Possible values: [1]
tax
Possible values: [1]
- Option 1
- Option 2
- Option 3
Possible values: [pix]
Possible values: [BRL]
Possible values: non-empty and <= 4096 characters
Possible values: non-empty and <= 128 characters
Possible values: [pix, boleto, payment_link]
pix object
Complete valid Pix copy-and-paste code from your payment provider. Replace sample placeholders; Hub does not generate a payment code.
Merchant name for the supplied Pix payment. The equivalent provider field in template actions is merchant_name.
Actual registered Pix key matching keyType. PHONE uses an international phone with a leading plus and country code; EVP uses a random-key UUID. Never send a literal placeholder.
Must match the actual key. CPF and CNPJ use digits; EMAIL uses an email address; PHONE uses a phone number; EVP uses a random-key UUID. Hub validates the enum, not key registration or matching format. Template actions use key_type instead.
Possible values: [CPF, CNPJ, EMAIL, PHONE, EVP]
boleto object
paymentLink object
Optional ISO 4217 code. Defaults to BRL. Non-BRL requires payment_link; the merchant payment provider must support the currency.
Possible values: [AED, AFN, ALL, AMD, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XCD, XCG, XOF, XPF, YER, ZAR, ZMW, ZWG]
BRLPossible values: >= 0 and <= 9007199254740991
Scale matching the currency minor units; root defaults to 100. Use 1 for JPY, 100 for USD/EUR/BRL, 1000 for KWD, 10000 for CLF. Tax offset, if supplied, must equal the root scale.
Possible values: [1, 100, 1000, 10000]
items object[]required
Possible values: >= 1, <= 100
Possible values: non-empty and <= 128 characters
Possible values: non-empty and <= 256 characters
Possible values: >= 0 and <= 9007199254740991
Possible values: >= 1 and <= 9007199254740991
tax object
Possible values: >= 0 and <= 9007199254740991
Scale matching the currency minor units; root defaults to 100. Use 1 for JPY, 100 for USD/EUR/BRL, 1000 for KWD, 10000 for CLF. Tax offset, if supplied, must equal the root scale.
Possible values: [1, 100, 1000, 10000]
Possible values: <= 512 characters
Possible values: >= 0 and <= 9007199254740991
Optional WhatsApp international payment CTA button language: pt (Pagar agora), en (Pay now), es (Pagar ahora), optionally with a two-letter region such as pt-BR or en-US. Defaults to pt, independently of currency. Does not translate bodyText or override the Web Chatt widget language.
Possible values: <= 5 characters, Value must match regular expression ^(pt|en|es)(-[A-Za-z]{2})?$
ptcontext object
{
"paymentRequest": {
"tax": {}
},
"context": {
"messageId": "string"
}
}