Get a payout
curl --request GET \
--url http://localhost:3000/api/integrations/breb/payouts/{payoutId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/integrations/breb/payouts/{payoutId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3000/api/integrations/breb/payouts/{payoutId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"payoutId": "<string>",
"status": "<string>",
"fromToken": "<string>",
"sourceAmount": "<string>",
"fees": [
{
"code": "swap",
"amountUsd": "<string>",
"to": "<string>",
"status": "quoted"
}
],
"quote": {
"display": "<string>",
"effectiveUsdCop": "<string>"
},
"receipt": {
"title": "Retiro Bre-B",
"status": "<string>",
"completedAt": "<string>",
"transactionType": "withdrawal",
"payoutId": "<string>",
"breBKey": "<string>",
"breBKeyLast4": "<string>",
"beneficiaryName": "<string>",
"totalPaid": {
"amount": "<string>",
"currency": "USD"
},
"exchangeRate": {
"display": "1 USD = 3000 COP",
"effectiveUsdCop": "<string>",
"sellRateUsdCop": "<string>"
},
"commission": {
"mode": "included_in_rate",
"displayAmount": "0",
"displayCurrency": "COP",
"note": "<string>"
},
"totalReceived": {
"amount": "<string>",
"currency": "COP"
},
"feesItemized": [
{
"code": "swap",
"amountUsd": "<string>",
"to": "<string>",
"status": "quoted"
}
]
},
"deposit": {
"chain": "<string>",
"currency": "<string>",
"address": "<string>",
"amount": "<string>"
},
"transaction": {
"approvalTarget": "<string>",
"to": "<string>",
"data": "<string>",
"value": "0"
},
"feeTransaction": {
"approvalTarget": "<string>",
"to": "<string>",
"data": "<string>",
"value": "0"
},
"destinationPreview": {
"accountOwnerName": "<string>",
"bankName": "<string>",
"documentLast4": "<string>"
}
}{
"error": "<string>",
"errorCode": "below_minimum"
}BRE-B
Get a payout
GET
/
api
/
integrations
/
breb
/
payouts
/
{payoutId}
Get a payout
curl --request GET \
--url http://localhost:3000/api/integrations/breb/payouts/{payoutId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/integrations/breb/payouts/{payoutId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3000/api/integrations/breb/payouts/{payoutId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"payoutId": "<string>",
"status": "<string>",
"fromToken": "<string>",
"sourceAmount": "<string>",
"fees": [
{
"code": "swap",
"amountUsd": "<string>",
"to": "<string>",
"status": "quoted"
}
],
"quote": {
"display": "<string>",
"effectiveUsdCop": "<string>"
},
"receipt": {
"title": "Retiro Bre-B",
"status": "<string>",
"completedAt": "<string>",
"transactionType": "withdrawal",
"payoutId": "<string>",
"breBKey": "<string>",
"breBKeyLast4": "<string>",
"beneficiaryName": "<string>",
"totalPaid": {
"amount": "<string>",
"currency": "USD"
},
"exchangeRate": {
"display": "1 USD = 3000 COP",
"effectiveUsdCop": "<string>",
"sellRateUsdCop": "<string>"
},
"commission": {
"mode": "included_in_rate",
"displayAmount": "0",
"displayCurrency": "COP",
"note": "<string>"
},
"totalReceived": {
"amount": "<string>",
"currency": "COP"
},
"feesItemized": [
{
"code": "swap",
"amountUsd": "<string>",
"to": "<string>",
"status": "quoted"
}
]
},
"deposit": {
"chain": "<string>",
"currency": "<string>",
"address": "<string>",
"amount": "<string>"
},
"transaction": {
"approvalTarget": "<string>",
"to": "<string>",
"data": "<string>",
"value": "0"
},
"feeTransaction": {
"approvalTarget": "<string>",
"to": "<string>",
"data": "<string>",
"value": "0"
},
"destinationPreview": {
"accountOwnerName": "<string>",
"bankName": "<string>",
"documentLast4": "<string>"
}
}{
"error": "<string>",
"errorCode": "below_minimum"
}Authorizations
Integration API key. Send as Bearer copby_live_pk_….
Path Parameters
Response
Payout
Consumer receipt (REQ-INT-RCPT-01). Fees are included in exchangeRate.effectiveUsdCop.
Use feesItemized only for partner backoffice / disputes.
Hide child attributes
Hide child attributes
Example:
"Retiro Bre-B"
Available options:
withdrawal Masked key (last4), e.g. ···3143