Solicitar repasse via PIX
post
https://sandbox-api.rebornpay.io/v1/payouts/pixAuth obrigatóriaSolicita o repasse (saque) do saldo do seller via PIX. **Conta dedicada (DEDICATED):** o destino é sempre a chave PIX cadastrada na conta bancária. **Bolsão (POOL):** informe `destinationKey`, `destinationKeyType` e `customer` (titular da chave) para sacar para qualquer conta PIX; sem `destinationKey`, usa a chave cadastrada. 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.
Headers
X-Api-KeystringrequiredAPI Key do seller (header)
Body
application/jsonamountnumber · int64requiredcurrencystringrequireddestinationKeystringoptionaldestinationKeyTypestringoptionaldescriptionstringoptionalcustomerobjectfullNamestringrequiredNome completo do pagador
documentTypeenumrequiredTipo do documento
documentNumberstringrequiredNúmero do documento (somente dígitos)
emailstringoptionalE-mail do pagador
phonestringoptionalTelefone do pagador
birthstringoptionalData de nascimento (ISO 8601)
Responses
200Repasse já existente (replay idempotente)
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringrequireddestinationKeyTypestringrequireddescriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptional201Repasse solicitado.
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringrequireddestinationKeyTypestringrequireddescriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptional401API Key ausente ou inválida
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringrequireddestinationKeyTypestringrequireddescriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptional404Seller não encontrado
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringrequireddestinationKeyTypestringrequireddescriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptional409Idempotency-Key reutilizada com parâmetros diferentes
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringrequireddestinationKeyTypestringrequireddescriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptional422Seller não está pronto para transacionar (KYC pendente, inativo) ou saldo insuficiente
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringrequireddestinationKeyTypestringrequireddescriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptional502Falha ao comunicar com o gateway de pagamento
pixTransactionIdstring · uuidrequiredstatusstringrequiredamountinteger · int64requiredcurrencystringrequireddestinationKeystringrequireddestinationKeyTypestringrequireddescriptionstringoptionalcreatedAtstring · date-timerequiredrequiresApprovalbooleanrequiredidempotencyKeystringoptionalpaidAmountCentsinteger · int64optionalpendingAmountCentsinteger · int64optionalgowdEndToEndIdstringoptionalbatchTransactionsarrayrequiredsequenceinteger · int32optionalstatusstringoptionalamountCentsinteger · int64optionalendToEndIdstringoptionalcurl -X POST 'https://sandbox-api.rebornpay.io/v1/payouts/pix' \ -H 'X-Api-Key: $API_KEY' \ -H 'Content-Type: application/json'200Response example
{
"pixTransactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"amount": 1,
"currency": "string",
"destinationKey": "string",
"destinationKeyType": "string",
"description": "string",
"createdAt": "2025-01-15T10:30:00Z",
"requiresApproval": false,
"idempotencyKey": "string",
"paidAmountCents": 1,
"pendingAmountCents": 1,
"gowdEndToEndId": "string",
"batchTransactions": [
{
"sequence": 1,
"status": "string",
"amountCents": 1,
"endToEndId": "string"
}
]
}