MsgVariantPaymentRequest
paymentRequest objectrequired
Non-BRL payment links render a CTA URL message with a localized payment button (language pt/en/es, default pt). Its bodyText plus reference and total must fit 1024 characters; invalid requests are rejected without a plain-text fallback. BRL uses the existing native Brazil payment flow.
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
Possible values: non-empty and <= 4096 characters
Possible values: non-empty and <= 128 characters
Possible values: [pix]
pix objectrequired
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: []
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]
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]
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})?$
pt{
"paymentRequest": {
"tax": {}
}
}