Marcar pedido como pago
/contacts/{contact_id}/pay/{order_id}Marca um pedido como pago, quando o contato pagou fora da NexTags (Pix, link de pagamento, na loja). O valor recebido precisa cobrir o total do pedido. O corpo vai em formulário (application/x-www-form-urlencoded). Veja Receber pagamentos no e-commerce.
O amount_received vai em centavos: R$ 80,82 = 8082.
curl -X POST "https://app.nextagsai.com.br/api/contacts/123456789/pay/PED-1001" \
-H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY" \
--data-urlencode 'amount_received=8082'const resposta = await fetch('https://app.nextagsai.com.br/api/contacts/123456789/pay/PED-1001', {
method: 'POST',
headers: {
'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
},
body: new URLSearchParams({
amount_received: 8082,
}),
});
const dados = await resposta.json();
console.log(resposta.status, dados);import os
import requests
resposta = requests.post(
"https://app.nextagsai.com.br/api/contacts/123456789/pay/PED-1001",
headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
data={
"amount_received": 8082,
},
timeout=30,
)
print(resposta.status_code, resposta.json())<?php
$ch = curl_init('https://app.nextagsai.com.br/api/contacts/123456789/pay/PED-1001');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
],
CURLOPT_POSTFIELDS => http_build_query([
'amount_received' => 8082,
]),
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);Autenticação
Mande a chave de API da conta no cabeçalho X-ACCESS-TOKEN de cada chamada. Veja Autenticação com a chave de API.
Parâmetros de caminho
contact_idintegerobrigatórioO ID do contato.
order_idstringobrigatórioO ID do pedido (texto). Ele vem em order_id, no carrinho e no pedido.
Corpo da requisição
FormulárioContent-Type: application/x-www-form-urlencoded
amount_receivedintegerobrigatórioO valor que o contato pagou, em centavos (8082 = R$ 80,82).
Respostas
O pedido foi marcado como pago.
successbooleantrue quando deu certo.
O amount_received é menor que o total do pedido.
O checkout falhou, e o contato recebeu uma mensagem explicando por quê.
O pedido não existe para este contato.
A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja Autenticação.
Relacionados
Visão geral da API
Guia que usa este endpointLimites, erros e boas práticas
Guia que usa este endpointCarrinho, pedidos e produtos
Guia que usa este endpointReceber pagamentos no e-commerce
Tutorial da Central de AjudaConsultar produto
GET /products/{product_id}Atualizar produto
POST /products/{product_id}Este conteúdo ajudou?
Obrigado! Sua resposta ajuda a melhorar a central.