CodeChat APIv1.0.0
ChangelogPostman
Referência/CodeChat API Go Pro/sendPaymentRequest
CodeChat API Go Pro

Envia solicitação de pagamento

Envia solicitação de pagamento

Pro
POSThttp://localhost:8084/instance/{instance}/send/payment-request

Autenticação

InstanceBearerobrigatório

JWT HS256 da própria instância.

Header
Authorization
Exemplo
Bearer <INSTANCE_TOKEN>

Parâmetros

instancepathobrigatório
string

Nome público da instância

minLength 1

Request body

obrigatório
bodyoneOf
numberstring

Telefone ou JID do destinatário

chatstring

Alias de destinatário

recipientstring

Alias de destinatário

paymentRequestMessageobjectobrigatório
presentationobjectobrigatório
titlestringmaxLength: 1024
descriptionstringobrigatóriominLength: 1 · maxLength: 4096
footerstringmaxLength: 1024
referenceIdstringobrigatóriomaxLength: 255
typestringobrigatório
paymentTypestringobrigatório
currencystringobrigatório
paymentSettingsarrayobrigatório
items[]object
typeenum<boleto | pix_dynamic_code | payment_link>obrigatório
boletoobject
digitableLinestringobrigatóriopattern: ^[0-9]{44,48}$
pixDynamicCodeobject
keyTypeenum<CPF | CNPJ | EVP | EMAIL | PHONE>obrigatório
codestringobrigatóriominLength: 1 · maxLength: 4096
merchantNamestringobrigatóriominLength: 1 · maxLength: 255
paymentLinkobject
urlstringobrigatórioformat: uri · pattern: ^https?://
totalAmountobjectobrigatório
valueintegerobrigatóriomín: 0
offsetintegerobrigatóriomín: 1
orderobjectobrigatório
statusstringobrigatório
itemsarrayobrigatório
items[]object
retailerIdstringobrigatóriominLength: 1 · maxLength: 255
namestringobrigatóriominLength: 1 · maxLength: 255
amountobjectobrigatório
valueintegerobrigatóriomín: 0
offsetintegerobrigatóriomín: 1
quantityintegerobrigatóriomín: 1
subtotalobjectobrigatório
valueintegerobrigatóriomín: 0
offsetintegerobrigatóriomín: 1
taxobject
valueintegerobrigatóriomín: 0
offsetintegerobrigatóriomín: 1
shippingobject
valueintegerobrigatóriomín: 0
offsetintegerobrigatóriomín: 1
discountobject
valueintegerobrigatóriomín: 0
offsetintegerobrigatóriomín: 1
mediaUploadIdintegermín: 1
optionsobject
delayintegermín: 0 · máx: 120000
presenceenum<composing | recording | paused>
quotedMessageIdstring
quotedMessageobject
externalAttributesobject
mentionAllbooleanpadrão: false
opção 1any
opção 2any
opção 3any
Exemplo JSONgerado do schema
"string"

Respostas

application/json
200

Solicitação enviada

response 200object
idintegerobrigatório
keyIdstringobrigatório
keyRemoteJidstring | nullobrigatório
keyLidstring | nullobrigatório
keyFromMebooleanobrigatório
keyParticipantstring | nullobrigatório
keyParticipantLidstring | nullobrigatório
pushNamestring | nullobrigatório
messageTypestringobrigatório
contentanyobrigatório
messageTimestampintegerobrigatório
deviceenum<ios | android | web | unknown | desktop>obrigatório
isGroupboolean | nullobrigatório
instanceIdintegerobrigatório
metadataany
externalAttributesobject
Exemplo 200gerado do schema
{
  "id": 1,
  "keyId": "string",
  "keyRemoteJid": "[email protected]",
  "keyLid": "string",
  "keyFromMe": true,
  "keyParticipant": "string",
  "keyParticipantLid": "string",
  "pushName": "CodeChat",
  "messageType": "Olá! Esta é uma mensagem de exemplo da CodeChat.",
  "content": "string",
  "messageTimestamp": 1,
  "device": "ios",
  "isGroup": true,
  "instanceId": 1,
  "metadata": "string",
  "externalAttributes": {}
}