Criar cobrança

Cria uma cobrança (PaymentIntent) com Pix, cartão de crédito, cartão de débito ou Pix parcelado. `201` confirma a criação; o resultado está em `status`. Um cartão recusado também volta `201`, com `status: "Failed"`. Valores em centavos.

POST

/api/v1/paymentintents

Cria uma cobrança (PaymentIntent) com Pix, cartão de crédito, cartão de débito ou Pix parcelado. 201 confirma a criação; o resultado está em status. Um cartão recusado também volta 201, com status: "Failed". Valores em centavos.

Autenticação

ApiKey

headerAuthorization<token>

A chave de API crua, sem prefixo: kpa_test_sk_… no sandbox e kpa_live_sk_… em produção. Use apenas no servidor.

Cabeçalhos

Corpo da requisição

application/json

body

amount*integer

Total em centavos.

currency*string

Pix e Pix parcelado só BRL.

Valores aceitos"BRL""USD"

paymentMethods*array<>

Itens1 <= items <= 1

paymentMethodOptions?

customer*

shipping?

split?

postbackUrl?string

URL HTTPS para os webhooks desta cobrança.

Formatouri

metadata?

description?string

statementDescriptor?string

Identificação na fatura do cartão.

Tamanholength <= 22

Corpo da resposta

Cobrança criada. Leia status para saber o resultado.

application/json

response

id?string

Formatouuid

object?string

amount?integer

currency?string

status?PaymentIntentStatus

Valores aceitos"Created""Processing""RequiresAction""Succeeded""Failed""Canceled""Refund""ChargedBack"

statusDetail?|

Lista aberta, ex. PENDING_CHALLENGE, AUTHENTICATION_FAILED.

merchantId?string

paymentMethods?array<>

customer?

split?|null

metadata?

lastPaymentError?|null

nextAction?|null

pixPayment?|null

pagalevePayment?|null

postbackUrl?string|null

description?string|null

statementDescriptor?string|null

created?string

Formatodate-time

succeededAt?|

Formatodate-time

curl -X POST 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/v1/paymentintents' \
  -H 'Content-Type: application/json' \
  -d '{
  "amount": 1990,
  "currency": "BRL",
  "paymentMethods": [
    {
      "type": "Pix",
      "amount": 1990
    }
  ],
  "paymentMethodOptions": {
    "pix": {
      "expiresInMinutes": 30
    }
  },
  "customer": {
    "name": "Cliente de Teste",
    "email": "cliente@example.com"
  },
  "postbackUrl": "https://loja.example.com/webhooks/dm",
  "metadata": {
    "orderId": "pedido-pix-1001"
  }
}'

curl -X POST 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/v1/paymentintents' \  -H 'Content-Type: application/json' \  -d '{  "amount": 1990,  "currency": "BRL",  "paymentMethods": [    {      "type": "Pix",      "amount": 1990    }  ],  "paymentMethodOptions": {    "pix": {      "expiresInMinutes": 30    }  },  "customer": {    "name": "Cliente de Teste",    "email": "cliente@example.com"  },  "postbackUrl": "https://loja.example.com/webhooks/dm",  "metadata": {    "orderId": "pedido-pix-1001"  }}'

Exemplo de respostaEsquema

{
  "id": "8b727267-bf39-48a4-91ea-eb0780cb48a9",
  "object": "payment_intent",
  "amount": 1990,
  "currency": "BRL",
  "status": "Processing",
  "statusDetail": null,
  "merchantId": "3c1d6a2e-5b7f-4e8a-9c0d-1e2f3a4b5c6d",
  "paymentMethods": [
    {
      "type": "Pix",
      "amount": 1990,
      "currency": "BRL",
      "card": null,
      "pix": {
        "pixKeyType": "RANDOM",
        "expiresInMinutes": 30
      }
    }
  ],
  "customer": {
    "name": "Cliente de Teste",
    "email": "cliente@example.com",
    "document": null,
    "phone": null,
    "birthDate": null,
    "address": null
  },
  "split": null,
  "metadata": {
    "orderId": "pedido-pix-1001"
  },
  "lastPaymentError": null,
  "nextAction": null,
  "pixPayment": {
    "qrCodeEmv": "00020126...",
    "qrCodeUrl": "",
    "pixCopyPaste": "00020126...",
    "expiresAt": "2026-09-08T15:30:00Z",
    "endToEndId": "",
    "status": "PENDING"
  },
  "pagalevePayment": null,
  "postbackUrl": "https://loja.example.com/webhooks/dm",
  "created": "2026-09-08T15:00:00Z",
  "succeededAt": null
}

{  "id": "8b727267-bf39-48a4-91ea-eb0780cb48a9",  "object": "payment_intent",  "amount": 1990,  "currency": "BRL",  "status": "Processing",  "statusDetail": null,  "merchantId": "3c1d6a2e-5b7f-4e8a-9c0d-1e2f3a4b5c6d",  "paymentMethods": [    {      "type": "Pix",      "amount": 1990,      "currency": "BRL",      "card": null,      "pix": {        "pixKeyType": "RANDOM",        "expiresInMinutes": 30      }    }  ],  "customer": {    "name": "Cliente de Teste",    "email": "cliente@example.com",    "document": null,    "phone": null,    "birthDate": null,    "address": null  },  "split": null,  "metadata": {    "orderId": "pedido-pix-1001"  },  "lastPaymentError": null,  "nextAction": null,  "pixPayment": {    "qrCodeEmv": "00020126...",    "qrCodeUrl": "",    "pixCopyPaste": "00020126...",    "expiresAt": "2026-09-08T15:30:00Z",    "endToEndId": "",    "status": "PENDING"  },  "pagalevePayment": null,  "postbackUrl": "https://loja.example.com/webhooks/dm",  "created": "2026-09-08T15:00:00Z",  "succeededAt": null}

AutenticaçãoCopiar link da seção

CabeçalhosCopiar link da seção

Corpo da requisiçãoCopiar link da seção

Corpo da respostaCopiar link da seção

Autenticação

Cabeçalhos

Corpo da requisição

Corpo da resposta