SunchatPlus

Criar solicitação de pagamento

Gera uma solicitação de pagamento

POSThttps://api-publica.sunchat.com.br/v1/solicitacoes-de-pagamento

Cria uma cobrança no gateway configurado e devolve o link de checkout. A transação nasce como 'Pendente'; o status é atualizado depois pelo webhook da plataforma.

curl --request POST \
  --url 'https://api-publica.sunchat.com.br/v1/solicitacoes-de-pagamento' \
  --header 'X-Ambiente: SEU_NUMERO_DE_CONTA' \
  --header 'X-Authorization: X-Chave-Api SUA_CHAVE' \
  --header 'Content-Type: application/json' \
  --data '{}'

Autenticação

X-Ambientestring (header)obrigatório

Número da sua conta no SunchatPlus. Aceita também `X-Canal` com o ID de um canal, que resolve a conta a partir dele.

X-Authorizationstring (header)obrigatório

Chave de API no formato `X-Chave-Api {chave}`. O prefixo faz parte do valor. A chave fica em Minha conta › Integrações.

Corpo da requisição

IdGatewaystring<uuid>
Valornumber<double>
Descricaostring | null
IdContatostring<uuid> | null
ClienteNomestring | null
Vencimentostring<date-time> | null
SolicitarDadosDoClienteboolean
ClienteEmailstring | null
ClienteCpfCnpjstring | null
ClienteTelefonestring | null
ClienteCEPstring | null
ClienteEnderecostring | null
ClienteNumerostring | null
ClienteComplementostring | null
ClienteBairrostring | null
ClienteCidadestring | null
ClienteUFstring | null

Resposta 200

OK
IdTransacaostring<uuid>
UrlCheckoutstring | null
Referenciastring | null

Resposta 404

Not Found
typestring | null
titlestring | null
statusinteger<int32> | null
detailstring | null
instancestring | null

Resposta 422

Unprocessable Content
typestring | null
titlestring | null
statusinteger<int32> | null
detailstring | null
instancestring | null
errorsobject | null