Request Payment Message

POST 
/payment/requestPayment

Send your contacts a message to pay for a product or service.

Request

application/json

Body

required

numbers string[]required

required

options object

quoted object

Inform the id of the message you want to quote, remembering that you can only quote one message at a time in the chat.

messageId stringrequired

mentioned string[]

The mention of participants is valid only for groups

delay number

Enter an integer value that represents a timestamp for the message delay: Ex.: { delay: 1500 }

expiryIn Inform, in second, the time in which the message will be enabled.

Default value: 3600

60 -> 1 minute | 3600 -> 1 hour | 86400 -> 24 hour

requestPayment object
currency Enter the currency in the country.required
Default value: BRL
https://pt.wikipedia.org/wiki/ISO_4217
text stringrequired
value Payment amount.required

Responses

201

application/json

Schema

Schema

action stringrequired
header object
queueId string
status stringrequired
progress numberrequired
data object
message objectrequired
jids string[]required
messagesIds string[]required
queueTimestamp numberrequired

Example (from schema)

{
  "action": "string",
  "header": {
    "queueId": "string",
    "status": "string",
    "progress": 0
  },
  "data": {
    "message": {},
    "jids": [
      "string"
    ],
    "messagesIds": [
      "string"
    ]
  },
  "queueTimestamp": 0
}

Loading...