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): `buyer` e `buyerId` são opcionais. 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). **Cartão salvo (somente Stripe):** a cobrança internacional com `card.token` (`pm_…` do Elements) grava o cartão. Quando a transação fica `PAID`, a resposta inclui `card.token`. Uma nova cobrança do mesmo seller reenvia só esse valor, sem PAN, validade ou CVV. Se o emissor exigir 3DS, a resposta volta `PENDING` com `pendingAction.clientSecret`. O fluxo Brasil (`card.cardToken`) não muda. **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 quando o seller tem 3DS obrigatório (toggle admin): POST /v1/transactions/threeds/setup → authenticate → (challenge-result) e informa `threeDs` com o resultado.

amountnumber · int64required

Valor na menor unidade da moeda (centavos para USD/EUR/BRL; unidades inteiras para JPY/KRW)

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. No sandbox, o primeiro termo dispara um cenário e o restante do nome segue normal: PAID, FAIL, REFUND, MED, MED_WON ou MED_LOST. Em produção o nome é apenas o nome do comprador.

documentTypeenumoptional

Tipo do documento. Opcional em PIX. Obrigatório em cartão BRL (CPF ou CNPJ); omita em transações internacionais.

documentNumberstringoptional

Número do documento (somente dígitos). Opcional em PIX. Obrigatório em cartão BRL; omita em transações internacionais.

emailstringoptional

E-mail do comprador. Obrigatório em transações internacionais (currency diferente de BRL).

phonestringoptional

Telefone do comprador

addressobject

zipCodestringrequired

CEP, apenas números

streetstringrequired

Logradouro

numberstringrequired

Número

complementstringoptional

Complemento

neighborhoodstringrequired

Bairro

citystringrequired

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`)

tokenstringoptional

Token dos Card Fields (`tokenize()`), o `pm_…` já salvo numa cobrança Stripe anterior, ou alias do Card Vault quando vault=CARD. Não envie PAN neste campo. No reuso Stripe não envie PAN, validade nem CVV.

vaultstringoptional

Cofre de tokenização. Use CARD para aliases do Card Vault do seller. Omita para PAN, `token` dos Card Fields ou `pm_` / `tok_` legado em `number`.

numberstringoptional

PAN de teste no sandbox. Legado: também aceita PaymentMethod (`pm_...`) ou Token Stripe (`tok_...`) quando `token` não é enviado. Em produção internacional prefira `card.token`.

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) ou alias do Card Vault quando vault=CARD

lastDigitsstringoptional

Últimos 4 dígitos do cartão (obrigatório com Card Vault — o alias não revela last4)

binstringoptional

BIN (6 dígitos) quando o vault não revela o PAN

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 — débito é sempre à vista e PIX ignora o campo. Com `paymentLinkId`, o teto é o `maxInstallments` do link; sem link, é o parcelamento máximo do seller. A parcela mínima é R$ 5,00. Default 1 (sem parcelamento).

threeDsobject

xidstringoptional

Transaction ID do 3DS. Usado em transações Visa. Omita se a autenticação não devolver o valor (ex.: Mastercard).

cavvstringrequired

Cardholder Authentication Verification Value

cavvResultCodestringoptional

Código de resultado do CAVV (ECI). Envie apenas se a autenticação devolver este valor.

secureVersionstringrequired

Versão do protocolo 3DS

directoryServerTransactionIdstringoptional

ID de transação do Directory Server. Obrigatório em transações Mastercard quando devolvido na autenticação.

threeDsServerTransactionIdstringoptional

ID de transação do servidor 3DS. Obrigatório em transações Amex quando devolvido na autenticação.

returnUrlstringoptional

URL HTTPS para onde o browser volta depois do 3DS internacional. Quando a cobrança exigir desafio, a resposta traz a URL do desafio em pendingAction.url.

pixKeystringoptional

Chave PIX de recebimento. Se omitida, a cobrança usa a chave padrão da conta. Se informada, precisa ser uma chave ativa deste seller.

seonSessionstringoptional

Session string gerada pelo SEON Device Fingerprinting SDK no browser/app. Necessária para device fingerprinting na análise antifraude.

splitarrayoptional

Split de receita na criação. Recebedores: a company dona, sub-sellers ativos da mesma company, ou a Reborn (CNPJ da plataforma). Soma FLAT+PERCENTAGE (sobre o bruto) não pode exceder `amount`; o restante fica no dono. Máximo 10 recebedores. Em cartão Dock, o split é enviado no `paymentSplit` da adquirente. Recebedor sem slug Dock (ex.: company gateway) é liquidado na Reborn só na adquirente; ledger e transaction_splits continuam no recebedor original.

Nenhum item adicionado.

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 comprador

namestringoptional

Nome do comprador

Example: João da Silva

emailstringoptional

E-mail do comprador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: ***456789-**

payerobjectoptional

Dados de quem pagou

namestringoptional

Nome do pagador

Example: Maria Souza

documentstringoptional

Documento mascarado

Example: ***456789-**

bankobjectoptional

Conta de origem do pagamento

ispbstringoptional

ISPB da instituição

Example: 22896431

branchstringoptional

Agência

Example: 1

accountstringoptional

Número da conta

Example: 308112970

accountTypestringoptional

Tipo da conta

Example: CHECKING_ACCOUNT

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)

endToEndIdstringoptional

End-to-end id (E2E) do PIX pago. Nulo enquanto o pagamento não é confirmado e em cobranças que não são PIX.

Example: E12345678202610091800abcd

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)

pendingActionobjectoptional

Ação adicional no browser (ex: 3DS)

clientSecretstringrequired

Segredo do cliente para concluir o 3DS no browser

nextActionTypestring · enumoptional

Tipo da próxima ação 3DS

Example: challenge

challengeredirect

providerstringoptional

Fluxo Reborn

Example: reborn

publishableKeystringoptional

Chave publicável do cliente 3DS Reborn para esta cobrança

urlstringoptional

URL do desafio 3DS. Redirecione o browser do comprador para concluir a autenticação. Depois do retorno em returnUrl, confirme a transação.

Example: https://authenticate.example/3ds/challenge

feeAmountinteger · int64optional

Taxa debitada do seller, em centavos

netAmountinteger · int64optional

Valor líquido creditado ao seller, em centavos

splitsarrayrequired

Regras de split de receita (vazio quando a transação não tem split)

sellerIdstring · uuidrequired

Seller recebedor

amountinteger · int64required

Valor destinado ao recebedor, em centavos

percentagenumberrequired

Percentual sobre o bruto

feeAmountinteger · int64required

Taxa de processamento absorvida por este recebedor, em centavos

netAmountinteger · int64required

Valor líquido creditado ao recebedor, em centavos

chargeProcessingFeebooleanrequired

Se este recebedor absorve taxa de processamento

liablebooleanrequired

Se este recebedor é responsável por estorno/chargeback

statusstring · enumrequired

Status da parcela

PENDINGPROCESSEDSETTLEDFAILEDREVERSED

cardobjectoptional

Cartão Stripe salvo para uma nova cobrança com card.token

tokenstringrequired

PaymentMethod reutilizável (`pm_…`). Envie em card.token.

Example: pm_123

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 comprador

namestringoptional

Nome do comprador

Example: João da Silva

emailstringoptional

E-mail do comprador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: ***456789-**

payerobjectoptional

Dados de quem pagou

namestringoptional

Nome do pagador

Example: Maria Souza

documentstringoptional

Documento mascarado

Example: ***456789-**

bankobjectoptional

Conta de origem do pagamento

ispbstringoptional

ISPB da instituição

Example: 22896431

branchstringoptional

Agência

Example: 1

accountstringoptional

Número da conta

Example: 308112970

accountTypestringoptional

Tipo da conta

Example: CHECKING_ACCOUNT

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)

endToEndIdstringoptional

End-to-end id (E2E) do PIX pago. Nulo enquanto o pagamento não é confirmado e em cobranças que não são PIX.

Example: E12345678202610091800abcd

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)

pendingActionobjectoptional

Ação adicional no browser (ex: 3DS)

clientSecretstringrequired

Segredo do cliente para concluir o 3DS no browser

nextActionTypestring · enumoptional

Tipo da próxima ação 3DS

Example: challenge

challengeredirect

providerstringoptional

Fluxo Reborn

Example: reborn

publishableKeystringoptional

Chave publicável do cliente 3DS Reborn para esta cobrança

urlstringoptional

URL do desafio 3DS. Redirecione o browser do comprador para concluir a autenticação. Depois do retorno em returnUrl, confirme a transação.

Example: https://authenticate.example/3ds/challenge

feeAmountinteger · int64optional

Taxa debitada do seller, em centavos

netAmountinteger · int64optional

Valor líquido creditado ao seller, em centavos

splitsarrayrequired

Regras de split de receita (vazio quando a transação não tem split)

sellerIdstring · uuidrequired

Seller recebedor

amountinteger · int64required

Valor destinado ao recebedor, em centavos

percentagenumberrequired

Percentual sobre o bruto

feeAmountinteger · int64required

Taxa de processamento absorvida por este recebedor, em centavos

netAmountinteger · int64required

Valor líquido creditado ao recebedor, em centavos

chargeProcessingFeebooleanrequired

Se este recebedor absorve taxa de processamento

liablebooleanrequired

Se este recebedor é responsável por estorno/chargeback

statusstring · enumrequired

Status da parcela

PENDINGPROCESSEDSETTLEDFAILEDREVERSED

cardobjectoptional

Cartão Stripe salvo para uma nova cobrança com card.token

tokenstringrequired

PaymentMethod reutilizável (`pm_…`). Envie em card.token.

Example: pm_123

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 comprador

namestringoptional

Nome do comprador

Example: João da Silva

emailstringoptional

E-mail do comprador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: ***456789-**

payerobjectoptional

Dados de quem pagou

namestringoptional

Nome do pagador

Example: Maria Souza

documentstringoptional

Documento mascarado

Example: ***456789-**

bankobjectoptional

Conta de origem do pagamento

ispbstringoptional

ISPB da instituição

Example: 22896431

branchstringoptional

Agência

Example: 1

accountstringoptional

Número da conta

Example: 308112970

accountTypestringoptional

Tipo da conta

Example: CHECKING_ACCOUNT

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)

endToEndIdstringoptional

End-to-end id (E2E) do PIX pago. Nulo enquanto o pagamento não é confirmado e em cobranças que não são PIX.

Example: E12345678202610091800abcd

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)

pendingActionobjectoptional

Ação adicional no browser (ex: 3DS)

clientSecretstringrequired

Segredo do cliente para concluir o 3DS no browser

nextActionTypestring · enumoptional

Tipo da próxima ação 3DS

Example: challenge

challengeredirect

providerstringoptional

Fluxo Reborn

Example: reborn

publishableKeystringoptional

Chave publicável do cliente 3DS Reborn para esta cobrança

urlstringoptional

URL do desafio 3DS. Redirecione o browser do comprador para concluir a autenticação. Depois do retorno em returnUrl, confirme a transação.

Example: https://authenticate.example/3ds/challenge

feeAmountinteger · int64optional

Taxa debitada do seller, em centavos

netAmountinteger · int64optional

Valor líquido creditado ao seller, em centavos

splitsarrayrequired

Regras de split de receita (vazio quando a transação não tem split)

sellerIdstring · uuidrequired

Seller recebedor

amountinteger · int64required

Valor destinado ao recebedor, em centavos

percentagenumberrequired

Percentual sobre o bruto

feeAmountinteger · int64required

Taxa de processamento absorvida por este recebedor, em centavos

netAmountinteger · int64required

Valor líquido creditado ao recebedor, em centavos

chargeProcessingFeebooleanrequired

Se este recebedor absorve taxa de processamento

liablebooleanrequired

Se este recebedor é responsável por estorno/chargeback

statusstring · enumrequired

Status da parcela

PENDINGPROCESSEDSETTLEDFAILEDREVERSED

cardobjectoptional

Cartão Stripe salvo para uma nova cobrança com card.token

tokenstringrequired

PaymentMethod reutilizável (`pm_…`). Envie em card.token.

Example: pm_123

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 comprador

namestringoptional

Nome do comprador

Example: João da Silva

emailstringoptional

E-mail do comprador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: ***456789-**

payerobjectoptional

Dados de quem pagou

namestringoptional

Nome do pagador

Example: Maria Souza

documentstringoptional

Documento mascarado

Example: ***456789-**

bankobjectoptional

Conta de origem do pagamento

ispbstringoptional

ISPB da instituição

Example: 22896431

branchstringoptional

Agência

Example: 1

accountstringoptional

Número da conta

Example: 308112970

accountTypestringoptional

Tipo da conta

Example: CHECKING_ACCOUNT

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)

endToEndIdstringoptional

End-to-end id (E2E) do PIX pago. Nulo enquanto o pagamento não é confirmado e em cobranças que não são PIX.

Example: E12345678202610091800abcd

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)

pendingActionobjectoptional

Ação adicional no browser (ex: 3DS)

clientSecretstringrequired

Segredo do cliente para concluir o 3DS no browser

nextActionTypestring · enumoptional

Tipo da próxima ação 3DS

Example: challenge

challengeredirect

providerstringoptional

Fluxo Reborn

Example: reborn

publishableKeystringoptional

Chave publicável do cliente 3DS Reborn para esta cobrança

urlstringoptional

URL do desafio 3DS. Redirecione o browser do comprador para concluir a autenticação. Depois do retorno em returnUrl, confirme a transação.

Example: https://authenticate.example/3ds/challenge

feeAmountinteger · int64optional

Taxa debitada do seller, em centavos

netAmountinteger · int64optional

Valor líquido creditado ao seller, em centavos

splitsarrayrequired

Regras de split de receita (vazio quando a transação não tem split)

sellerIdstring · uuidrequired

Seller recebedor

amountinteger · int64required

Valor destinado ao recebedor, em centavos

percentagenumberrequired

Percentual sobre o bruto

feeAmountinteger · int64required

Taxa de processamento absorvida por este recebedor, em centavos

netAmountinteger · int64required

Valor líquido creditado ao recebedor, em centavos

chargeProcessingFeebooleanrequired

Se este recebedor absorve taxa de processamento

liablebooleanrequired

Se este recebedor é responsável por estorno/chargeback

statusstring · enumrequired

Status da parcela

PENDINGPROCESSEDSETTLEDFAILEDREVERSED

cardobjectoptional

Cartão Stripe salvo para uma nova cobrança com card.token

tokenstringrequired

PaymentMethod reutilizável (`pm_…`). Envie em card.token.

Example: pm_123

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 comprador

namestringoptional

Nome do comprador

Example: João da Silva

emailstringoptional

E-mail do comprador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: ***456789-**

payerobjectoptional

Dados de quem pagou

namestringoptional

Nome do pagador

Example: Maria Souza

documentstringoptional

Documento mascarado

Example: ***456789-**

bankobjectoptional

Conta de origem do pagamento

ispbstringoptional

ISPB da instituição

Example: 22896431

branchstringoptional

Agência

Example: 1

accountstringoptional

Número da conta

Example: 308112970

accountTypestringoptional

Tipo da conta

Example: CHECKING_ACCOUNT

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)

endToEndIdstringoptional

End-to-end id (E2E) do PIX pago. Nulo enquanto o pagamento não é confirmado e em cobranças que não são PIX.

Example: E12345678202610091800abcd

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)

pendingActionobjectoptional

Ação adicional no browser (ex: 3DS)

clientSecretstringrequired

Segredo do cliente para concluir o 3DS no browser

nextActionTypestring · enumoptional

Tipo da próxima ação 3DS

Example: challenge

challengeredirect

providerstringoptional

Fluxo Reborn

Example: reborn

publishableKeystringoptional

Chave publicável do cliente 3DS Reborn para esta cobrança

urlstringoptional

URL do desafio 3DS. Redirecione o browser do comprador para concluir a autenticação. Depois do retorno em returnUrl, confirme a transação.

Example: https://authenticate.example/3ds/challenge

feeAmountinteger · int64optional

Taxa debitada do seller, em centavos

netAmountinteger · int64optional

Valor líquido creditado ao seller, em centavos

splitsarrayrequired

Regras de split de receita (vazio quando a transação não tem split)

sellerIdstring · uuidrequired

Seller recebedor

amountinteger · int64required

Valor destinado ao recebedor, em centavos

percentagenumberrequired

Percentual sobre o bruto

feeAmountinteger · int64required

Taxa de processamento absorvida por este recebedor, em centavos

netAmountinteger · int64required

Valor líquido creditado ao recebedor, em centavos

chargeProcessingFeebooleanrequired

Se este recebedor absorve taxa de processamento

liablebooleanrequired

Se este recebedor é responsável por estorno/chargeback

statusstring · enumrequired

Status da parcela

PENDINGPROCESSEDSETTLEDFAILEDREVERSED

cardobjectoptional

Cartão Stripe salvo para uma nova cobrança com card.token

tokenstringrequired

PaymentMethod reutilizável (`pm_…`). Envie em card.token.

Example: pm_123

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 comprador

namestringoptional

Nome do comprador

Example: João da Silva

emailstringoptional

E-mail do comprador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: ***456789-**

payerobjectoptional

Dados de quem pagou

namestringoptional

Nome do pagador

Example: Maria Souza

documentstringoptional

Documento mascarado

Example: ***456789-**

bankobjectoptional

Conta de origem do pagamento

ispbstringoptional

ISPB da instituição

Example: 22896431

branchstringoptional

Agência

Example: 1

accountstringoptional

Número da conta

Example: 308112970

accountTypestringoptional

Tipo da conta

Example: CHECKING_ACCOUNT

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)

endToEndIdstringoptional

End-to-end id (E2E) do PIX pago. Nulo enquanto o pagamento não é confirmado e em cobranças que não são PIX.

Example: E12345678202610091800abcd

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)

pendingActionobjectoptional

Ação adicional no browser (ex: 3DS)

clientSecretstringrequired

Segredo do cliente para concluir o 3DS no browser

nextActionTypestring · enumoptional

Tipo da próxima ação 3DS

Example: challenge

challengeredirect

providerstringoptional

Fluxo Reborn

Example: reborn

publishableKeystringoptional

Chave publicável do cliente 3DS Reborn para esta cobrança

urlstringoptional

URL do desafio 3DS. Redirecione o browser do comprador para concluir a autenticação. Depois do retorno em returnUrl, confirme a transação.

Example: https://authenticate.example/3ds/challenge

feeAmountinteger · int64optional

Taxa debitada do seller, em centavos

netAmountinteger · int64optional

Valor líquido creditado ao seller, em centavos

splitsarrayrequired

Regras de split de receita (vazio quando a transação não tem split)

sellerIdstring · uuidrequired

Seller recebedor

amountinteger · int64required

Valor destinado ao recebedor, em centavos

percentagenumberrequired

Percentual sobre o bruto

feeAmountinteger · int64required

Taxa de processamento absorvida por este recebedor, em centavos

netAmountinteger · int64required

Valor líquido creditado ao recebedor, em centavos

chargeProcessingFeebooleanrequired

Se este recebedor absorve taxa de processamento

liablebooleanrequired

Se este recebedor é responsável por estorno/chargeback

statusstring · enumrequired

Status da parcela

PENDINGPROCESSEDSETTLEDFAILEDREVERSED

cardobjectoptional

Cartão Stripe salvo para uma nova cobrança com card.token

tokenstringrequired

PaymentMethod reutilizável (`pm_…`). Envie em card.token.

Example: pm_123

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 comprador

namestringoptional

Nome do comprador

Example: João da Silva

emailstringoptional

E-mail do comprador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: ***456789-**

payerobjectoptional

Dados de quem pagou

namestringoptional

Nome do pagador

Example: Maria Souza

documentstringoptional

Documento mascarado

Example: ***456789-**

bankobjectoptional

Conta de origem do pagamento

ispbstringoptional

ISPB da instituição

Example: 22896431

branchstringoptional

Agência

Example: 1

accountstringoptional

Número da conta

Example: 308112970

accountTypestringoptional

Tipo da conta

Example: CHECKING_ACCOUNT

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)

endToEndIdstringoptional

End-to-end id (E2E) do PIX pago. Nulo enquanto o pagamento não é confirmado e em cobranças que não são PIX.

Example: E12345678202610091800abcd

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)

pendingActionobjectoptional

Ação adicional no browser (ex: 3DS)

clientSecretstringrequired

Segredo do cliente para concluir o 3DS no browser

nextActionTypestring · enumoptional

Tipo da próxima ação 3DS

Example: challenge

challengeredirect

providerstringoptional

Fluxo Reborn

Example: reborn

publishableKeystringoptional

Chave publicável do cliente 3DS Reborn para esta cobrança

urlstringoptional

URL do desafio 3DS. Redirecione o browser do comprador para concluir a autenticação. Depois do retorno em returnUrl, confirme a transação.

Example: https://authenticate.example/3ds/challenge

feeAmountinteger · int64optional

Taxa debitada do seller, em centavos

netAmountinteger · int64optional

Valor líquido creditado ao seller, em centavos

splitsarrayrequired

Regras de split de receita (vazio quando a transação não tem split)

sellerIdstring · uuidrequired

Seller recebedor

amountinteger · int64required

Valor destinado ao recebedor, em centavos

percentagenumberrequired

Percentual sobre o bruto

feeAmountinteger · int64required

Taxa de processamento absorvida por este recebedor, em centavos

netAmountinteger · int64required

Valor líquido creditado ao recebedor, em centavos

chargeProcessingFeebooleanrequired

Se este recebedor absorve taxa de processamento

liablebooleanrequired

Se este recebedor é responsável por estorno/chargeback

statusstring · enumrequired

Status da parcela

PENDINGPROCESSEDSETTLEDFAILEDREVERSED

cardobjectoptional

Cartão Stripe salvo para uma nova cobrança com card.token

tokenstringrequired

PaymentMethod reutilizável (`pm_…`). Envie em card.token.

Example: pm_123

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": "***456789-**"
  },
  "payer": {
    "name": "Maria Souza",
    "document": "***456789-**",
    "bank": {
      "ispb": "22896431",
      "branch": "1",
      "account": "308112970",
      "accountType": "CHECKING_ACCOUNT"
    }
  },
  "paymentDetails": {
    "qrCode": "00020126580014br.gov.bcb.pix...",
    "qrCodeUrl": "https://qrcode.example.com/...",
    "expiresAt": "2025-01-15T10:30:00Z",
    "endToEndId": "E12345678202610091800abcd"
  },
  "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",
  "pendingAction": {
    "clientSecret": "string",
    "nextActionType": "challenge",
    "provider": "reborn",
    "publishableKey": "string",
    "url": "https://authenticate.example/3ds/challenge"
  },
  "feeAmount": 1,
  "netAmount": 1,
  "splits": [
    {
      "sellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amount": 1,
      "percentage": 1,
      "feeAmount": 1,
      "netAmount": 1,
      "chargeProcessingFee": false,
      "liable": false,
      "status": "PENDING"
    }
  ],
  "card": {
    "token": "pm_123"
  }
}