Pagar cobranca

Endpoint: POST /sales/charge/{id}/pay

Autenticação: Publica (sem autenticacao, CSRF dispensado) — voltada ao comprador.

Endpoint chamado pela pagina hospedada Pagar venda publica e por qualquer interface de checkout customizada construida sobre Obter contexto publico da venda quando o comprador clica em “Pagar”. Dado o id de um Link de checkout e os dados de pagamento do comprador, ele:

Monta um dicionario de configuracao a partir da venda online e do seu plano (valor, parcelas maximas, configuracao do boleto).
Aciona a criacao da transacao na infraestrutura de processamento configurada.
Cria um registro de pagamento do checkout combinando o link e o cliente, e vincula a transacao resultante.

O valor vem do link (OnlineSell.amount); o comprador nao pode sobrescrever.

Pre-requisitos

O Link de checkout deve existir.
O Plano de pagamento do link deve permitir o type escolhido (allow_credit_card / allow_pix / allow_boleto).

Parametros de caminho

string

required

UUID do link de checkout.

Corpo da requisicao

string

required

Um de credit_card, pix, boleto.

string

required

Nome completo do comprador — deve conter ao menos duas palavras.

string

required

E-mail do comprador.

string

required

Telefone do comprador, somente digitos. Validado pelo country_code. Maximo 15.

string

default:"+55"

Codigo do pais do telefone (+55, +1, …).

integer

Obrigatorio quando type=credit_card. Intervalo 1-21.

object

Obrigatorio quando type=credit_card. Ou { "id": "<token>" } ou { "number", "cvv", "name", "expirationMonth", "expirationYear" }. number maximo 16; cvv maximo 4; name maximo 255; expirationMonth 2 caracteres; expirationYear 4 caracteres.

string

Digitos de CPF/CNPJ. Obrigatorio quando type=boleto. Maximo 14.

object

Obrigatorio quando type=boleto. Chaves: line1, line2, neighborhood, city, state (2 letras), postalCode (8 digitos, todos numericos).

Resposta

200 OK. A transacao pode estar succeeded (cartao de credito) ou ainda pending (PIX/boleto aguardando acao do comprador).

string

Status retornado pela infraestrutura de processamento: succeeded, pending, failed, etc.

string

Presente apenas quando type=boleto. URL do PDF do boleto hospedado.

string

Presente apenas quando type=pix. EMV BR Code (copia e cola).

string

Presente apenas quando type=pix. Imagem QR no formato data:image/png;base64,... gerada pelo servidor.

string

UUID interno da transacao. Nota: omitido neste endpoint na implementacao atual — apenas Criar pagamento inclui esse campo. O comprador deve consultar Buscar transacao por ID legado para acompanhar.

{
  "payment": {
    "status": "pending",
    "pix": {
      "copy_paste": "00020126360014BR.GOV.BCB.PIX...",
      "qr_code": "data:image/png;base64,iVBORw0KGgo..."
    }
  }
}

Erros

Status	Quando
`400`	Validacao do corpo falhou (campos ausentes, telefone invalido, endereco invalido).
`402`	Cartao recusado — o payload de erro da infraestrutura de processamento e retornado.
`405`	Metodo diferente de `POST`.

Exemplos

curl -X POST "https://api.dlpay.cloud/sales/charge/$CHECKOUT_ID/pay" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "pix",
    "name": "Maria Souza",
    "email": "maria@example.com",
    "phone": "11999990000"
  }'

import requests

response = requests.post(
    f"https://api.dlpay.cloud/sales/charge/{checkout_id}/pay",
    json={
        "type": "credit_card",
        "name": "Maria Souza",
        "email": "maria@example.com",
        "phone": "11999990000",
        "installments": 3,
        "card": {
            "number": "4111111111111111",
            "cvv": "123",
            "name": "MARIA SOUZA",
            "expirationMonth": "12",
            "expirationYear": "2030",
        },
    },
)
payment = response.json()["payment"]

const response = await fetch(
  `https://api.dlpay.cloud/sales/charge/${checkoutId}/pay`,
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      type: "boleto",
      name: "Maria Souza",
      email: "maria@example.com",
      phone: "11999990000",
      taxpayerId: "12345678900",
      address: {
        line1: "Rua A",
        line2: "100",
        neighborhood: "Centro",
        city: "Sao Paulo",
        state: "SP",
        postalCode: "01001000",
      },
    }),
  },
);
const { payment } = await response.json();

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Pre-requisitos

Parametros de caminho

Corpo da requisicao

Resposta

Erros

Exemplos

​Pre-requisitos

​Parametros de caminho

​Corpo da requisicao

​Resposta

​Erros

​Exemplos

Pre-requisitos

Parametros de caminho

Corpo da requisicao

Resposta

Erros

Exemplos