Cobranças PIX

POST /v1/payment-intents

Exige payment_intents:write e Idempotency-Key. Envie amountCents, method pix e payer; consulte Receber PIX para limites dos campos. Responde 201 com a cobrança e pix.copyPasteCode.

curl -X POST "$API_BASE_URL/v1/payment-intents" \
  -H "Authorization: Bearer $MINGOPAY_API_KEY" \
  -H "Idempotency-Key: pedido-1024-cobranca-001" \
  -H "Content-Type: application/json" \
  -d '{"amountCents":14990,"method":"pix","payer":{"name":"Cliente Exemplo","taxId":"52998224725"}}'

GET /v1/payment-intents/:id

Exige payment_intents:read. id é o UUID da cobrança. Devolve a cobrança ou 404 payment_not_found.

Campos retornados

A cobrança devolve id, organizationId, customerId, externalReference, amountCents, currency, method, status, provider, providerReference, description, metadata, expiresAt, paidAt, createdAt e updatedAt. A criação adiciona o objeto pix com copyPasteCode e expiresAt; a consulta e a lista não incluem esse objeto.

Valores e identificadores abaixo são apenas um exemplo de formato, não uma cobrança real.

{"id":"<uuid>","organizationId":"<uuid>","externalReference":null,"amountCents":14990,"currency":"BRL","method":"pix","status":"pending","expiresAt":"<iso-date>","paidAt":null,"createdAt":"<iso-date>","updatedAt":"<iso-date>","pix":{"copyPasteCode":"<codigo-pix>","expiresAt":"<iso-date>"}}

GET /v1/payment-intents

Exige payment_intents:read. Parâmetros opcionais: limit entre 1 e 100 (padrão 25) e cursor em data/hora ISO. Resposta: items e nextCursor.

POST /v1/payment-intents/:id/synchronize

Exige payment_intents:read. Consulta o provedor da cobrança e aplica o estado retornado. Use para reconciliação quando necessário; webhooks seguem como fluxo principal. Pode responder provider_unavailable se o provedor original não estiver configurado.