curl --location 'https://api.delbank.com.br/baas/api/v1/split-payments/payouts?beneficiaryDocument=12345678901&status=ERROR&page=1&limit=10' \
--header 'x-delbank-api-key: {{apiKey}}'
curl --location 'https://api.delbank.com.br/baas/api/v1/split-payments/payouts?startDate=2025-01-01&endDate=2025-01-31&include=metadata&page=1&limit=20' \
--header 'x-delbank-api-key: {{apiKey}}'
[
{
"id": 98765,
"splitOrderId": 12345,
"beneficiary": {
"bankIspb": "ISPBCODE",
"bankAccountNumber": "12345",
"bankAccountBranch": "0001",
"holderDocument": "12345678901",
"holderName": "Nome do beneficiário",
"bankAccountType": "Tipo da conta bancária do beneficiário"
},
"transferType": {
"name": "PIX_MANUAL",
"description": "Pix Manual",
"value": 2
},
"instructionType": {
"name": "PERCENTAGE",
"description": "Porcentagem",
"value": 0
},
"instructionAmount": 85.00,
"amount": 8.29,
"paymentDate": "2025-09-22T12:00:00.000Z",
"status": {
"name": "ERROR",
"description": "Error",
"value": 2
},
"transactionId": "ID-DO-SPLIT-CASHOUT",
"endToEndId": "E2E-DO-SPLIT-CASHOUT",
"errorMessage": "Banco rejeitou a transferência",
"paidAt": "2025-09-22T12:00:00.000Z",
"createdAt": "2025-09-22T12:00:00.000Z",
"updatedAt": "2025-09-22T12:00:00.000Z",
"splitOrder": {
"id": 12345,
"transactionOriginalId": "ID-DO-CASHIN",
"grossAmount": 10.00,
"tariffAmount": 0.25,
"splitBaseAmount": 9.75,
"source": {
"name": "QR_CODE",
"description": "QrCode",
"value": 0
},
"createdAt": "2025-09-22T12:00:00.000Z",
}
}
]
{
"errors": [
"O valor de 'status' não é um status válido."
]
}
Split de Pagamentos
Consultar payouts de split
Liste payouts por beneficiário, data, status e paginação.
GET
/
baas
/
api
/
v1
/
split-payments
/
payouts
curl --location 'https://api.delbank.com.br/baas/api/v1/split-payments/payouts?beneficiaryDocument=12345678901&status=ERROR&page=1&limit=10' \
--header 'x-delbank-api-key: {{apiKey}}'
curl --location 'https://api.delbank.com.br/baas/api/v1/split-payments/payouts?startDate=2025-01-01&endDate=2025-01-31&include=metadata&page=1&limit=20' \
--header 'x-delbank-api-key: {{apiKey}}'
[
{
"id": 98765,
"splitOrderId": 12345,
"beneficiary": {
"bankIspb": "ISPBCODE",
"bankAccountNumber": "12345",
"bankAccountBranch": "0001",
"holderDocument": "12345678901",
"holderName": "Nome do beneficiário",
"bankAccountType": "Tipo da conta bancária do beneficiário"
},
"transferType": {
"name": "PIX_MANUAL",
"description": "Pix Manual",
"value": 2
},
"instructionType": {
"name": "PERCENTAGE",
"description": "Porcentagem",
"value": 0
},
"instructionAmount": 85.00,
"amount": 8.29,
"paymentDate": "2025-09-22T12:00:00.000Z",
"status": {
"name": "ERROR",
"description": "Error",
"value": 2
},
"transactionId": "ID-DO-SPLIT-CASHOUT",
"endToEndId": "E2E-DO-SPLIT-CASHOUT",
"errorMessage": "Banco rejeitou a transferência",
"paidAt": "2025-09-22T12:00:00.000Z",
"createdAt": "2025-09-22T12:00:00.000Z",
"updatedAt": "2025-09-22T12:00:00.000Z",
"splitOrder": {
"id": 12345,
"transactionOriginalId": "ID-DO-CASHIN",
"grossAmount": 10.00,
"tariffAmount": 0.25,
"splitBaseAmount": 9.75,
"source": {
"name": "QR_CODE",
"description": "QrCode",
"value": 0
},
"createdAt": "2025-09-22T12:00:00.000Z",
}
}
]
{
"errors": [
"O valor de 'status' não é um status válido."
]
}
Para o contexto completo, veja o guia Ordens de Split de Pagamentos.
Headers
string
required
Sua API key.
Query params
string
CPF ou CNPJ do beneficiário. Deve ser um documento válido.
string
Nome do beneficiário ou fragmento do nome para busca parcial.
string
Data inicial para filtrar pela criação do payout. Formato aceito pela API, por exemplo
2025-01-31.string
Data final para filtrar pela criação do payout. Formato aceito pela API, por exemplo
2025-01-31.string
Estado do payout. Valores aceitos:
PENDING, PROCESSING, SUCCESS, ERROR, SCHEDULED ou CANCELED.number
default:"1"
Número da página. Padrão:
1.number
default:"10"
Quantidade de itens por página. Padrão:
10.string
Quando
metadata é informado, a resposta retorna data e metadata em vez do array simples.Response
number
required
Identificador do payout.
number
Identificador da ordem de split à qual o payout pertence.
object
Dados do beneficiário, incluindo documento e nome.
string
Tipo de transferência do payout.
string
Tipo de regra que originou o payout, como
PERCENTAGE ou FIXED.number
Valor da instrução original aplicada.
number
Valor do payout.
string
Data prevista para o pagamento.
string
Status atual do payout:
PENDING, PROCESSING, SUCCESS, ERROR, SCHEDULED ou CANCELED.string
ID da transação associada ao payout, quando disponível.
string
Identificador de ponta a ponta da transferência, quando disponível.
string
Mensagem de erro do processamento, quando existir.
object
Detalhes do cancelamento, quando o payout foi cancelado.
string
Data/hora do pagamento concluído.
string
Data/hora de criação do payout.
string
Data/hora da última atualização.
curl --location 'https://api.delbank.com.br/baas/api/v1/split-payments/payouts?beneficiaryDocument=12345678901&status=ERROR&page=1&limit=10' \
--header 'x-delbank-api-key: {{apiKey}}'
curl --location 'https://api.delbank.com.br/baas/api/v1/split-payments/payouts?startDate=2025-01-01&endDate=2025-01-31&include=metadata&page=1&limit=20' \
--header 'x-delbank-api-key: {{apiKey}}'
[
{
"id": 98765,
"splitOrderId": 12345,
"beneficiary": {
"bankIspb": "ISPBCODE",
"bankAccountNumber": "12345",
"bankAccountBranch": "0001",
"holderDocument": "12345678901",
"holderName": "Nome do beneficiário",
"bankAccountType": "Tipo da conta bancária do beneficiário"
},
"transferType": {
"name": "PIX_MANUAL",
"description": "Pix Manual",
"value": 2
},
"instructionType": {
"name": "PERCENTAGE",
"description": "Porcentagem",
"value": 0
},
"instructionAmount": 85.00,
"amount": 8.29,
"paymentDate": "2025-09-22T12:00:00.000Z",
"status": {
"name": "ERROR",
"description": "Error",
"value": 2
},
"transactionId": "ID-DO-SPLIT-CASHOUT",
"endToEndId": "E2E-DO-SPLIT-CASHOUT",
"errorMessage": "Banco rejeitou a transferência",
"paidAt": "2025-09-22T12:00:00.000Z",
"createdAt": "2025-09-22T12:00:00.000Z",
"updatedAt": "2025-09-22T12:00:00.000Z",
"splitOrder": {
"id": 12345,
"transactionOriginalId": "ID-DO-CASHIN",
"grossAmount": 10.00,
"tariffAmount": 0.25,
"splitBaseAmount": 9.75,
"source": {
"name": "QR_CODE",
"description": "QrCode",
"value": 0
},
"createdAt": "2025-09-22T12:00:00.000Z",
}
}
]
{
"errors": [
"O valor de 'status' não é um status válido."
]
}