Reborn
Docs

Criar transação

posthttps://sandbox-api.rebornpay.io/v1/transactionsAuth obrigatória

Cria uma nova transação de pagamento para o seller autenticado. Use este endpoint quando você possui seu próprio checkout e quer processar pagamentos diretamente. **PIX** (gera QR Code dinâmico): informe `buyerId` ou `buyer`. O status inicial é sempre `PENDING` — consulte via `GET /v1/transactions/{id}` ou aguarde o webhook. **CREDIT_CARD/DEBIT_CARD** (3DS obrigatório): conclua antes o fluxo de Configuração 3DS (1. Configurar 3DS → 2. Autenticar 3DS → 3. Resultado do desafio 3DS, se necessário) com o mesmo `card`. Depois informe aqui `buyerId`/`buyer`, `card` (de novo) e `threeDs` com o resultado da autenticação/challenge. **Tokenização:** envie `card.tokenize: true` para tokenizar o cartão antes da venda e reusar o `cardToken` devolvido em vendas futuras (ver tag Tokenização). **Idempotência:** envie o header `Idempotency-Key` (recomendado) para evitar cobranças duplicadas em retentativas. Requisições repetidas com a mesma chave e os mesmos parâmetros retornam a transação original (HTTP 200).

Headers

X-Api-Keystringrequired

API Key do seller (header)

Body

application/json
paymentMethodenumrequired

Método de pagamento. PIX cria direto. CREDIT_CARD/DEBIT_CARD exige 3DS prévio via POST /v1/transactions/threeds/setup → authenticate → (challenge-result) e informa `threeDs` com o resultado.

amountnumber · int64required

Valor em centavos

currencystringrequired

Moeda (ISO 4217)

descriptionstringoptional

Descrição da transação exibida ao pagador

expirationSecondsnumber · int32optional

Tempo de expiração do QR Code em segundos (mín. 60, máx. 86400)

buyerIdstring · uuidoptional

ID de um buyer pré-cadastrado (alternativa a `buyer`)

buyerobject
namestringrequired

Nome completo do comprador

documentTypeenumrequired

Tipo do documento

documentNumberstringrequired

Número do documento (somente dígitos)

emailstringoptional

E-mail do comprador

phonestringoptional

Telefone do comprador

addressobject
zipCodestringrequired

CEP, apenas números

streetstringoptional

Logradouro

numberstringoptional

Número

complementstringoptional

Complemento

neighborhoodstringoptional

Bairro

citystringoptional

Cidade

statestringoptional

UF (2 letras)

countrystringrequired

País (ISO 3166-1 alpha-2)

cardobject
cardTokenstringoptional

Token de cartão já tokenizado em chamada anterior (`POST /v1/cards/tokenize` ou `card.tokenize: true`)

numberstringoptional

Número do cartão (dados crus) — apenas dígitos

holderNamestringoptional

Nome do titular impresso no cartão

expirationMonthstringoptional

Mês de expiração (MM)

expirationYearstringoptional

Ano de expiração (YYYY ou YY)

cvvstringoptional

Código de segurança (CVV)

tokenizebooleanoptional

Quando dados crus são informados: true tokeniza o cartão antes da venda (reuso futuro, `cardToken` retornado na resposta); false envia o cartão para uso único, sem gerar token reutilizável.

installmentsnumber · int32optional

Número de parcelas. Só se aplica a CREDIT_CARD/DEBIT_CARD — ignorado em PIX. Default 1 (sem parcelamento).

threeDsobject
xidstringrequired

Transaction ID do 3DS

cavvstringrequired

Cardholder Authentication Verification Value

cavvResultCodestringrequired

Código de resultado do CAVV

secureVersionstringrequired

Versão do protocolo 3DS

directoryServerTransactionIdstringrequired

ID de transação do Directory Server

threeDsServerTransactionIdstringrequired

ID de transação do servidor 3DS

Responses

200Transação já existente (replay idempotente)
idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: PENDING

PENDINGPAIDFAILEDCANCELLEDREFUND_PENDINGREFUNDED
paymentMethodstring · enumrequired

Método de pagamento

Example: PIX

PIXCREDIT_CARDDEBIT_CARD
amountinteger · int64required

Valor em centavos

Example: 10000

currencystringrequired

Moeda (ISO 4217)

Example: BRL

descriptionstringoptional

Descrição da transação

Example: Pedido #1234

customerobjectoptional

Dados do pagador

namestringoptional

Nome do pagador

Example: João da Silva

emailstringoptional

E-mail do pagador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: 123.456.789-**

paymentDetailsobjectoptional

Detalhes do PIX gerado

qrCodestringoptional

Payload EMV (copia e cola)

Example: 00020126580014br.gov.bcb.pix...

qrCodeUrlstringoptional

URL da imagem do QR Code

Example: https://qrcode.example.com/...

expiresAtstring · date-timeoptional

Data/hora de expiração do QR Code (UTC)

createdAtstring · date-timerequired

Data/hora de criação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

paidAtstring · date-timeoptional

Data/hora do pagamento confirmado (UTC). Nulo enquanto pendente.

refundsarrayrequired

Histórico de estornos da transação

idstring · uuidrequired

UUID do estorno

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

amountinteger · int64required

Valor estornado nesta operação, em centavos

Example: 5000

originalAmountinteger · int64required

Valor original da transação no momento do estorno, em centavos

Example: 10000

statusstring · enumrequired

Status do estorno

Example: COMPLETED

PENDINGCOMPLETEDFAILED
requestedAtstring · date-timerequired

Data/hora da solicitação do estorno (UTC)

completedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto pendente.

idempotencyKeystringoptional

Chave de idempotência da criação (enviada no header ou gerada pelo servidor)

201Transação criada com sucesso
idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: PENDING

PENDINGPAIDFAILEDCANCELLEDREFUND_PENDINGREFUNDED
paymentMethodstring · enumrequired

Método de pagamento

Example: PIX

PIXCREDIT_CARDDEBIT_CARD
amountinteger · int64required

Valor em centavos

Example: 10000

currencystringrequired

Moeda (ISO 4217)

Example: BRL

descriptionstringoptional

Descrição da transação

Example: Pedido #1234

customerobjectoptional

Dados do pagador

namestringoptional

Nome do pagador

Example: João da Silva

emailstringoptional

E-mail do pagador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: 123.456.789-**

paymentDetailsobjectoptional

Detalhes do PIX gerado

qrCodestringoptional

Payload EMV (copia e cola)

Example: 00020126580014br.gov.bcb.pix...

qrCodeUrlstringoptional

URL da imagem do QR Code

Example: https://qrcode.example.com/...

expiresAtstring · date-timeoptional

Data/hora de expiração do QR Code (UTC)

createdAtstring · date-timerequired

Data/hora de criação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

paidAtstring · date-timeoptional

Data/hora do pagamento confirmado (UTC). Nulo enquanto pendente.

refundsarrayrequired

Histórico de estornos da transação

idstring · uuidrequired

UUID do estorno

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

amountinteger · int64required

Valor estornado nesta operação, em centavos

Example: 5000

originalAmountinteger · int64required

Valor original da transação no momento do estorno, em centavos

Example: 10000

statusstring · enumrequired

Status do estorno

Example: COMPLETED

PENDINGCOMPLETEDFAILED
requestedAtstring · date-timerequired

Data/hora da solicitação do estorno (UTC)

completedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto pendente.

idempotencyKeystringoptional

Chave de idempotência da criação (enviada no header ou gerada pelo servidor)

400Dados inválidos (paymentMethod não suportado, campos obrigatórios ausentes)
idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: PENDING

PENDINGPAIDFAILEDCANCELLEDREFUND_PENDINGREFUNDED
paymentMethodstring · enumrequired

Método de pagamento

Example: PIX

PIXCREDIT_CARDDEBIT_CARD
amountinteger · int64required

Valor em centavos

Example: 10000

currencystringrequired

Moeda (ISO 4217)

Example: BRL

descriptionstringoptional

Descrição da transação

Example: Pedido #1234

customerobjectoptional

Dados do pagador

namestringoptional

Nome do pagador

Example: João da Silva

emailstringoptional

E-mail do pagador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: 123.456.789-**

paymentDetailsobjectoptional

Detalhes do PIX gerado

qrCodestringoptional

Payload EMV (copia e cola)

Example: 00020126580014br.gov.bcb.pix...

qrCodeUrlstringoptional

URL da imagem do QR Code

Example: https://qrcode.example.com/...

expiresAtstring · date-timeoptional

Data/hora de expiração do QR Code (UTC)

createdAtstring · date-timerequired

Data/hora de criação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

paidAtstring · date-timeoptional

Data/hora do pagamento confirmado (UTC). Nulo enquanto pendente.

refundsarrayrequired

Histórico de estornos da transação

idstring · uuidrequired

UUID do estorno

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

amountinteger · int64required

Valor estornado nesta operação, em centavos

Example: 5000

originalAmountinteger · int64required

Valor original da transação no momento do estorno, em centavos

Example: 10000

statusstring · enumrequired

Status do estorno

Example: COMPLETED

PENDINGCOMPLETEDFAILED
requestedAtstring · date-timerequired

Data/hora da solicitação do estorno (UTC)

completedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto pendente.

idempotencyKeystringoptional

Chave de idempotência da criação (enviada no header ou gerada pelo servidor)

401API Key ausente ou inválida
idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: PENDING

PENDINGPAIDFAILEDCANCELLEDREFUND_PENDINGREFUNDED
paymentMethodstring · enumrequired

Método de pagamento

Example: PIX

PIXCREDIT_CARDDEBIT_CARD
amountinteger · int64required

Valor em centavos

Example: 10000

currencystringrequired

Moeda (ISO 4217)

Example: BRL

descriptionstringoptional

Descrição da transação

Example: Pedido #1234

customerobjectoptional

Dados do pagador

namestringoptional

Nome do pagador

Example: João da Silva

emailstringoptional

E-mail do pagador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: 123.456.789-**

paymentDetailsobjectoptional

Detalhes do PIX gerado

qrCodestringoptional

Payload EMV (copia e cola)

Example: 00020126580014br.gov.bcb.pix...

qrCodeUrlstringoptional

URL da imagem do QR Code

Example: https://qrcode.example.com/...

expiresAtstring · date-timeoptional

Data/hora de expiração do QR Code (UTC)

createdAtstring · date-timerequired

Data/hora de criação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

paidAtstring · date-timeoptional

Data/hora do pagamento confirmado (UTC). Nulo enquanto pendente.

refundsarrayrequired

Histórico de estornos da transação

idstring · uuidrequired

UUID do estorno

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

amountinteger · int64required

Valor estornado nesta operação, em centavos

Example: 5000

originalAmountinteger · int64required

Valor original da transação no momento do estorno, em centavos

Example: 10000

statusstring · enumrequired

Status do estorno

Example: COMPLETED

PENDINGCOMPLETEDFAILED
requestedAtstring · date-timerequired

Data/hora da solicitação do estorno (UTC)

completedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto pendente.

idempotencyKeystringoptional

Chave de idempotência da criação (enviada no header ou gerada pelo servidor)

409Idempotency-Key reutilizada com parâmetros diferentes
idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: PENDING

PENDINGPAIDFAILEDCANCELLEDREFUND_PENDINGREFUNDED
paymentMethodstring · enumrequired

Método de pagamento

Example: PIX

PIXCREDIT_CARDDEBIT_CARD
amountinteger · int64required

Valor em centavos

Example: 10000

currencystringrequired

Moeda (ISO 4217)

Example: BRL

descriptionstringoptional

Descrição da transação

Example: Pedido #1234

customerobjectoptional

Dados do pagador

namestringoptional

Nome do pagador

Example: João da Silva

emailstringoptional

E-mail do pagador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: 123.456.789-**

paymentDetailsobjectoptional

Detalhes do PIX gerado

qrCodestringoptional

Payload EMV (copia e cola)

Example: 00020126580014br.gov.bcb.pix...

qrCodeUrlstringoptional

URL da imagem do QR Code

Example: https://qrcode.example.com/...

expiresAtstring · date-timeoptional

Data/hora de expiração do QR Code (UTC)

createdAtstring · date-timerequired

Data/hora de criação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

paidAtstring · date-timeoptional

Data/hora do pagamento confirmado (UTC). Nulo enquanto pendente.

refundsarrayrequired

Histórico de estornos da transação

idstring · uuidrequired

UUID do estorno

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

amountinteger · int64required

Valor estornado nesta operação, em centavos

Example: 5000

originalAmountinteger · int64required

Valor original da transação no momento do estorno, em centavos

Example: 10000

statusstring · enumrequired

Status do estorno

Example: COMPLETED

PENDINGCOMPLETEDFAILED
requestedAtstring · date-timerequired

Data/hora da solicitação do estorno (UTC)

completedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto pendente.

idempotencyKeystringoptional

Chave de idempotência da criação (enviada no header ou gerada pelo servidor)

422Seller não está pronto para transacionar (KYC pendente, conta inativa)
idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: PENDING

PENDINGPAIDFAILEDCANCELLEDREFUND_PENDINGREFUNDED
paymentMethodstring · enumrequired

Método de pagamento

Example: PIX

PIXCREDIT_CARDDEBIT_CARD
amountinteger · int64required

Valor em centavos

Example: 10000

currencystringrequired

Moeda (ISO 4217)

Example: BRL

descriptionstringoptional

Descrição da transação

Example: Pedido #1234

customerobjectoptional

Dados do pagador

namestringoptional

Nome do pagador

Example: João da Silva

emailstringoptional

E-mail do pagador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: 123.456.789-**

paymentDetailsobjectoptional

Detalhes do PIX gerado

qrCodestringoptional

Payload EMV (copia e cola)

Example: 00020126580014br.gov.bcb.pix...

qrCodeUrlstringoptional

URL da imagem do QR Code

Example: https://qrcode.example.com/...

expiresAtstring · date-timeoptional

Data/hora de expiração do QR Code (UTC)

createdAtstring · date-timerequired

Data/hora de criação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

paidAtstring · date-timeoptional

Data/hora do pagamento confirmado (UTC). Nulo enquanto pendente.

refundsarrayrequired

Histórico de estornos da transação

idstring · uuidrequired

UUID do estorno

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

amountinteger · int64required

Valor estornado nesta operação, em centavos

Example: 5000

originalAmountinteger · int64required

Valor original da transação no momento do estorno, em centavos

Example: 10000

statusstring · enumrequired

Status do estorno

Example: COMPLETED

PENDINGCOMPLETEDFAILED
requestedAtstring · date-timerequired

Data/hora da solicitação do estorno (UTC)

completedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto pendente.

idempotencyKeystringoptional

Chave de idempotência da criação (enviada no header ou gerada pelo servidor)

502Falha ao comunicar com o gateway de pagamento
idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: PENDING

PENDINGPAIDFAILEDCANCELLEDREFUND_PENDINGREFUNDED
paymentMethodstring · enumrequired

Método de pagamento

Example: PIX

PIXCREDIT_CARDDEBIT_CARD
amountinteger · int64required

Valor em centavos

Example: 10000

currencystringrequired

Moeda (ISO 4217)

Example: BRL

descriptionstringoptional

Descrição da transação

Example: Pedido #1234

customerobjectoptional

Dados do pagador

namestringoptional

Nome do pagador

Example: João da Silva

emailstringoptional

E-mail do pagador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: 123.456.789-**

paymentDetailsobjectoptional

Detalhes do PIX gerado

qrCodestringoptional

Payload EMV (copia e cola)

Example: 00020126580014br.gov.bcb.pix...

qrCodeUrlstringoptional

URL da imagem do QR Code

Example: https://qrcode.example.com/...

expiresAtstring · date-timeoptional

Data/hora de expiração do QR Code (UTC)

createdAtstring · date-timerequired

Data/hora de criação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

paidAtstring · date-timeoptional

Data/hora do pagamento confirmado (UTC). Nulo enquanto pendente.

refundsarrayrequired

Histórico de estornos da transação

idstring · uuidrequired

UUID do estorno

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

amountinteger · int64required

Valor estornado nesta operação, em centavos

Example: 5000

originalAmountinteger · int64required

Valor original da transação no momento do estorno, em centavos

Example: 10000

statusstring · enumrequired

Status do estorno

Example: COMPLETED

PENDINGCOMPLETEDFAILED
requestedAtstring · date-timerequired

Data/hora da solicitação do estorno (UTC)

completedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto pendente.

idempotencyKeystringoptional

Chave de idempotência da criação (enviada no header ou gerada pelo servidor)

curl -X POST 'https://sandbox-api.rebornpay.io/v1/transactions' \  -H 'X-Api-Key: $API_KEY' \  -H 'Content-Type: application/json'
200Response example
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "PENDING",
  "paymentMethod": "PIX",
  "amount": 10000,
  "currency": "BRL",
  "description": "Pedido #1234",
  "customer": {
    "name": "João da Silva",
    "email": "joao@email.com",
    "document": "123.456.789-**"
  },
  "paymentDetails": {
    "qrCode": "00020126580014br.gov.bcb.pix...",
    "qrCodeUrl": "https://qrcode.example.com/...",
    "expiresAt": "2025-01-15T10:30:00Z"
  },
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z",
  "paidAt": "2025-01-15T10:30:00Z",
  "refunds": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amount": 5000,
      "originalAmount": 10000,
      "status": "COMPLETED",
      "requestedAt": "2025-01-15T10:30:00Z",
      "completedAt": "2025-01-15T10:30:00Z"
    }
  ],
  "idempotencyKey": "string"
}