Solicitar repasse via PIX
https://sandbox-api.rebornpay.io/v1/payouts/pixAuth obrigatóriaSolicita o repasse (saque) do saldo do seller via PIX. Qualquer seller (conta dedicada ou bolsão) pode sacar para qualquer chave PIX ou dados bancários. Informe `destinationKey` para uma chave avulsa. O titular sai do DICT e volta em `recipient` quando o pagamento confirma. `customer` é opcional nesse caso. Para dados bancários, informe `bankAccount` e `customer` (nome, documentType e documentNumber). Sem `destinationKey` e sem `bankAccount`, usa a chave PIX cadastrada. Não envie `destinationKey` e `bankAccount` juntos. Dependendo da modalidade da conta, o repasse pode exigir aprovação manual antes de ser enviado ao gateway (`requiresApproval: true` na resposta), ou ser processado imediatamente. **Idempotência:** envie o header `Idempotency-Key` (recomendado). A chave é sempre persistida e retornada na resposta — use-a para retentativas seguras. A criação responde `PENDING` e pode vir sem `gowdEndToEndId` e sem `recipient`. Os dois chegam depois, no GET ou no webhook, quando o pagamento confirma. Em um saque para chave PIX, `recipient` é o titular e a conta bancária associados à chave no DICT. O status atual (incluindo lote parcial) é consultado em `GET /v1/payouts/{pixTransactionId}` ou `GET /v1/payouts?idempotencyKey=`. A resposta usa o mesmo schema deste POST.
Headers
X-Api-KeystringrequiredAPI Key do seller (header)
Body
application/jsonamountnumber · int64requiredcurrencystringrequireddestinationKeystringoptionalChave PIX de destino. Sem este campo e sem bankAccount, usa a chave cadastrada.
destinationKeyTypestringoptionaldescriptionstringoptionalTexto livre do saque. No sandbox, o primeiro termo dispara um cenário: PAID, ERROR, REJECTED, SPLIT_PAID ou SPLIT_PARTIAL. SPLIT_PAID e SPLIT_PARTIAL exigem amount acima de R$ 15.000. Em produção a descrição é apenas texto.
customerobjectfullNamestringoptionalNome completo. Opcional no saque por chave: o titular sai do DICT.
documentTypeenumoptionalTipo do documento. Obrigatório só com bankAccount.
documentNumberstringoptionalNúmero do documento (somente dígitos). Obrigatório só com bankAccount.
emailstringoptionalE-mail do pagador
phonestringoptionalTelefone do pagador
birthstringoptionalData de nascimento (ISO 8601)
bankAccountobjectispbstringoptionalISPB do banco (8 dígitos). Informe este campo ou bankNumber.
bankNumberstringoptionalCódigo do banco (3 a 8 dígitos). Informe este campo ou ispb.
branchNumberstringrequiredAgência, só dígitos
accountNumberstringrequiredNúmero da conta, com dígito se houver
accountTypeenumrequiredTipo da conta
Responses
200Repasse já existente (replay idempotente)
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringoptionaldestinationKeyTypestringoptionalbankAccountobjectoptionalispbstringoptionalbankNumberstringoptionalbranchNumberstringrequiredaccountNumberstringrequiredaccountTypestringrequiredrecipientobjectoptionalTitular e conta bancária resolvidos no DICT para a chave PIX de destino. Nulo até o provedor confirmar o pagamento.
namestringoptionalNome do titular da chave
Example: Joao da Silva
documentTypestringoptionalTipo do documento do titular
Example: CPF
documentNumberstringoptionalDocumento mascarado do titular
Example: ***456789-**
bankobjectoptionalConta bancária associada à chave PIX no DICT
ispbstringoptionalISPB da instituição
Example: 12345678
namestringoptionalNome da instituição
Example: Banco Exemplo S.A.
bankNumberstringoptionalCódigo COMPE da instituição
Example: 237
branchNumberstringoptionalAgência
Example: 0001
accountNumberstringoptionalNúmero da conta
Example: 1234567
accountTypestringoptionalTipo da conta informado pelo provedor
Example: CHECKING_ACCOUNT
descriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalerrorMessagestringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptional201Repasse solicitado.
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringoptionaldestinationKeyTypestringoptionalbankAccountobjectoptionalispbstringoptionalbankNumberstringoptionalbranchNumberstringrequiredaccountNumberstringrequiredaccountTypestringrequiredrecipientobjectoptionalTitular e conta bancária resolvidos no DICT para a chave PIX de destino. Nulo até o provedor confirmar o pagamento.
namestringoptionalNome do titular da chave
Example: Joao da Silva
documentTypestringoptionalTipo do documento do titular
Example: CPF
documentNumberstringoptionalDocumento mascarado do titular
Example: ***456789-**
bankobjectoptionalConta bancária associada à chave PIX no DICT
ispbstringoptionalISPB da instituição
Example: 12345678
namestringoptionalNome da instituição
Example: Banco Exemplo S.A.
bankNumberstringoptionalCódigo COMPE da instituição
Example: 237
branchNumberstringoptionalAgência
Example: 0001
accountNumberstringoptionalNúmero da conta
Example: 1234567
accountTypestringoptionalTipo da conta informado pelo provedor
Example: CHECKING_ACCOUNT
descriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalerrorMessagestringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptional401API Key ausente ou inválida
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringoptionaldestinationKeyTypestringoptionalbankAccountobjectoptionalispbstringoptionalbankNumberstringoptionalbranchNumberstringrequiredaccountNumberstringrequiredaccountTypestringrequiredrecipientobjectoptionalTitular e conta bancária resolvidos no DICT para a chave PIX de destino. Nulo até o provedor confirmar o pagamento.
namestringoptionalNome do titular da chave
Example: Joao da Silva
documentTypestringoptionalTipo do documento do titular
Example: CPF
documentNumberstringoptionalDocumento mascarado do titular
Example: ***456789-**
bankobjectoptionalConta bancária associada à chave PIX no DICT
ispbstringoptionalISPB da instituição
Example: 12345678
namestringoptionalNome da instituição
Example: Banco Exemplo S.A.
bankNumberstringoptionalCódigo COMPE da instituição
Example: 237
branchNumberstringoptionalAgência
Example: 0001
accountNumberstringoptionalNúmero da conta
Example: 1234567
accountTypestringoptionalTipo da conta informado pelo provedor
Example: CHECKING_ACCOUNT
descriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalerrorMessagestringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptional404Seller não encontrado
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringoptionaldestinationKeyTypestringoptionalbankAccountobjectoptionalispbstringoptionalbankNumberstringoptionalbranchNumberstringrequiredaccountNumberstringrequiredaccountTypestringrequiredrecipientobjectoptionalTitular e conta bancária resolvidos no DICT para a chave PIX de destino. Nulo até o provedor confirmar o pagamento.
namestringoptionalNome do titular da chave
Example: Joao da Silva
documentTypestringoptionalTipo do documento do titular
Example: CPF
documentNumberstringoptionalDocumento mascarado do titular
Example: ***456789-**
bankobjectoptionalConta bancária associada à chave PIX no DICT
ispbstringoptionalISPB da instituição
Example: 12345678
namestringoptionalNome da instituição
Example: Banco Exemplo S.A.
bankNumberstringoptionalCódigo COMPE da instituição
Example: 237
branchNumberstringoptionalAgência
Example: 0001
accountNumberstringoptionalNúmero da conta
Example: 1234567
accountTypestringoptionalTipo da conta informado pelo provedor
Example: CHECKING_ACCOUNT
descriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalerrorMessagestringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptional409Idempotency-Key reutilizada com parâmetros diferentes
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringoptionaldestinationKeyTypestringoptionalbankAccountobjectoptionalispbstringoptionalbankNumberstringoptionalbranchNumberstringrequiredaccountNumberstringrequiredaccountTypestringrequiredrecipientobjectoptionalTitular e conta bancária resolvidos no DICT para a chave PIX de destino. Nulo até o provedor confirmar o pagamento.
namestringoptionalNome do titular da chave
Example: Joao da Silva
documentTypestringoptionalTipo do documento do titular
Example: CPF
documentNumberstringoptionalDocumento mascarado do titular
Example: ***456789-**
bankobjectoptionalConta bancária associada à chave PIX no DICT
ispbstringoptionalISPB da instituição
Example: 12345678
namestringoptionalNome da instituição
Example: Banco Exemplo S.A.
bankNumberstringoptionalCódigo COMPE da instituição
Example: 237
branchNumberstringoptionalAgência
Example: 0001
accountNumberstringoptionalNúmero da conta
Example: 1234567
accountTypestringoptionalTipo da conta informado pelo provedor
Example: CHECKING_ACCOUNT
descriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalerrorMessagestringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptional422Seller não está pronto para transacionar (KYC pendente, inativo) ou saldo insuficiente
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringoptionaldestinationKeyTypestringoptionalbankAccountobjectoptionalispbstringoptionalbankNumberstringoptionalbranchNumberstringrequiredaccountNumberstringrequiredaccountTypestringrequiredrecipientobjectoptionalTitular e conta bancária resolvidos no DICT para a chave PIX de destino. Nulo até o provedor confirmar o pagamento.
namestringoptionalNome do titular da chave
Example: Joao da Silva
documentTypestringoptionalTipo do documento do titular
Example: CPF
documentNumberstringoptionalDocumento mascarado do titular
Example: ***456789-**
bankobjectoptionalConta bancária associada à chave PIX no DICT
ispbstringoptionalISPB da instituição
Example: 12345678
namestringoptionalNome da instituição
Example: Banco Exemplo S.A.
bankNumberstringoptionalCódigo COMPE da instituição
Example: 237
branchNumberstringoptionalAgência
Example: 0001
accountNumberstringoptionalNúmero da conta
Example: 1234567
accountTypestringoptionalTipo da conta informado pelo provedor
Example: CHECKING_ACCOUNT
descriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalerrorMessagestringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptional502Falha ao comunicar com o gateway de pagamento
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringoptionaldestinationKeyTypestringoptionalbankAccountobjectoptionalispbstringoptionalbankNumberstringoptionalbranchNumberstringrequiredaccountNumberstringrequiredaccountTypestringrequiredrecipientobjectoptionalTitular e conta bancária resolvidos no DICT para a chave PIX de destino. Nulo até o provedor confirmar o pagamento.
namestringoptionalNome do titular da chave
Example: Joao da Silva
documentTypestringoptionalTipo do documento do titular
Example: CPF
documentNumberstringoptionalDocumento mascarado do titular
Example: ***456789-**
bankobjectoptionalConta bancária associada à chave PIX no DICT
ispbstringoptionalISPB da instituição
Example: 12345678
namestringoptionalNome da instituição
Example: Banco Exemplo S.A.
bankNumberstringoptionalCódigo COMPE da instituição
Example: 237
branchNumberstringoptionalAgência
Example: 0001
accountNumberstringoptionalNúmero da conta
Example: 1234567
accountTypestringoptionalTipo da conta informado pelo provedor
Example: CHECKING_ACCOUNT
descriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalerrorMessagestringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptionalcurl -X POST 'https://sandbox-api.rebornpay.io/v1/payouts/pix' \ -H 'X-Api-Key: $API_KEY' \ -H 'Content-Type: application/json'{
"pixTransactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"amount": 1,
"currency": "string",
"destinationKey": "string",
"destinationKeyType": "string",
"bankAccount": {
"ispb": "string",
"bankNumber": "string",
"branchNumber": "string",
"accountNumber": "string",
"accountType": "string"
},
"recipient": {
"name": "Joao da Silva",
"documentType": "CPF",
"documentNumber": "***456789-**",
"bank": {
"ispb": "12345678",
"name": "Banco Exemplo S.A.",
"bankNumber": "237",
"branchNumber": "0001",
"accountNumber": "1234567",
"accountType": "CHECKING_ACCOUNT"
}
},
"description": "string",
"createdAt": "2025-01-15T10:30:00Z",
"requiresApproval": false,
"idempotencyKey": "string",
"paidAmountCents": 1,
"pendingAmountCents": 1,
"gowdEndToEndId": "string",
"errorMessage": "string",
"batchTransactions": [
{
"sequence": 1,
"status": "string",
"amountCents": 1,
"endToEndId": "string"
}
]
}