Requires an approved customer. Creates a Bre-B external account and
verifies name + key before returning the deposit transaction.
409 destination_mismatch if verify does not match. 409 needs_kyc if KYC is incomplete.
Integration API key. Send as Bearer copby_live_pk_….
Headers
Idempotency-Key
string
Replays the same payout when reused by this integration
Body
application/json
userAddress
string
required
Pattern: ^0x[a-fA-F0-9]{40}$
Example:
"0x2222222222222222222222222222222222222222"
destinationCop
string
required
Example:
"10000"
breBKey
string
required
accountOwnerName
string
required
fromToken
enum<string>
default:USDC
Available options:
USDC,
COPm
quoteId
string
Response
Prepared payout
payoutId
string
status
string
fromToken
string
sourceAmount
string
fees
object[]
Hide child attributes
fees.code
enum<string>
Available options:
swap,
bridge_fx,
bridge,
copby
fees.amountUsd
string
fees.to
string | null
fees.status
enum<string>
Available options:
quoted,
verified,
pending
quote
object
Hide child attributes
quote.display
string | null
quote.effectiveUsdCop
string | null
receipt
object
Consumer receipt (REQ-INT-RCPT-01). Fees are included in exchangeRate.effectiveUsdCop.
Use feesItemized only for partner backoffice / disputes.
Hide child attributes
receipt.title
string
Example:
"Retiro Bre-B"
receipt.status
string
receipt.completedAt
string | null
receipt.transactionType
enum<string>
Available options:
withdrawal
receipt.payoutId
string
receipt.breBKey
string | null
Masked key (last4), e.g. ···3143
receipt.breBKeyLast4
string | null
receipt.beneficiaryName
string | null
receipt.totalPaid
object
Hide child attributes
receipt.totalPaid.amount
string
receipt.totalPaid.currency
enum<string>
Available options:
USD
receipt.exchangeRate
object
Hide child attributes
receipt.exchangeRate.display
string | null
Example:
"1 USD = 3000 COP"
receipt.exchangeRate.effectiveUsdCop
string | null
receipt.exchangeRate.sellRateUsdCop
string | null
Wholesale Bridge rate (ops); hide on consumer UI
receipt.commission
object
Hide child attributes
receipt.commission.mode
enum<string>
Available options:
included_in_rate
receipt.commission.displayAmount
string
Example:
"0"
receipt.commission.displayCurrency
enum<string>
Available options:
COP,
USD
receipt.commission.note
string
receipt.totalReceived
object
Hide child attributes
receipt.totalReceived.amount
string
receipt.totalReceived.currency
enum<string>
Available options:
COP
receipt.feesItemized
object[]
Hide child attributes
receipt.feesItemized.code
enum<string>
Available options:
swap,
bridge_fx,
bridge,
copby
receipt.feesItemized.amountUsd
string
receipt.feesItemized.to
string | null
receipt.feesItemized.status
enum<string>
Available options:
quoted,
verified,
pending
deposit
object
Hide child attributes
deposit.chain
string
deposit.currency
string
deposit.address
string
deposit.amount
string
transaction
object
Hide child attributes
transaction.approvalTarget
string | null
transaction.to
string
transaction.data
string
transaction.value
string
Example:
"0"
feeTransaction
object
Hide child attributes
feeTransaction.approvalTarget
string | null
feeTransaction.to
string
feeTransaction.data
string
feeTransaction.value
string
Example:
"0"
destinationPreview
object
Hide child attributes
destinationPreview.accountOwnerName
string
destinationPreview.bankName
string | null
destinationPreview.documentLast4
string | null
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"COP By Integrations","colors":{"primary":"#1B4D3E","light":"#3D8B6E","dark":"#0F2E25"},"api":{"openapi":"openapi.yaml","params":{"expanded":"all"},"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["bash","javascript","python"],"prefill":true,"autogenerate":true},"url":"full"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cop-by","hasAudioNarration":false,"actualSubdomain":"cop-by","customDomains":["docs.copby.digitalcop.shop"],"gitSource":{"type":"github","owner":"cop-by","repo":"cop_by","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ac2c04fe76a8e73f703b1ba","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API reference","count":19},{"language":"default","tag":"BRE-B","count":9},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Settlement","count":4},{"language":"default","tag":"Start here","count":3},{"language":"default","tag":"Products","count":3},{"language":"default","tag":"Swaps","count":3},{"language":"default","tag":"Webhooks","count":3},{"language":"default","tag":"Operations","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/bre-b/create-a-bre-b-payout","slug":"/api-reference/bre-b/create-a-bre-b-payout","pageMetadata":{"title":"Create a BRE-B payout","description":"Requires an approved customer. Creates a Bre-B external account and\nverifies name + key before returning the deposit transaction.\n`409 destination_mismatch` if verify does not match. `409 needs_kyc` if KYC is incomplete.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/breb/payouts","href":"/api-reference/bre-b/create-a-bre-b-payout","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Requires an approved customer. Creates a Bre-B external account and\\nverifies name + key before returning the deposit transaction.\\n\", _jsx(_components.code, {\n children: \"409 destination_mismatch\"\n }), \" if verify does not match. \", _jsx(_components.code, {\n children: \"409 needs_kyc\"\n }), \" if KYC is incomplete.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a BRE-B payout","description":"Requires an approved customer. Creates a Bre-B external account and\nverifies name + key before returning the deposit transaction.\n`409 destination_mismatch` if verify does not match. `409 needs_kyc` if KYC is incomplete.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/breb/payouts","href":"/api-reference/bre-b/create-a-bre-b-payout","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["BRE-B"],"operationId":"createBrebPayout","summary":"Create a BRE-B payout","description":"Requires an approved customer. Creates a Bre-B external account and\nverifies name + key before returning the deposit transaction.\n`409 destination_mismatch` if verify does not match. `409 needs_kyc` if KYC is incomplete.\n","parameters":["0c0b329b-2d06-4bd5-97d0-e6fde1968c14"],"requestBody":"c6abdfd1-e979-47ff-a2d6-45e4932aa733","responses":{"200":"c44d261a-f2be-4f6c-a4d0-80e1c176866a","400":"0966e582-ef64-406b-9905-b983b53d6001","409":"b88d5596-8566-402e-88b6-e7cd84a2bd45"},"method":"post","type":"path","servers":["4ae65532-7c1a-4bf3-93e3-d489fa18fbf6"],"security":["1171e2fd-4dac-4570-8d32-297b4dcbef89"],"path":"/api/integrations/breb/payouts","baseUrlOptions":["https://api.copby.digitalcop.shop"],"title":"Create a BRE-B payout","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.userAddress":"0x2222222222222222222222222222222222222222","body.destinationCop":"10000","body.breBKey":"31234567890","body.accountOwnerName":"Ana Pérez","body.fromToken":"USDC"}],"urlDisplay":"full"},"dependencies":{"parameters":{"0c0b329b-2d06-4bd5-97d0-e6fde1968c14":{"name":"Idempotency-Key","in":"header","schema":{"type":"string","description":"Replays the same payout when reused by this integration","uniqueKey":"","typeLabel":"string"},"description":"Replays the same payout when reused by this integration"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userAddress","destinationCop","breBKey","accountOwnerName"],"properties":{"userAddress":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","example":"0x2222222222222222222222222222222222222222","isRequired":true,"uniqueKey":"userAddress","typeLabel":"string"},"destinationCop":{"type":"string","example":"10000","isRequired":true,"uniqueKey":"destinationCop","typeLabel":"string"},"breBKey":{"type":"string","isRequired":true,"uniqueKey":"breBKey","typeLabel":"string"},"accountOwnerName":{"type":"string","isRequired":true,"uniqueKey":"accountOwnerName","typeLabel":"string"},"fromToken":{"type":"string","enum":["USDC","COPm"],"default":"USDC","uniqueKey":"fromToken","typeLabel":"enum\u003cstring>"},"quoteId":{"type":"string","uniqueKey":"quoteId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"userAddress":"0x2222222222222222222222222222222222222222","fromToken":"USDC","destinationCop":"10000","breBKey":"31234567890","accountOwnerName":"Ana Pérez"},"examples":{"Example":{"title":"Example","value":{"userAddress":"0x2222222222222222222222222222222222222222","fromToken":"USDC","destinationCop":"10000","breBKey":"31234567890","accountOwnerName":"Ana Pérez"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"c44d261a-f2be-4f6c-a4d0-80e1c176866a":{"description":"Prepared payout","content":{"application/json":{"schema":{"type":"object","properties":{"payoutId":{"type":"string","uniqueKey":"payoutId","typeLabel":"string"},"status":{"type":"string","uniqueKey":"status","typeLabel":"string"},"fromToken":{"type":"string","uniqueKey":"fromToken","typeLabel":"string"},"sourceAmount":{"type":"string","uniqueKey":"sourceAmount","typeLabel":"string"},"fees":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["swap","bridge_fx","bridge","copby"],"uniqueKey":"fees.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"amountUsd":{"type":"string","uniqueKey":"fees.items.[INDEX].amountUsd","typeLabel":"string"},"to":{"oneOf":[{"type":"string","uniqueKey":"fees.items.[INDEX].to.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fees.items.[INDEX].to.oneOf.1","typeLabel":"null"}],"uniqueKey":"fees.items.[INDEX].to","typeLabel":"string | null"},"status":{"type":"string","enum":["quoted","verified","pending"],"uniqueKey":"fees.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"fees.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fees","typeLabel":"object[]"},"quote":{"type":"object","properties":{"display":{"oneOf":[{"type":"string","uniqueKey":"quote.display.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"quote.display.oneOf.1","typeLabel":"null"}],"uniqueKey":"quote.display","typeLabel":"string | null"},"effectiveUsdCop":{"oneOf":[{"type":"string","uniqueKey":"quote.effectiveUsdCop.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"quote.effectiveUsdCop.oneOf.1","typeLabel":"null"}],"uniqueKey":"quote.effectiveUsdCop","typeLabel":"string | null"}},"uniqueKey":"quote","typeLabel":"object"},"receipt":{"type":"object","description":"Consumer receipt (REQ-INT-RCPT-01). Fees are included in `exchangeRate.effectiveUsdCop`.\nUse `feesItemized` only for partner backoffice / disputes.\n","properties":{"title":{"type":"string","example":"Retiro Bre-B","uniqueKey":"receipt.title","typeLabel":"string"},"status":{"type":"string","uniqueKey":"receipt.status","typeLabel":"string"},"completedAt":{"oneOf":[{"type":"string","uniqueKey":"receipt.completedAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"receipt.completedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"receipt.completedAt","typeLabel":"string | null"},"transactionType":{"type":"string","enum":["withdrawal"],"uniqueKey":"receipt.transactionType","typeLabel":"enum\u003cstring>"},"payoutId":{"type":"string","uniqueKey":"receipt.payoutId","typeLabel":"string"},"breBKey":{"oneOf":[{"type":"string","description":"Masked key (last4), e.g. ···3143","uniqueKey":"receipt.breBKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"Masked key (last4), e.g. ···3143","uniqueKey":"receipt.breBKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"receipt.breBKey","typeLabel":"string | null"},"breBKeyLast4":{"oneOf":[{"type":"string","uniqueKey":"receipt.breBKeyLast4.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"receipt.breBKeyLast4.oneOf.1","typeLabel":"null"}],"uniqueKey":"receipt.breBKeyLast4","typeLabel":"string | null"},"beneficiaryName":{"oneOf":[{"type":"string","uniqueKey":"receipt.beneficiaryName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"receipt.beneficiaryName.oneOf.1","typeLabel":"null"}],"uniqueKey":"receipt.beneficiaryName","typeLabel":"string | null"},"totalPaid":{"type":"object","properties":{"amount":{"type":"string","uniqueKey":"receipt.totalPaid.amount","typeLabel":"string"},"currency":{"type":"string","enum":["USD"],"uniqueKey":"receipt.totalPaid.currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"receipt.totalPaid","typeLabel":"object"},"exchangeRate":{"type":"object","properties":{"display":{"oneOf":[{"type":"string","example":"1 USD = 3000 COP","uniqueKey":"receipt.exchangeRate.display.oneOf.0","typeLabel":"string"},{"type":"null","example":"1 USD = 3000 COP","uniqueKey":"receipt.exchangeRate.display.oneOf.1","typeLabel":"null"}],"uniqueKey":"receipt.exchangeRate.display","typeLabel":"string | null"},"effectiveUsdCop":{"oneOf":[{"type":"string","uniqueKey":"receipt.exchangeRate.effectiveUsdCop.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"receipt.exchangeRate.effectiveUsdCop.oneOf.1","typeLabel":"null"}],"uniqueKey":"receipt.exchangeRate.effectiveUsdCop","typeLabel":"string | null"},"sellRateUsdCop":{"oneOf":[{"type":"string","description":"Wholesale Bridge rate (ops); hide on consumer UI","uniqueKey":"receipt.exchangeRate.sellRateUsdCop.oneOf.0","typeLabel":"string"},{"type":"null","description":"Wholesale Bridge rate (ops); hide on consumer UI","uniqueKey":"receipt.exchangeRate.sellRateUsdCop.oneOf.1","typeLabel":"null"}],"uniqueKey":"receipt.exchangeRate.sellRateUsdCop","typeLabel":"string | null"}},"uniqueKey":"receipt.exchangeRate","typeLabel":"object"},"commission":{"type":"object","properties":{"mode":{"type":"string","enum":["included_in_rate"],"uniqueKey":"receipt.commission.mode","typeLabel":"enum\u003cstring>"},"displayAmount":{"type":"string","example":"0","uniqueKey":"receipt.commission.displayAmount","typeLabel":"string"},"displayCurrency":{"type":"string","enum":["COP","USD"],"uniqueKey":"receipt.commission.displayCurrency","typeLabel":"enum\u003cstring>"},"note":{"type":"string","uniqueKey":"receipt.commission.note","typeLabel":"string"}},"uniqueKey":"receipt.commission","typeLabel":"object"},"totalReceived":{"type":"object","properties":{"amount":{"type":"string","uniqueKey":"receipt.totalReceived.amount","typeLabel":"string"},"currency":{"type":"string","enum":["COP"],"uniqueKey":"receipt.totalReceived.currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"receipt.totalReceived","typeLabel":"object"},"feesItemized":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["swap","bridge_fx","bridge","copby"],"uniqueKey":"receipt.feesItemized.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"amountUsd":{"type":"string","uniqueKey":"receipt.feesItemized.items.[INDEX].amountUsd","typeLabel":"string"},"to":{"oneOf":[{"type":"string","uniqueKey":"receipt.feesItemized.items.[INDEX].to.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"receipt.feesItemized.items.[INDEX].to.oneOf.1","typeLabel":"null"}],"uniqueKey":"receipt.feesItemized.items.[INDEX].to","typeLabel":"string | null"},"status":{"type":"string","enum":["quoted","verified","pending"],"uniqueKey":"receipt.feesItemized.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"receipt.feesItemized.items.[INDEX]","typeLabel":"object"},"uniqueKey":"receipt.feesItemized","typeLabel":"object[]"}},"uniqueKey":"receipt","typeLabel":"object"},"deposit":{"type":"object","properties":{"chain":{"type":"string","uniqueKey":"deposit.chain","typeLabel":"string"},"currency":{"type":"string","uniqueKey":"deposit.currency","typeLabel":"string"},"address":{"type":"string","uniqueKey":"deposit.address","typeLabel":"string"},"amount":{"type":"string","uniqueKey":"deposit.amount","typeLabel":"string"}},"uniqueKey":"deposit","typeLabel":"object"},"transaction":{"type":"object","properties":{"approvalTarget":{"oneOf":[{"type":"string","uniqueKey":"transaction.approvalTarget.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"transaction.approvalTarget.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction.approvalTarget","typeLabel":"string | null"},"to":{"type":"string","uniqueKey":"transaction.to","typeLabel":"string"},"data":{"type":"string","uniqueKey":"transaction.data","typeLabel":"string"},"value":{"type":"string","example":"0","uniqueKey":"transaction.value","typeLabel":"string"}},"uniqueKey":"transaction","typeLabel":"object"},"feeTransaction":{"type":"object","properties":{"approvalTarget":{"oneOf":[{"type":"string","uniqueKey":"feeTransaction.approvalTarget.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"feeTransaction.approvalTarget.oneOf.1","typeLabel":"null"}],"uniqueKey":"feeTransaction.approvalTarget","typeLabel":"string | null"},"to":{"type":"string","uniqueKey":"feeTransaction.to","typeLabel":"string"},"data":{"type":"string","uniqueKey":"feeTransaction.data","typeLabel":"string"},"value":{"type":"string","example":"0","uniqueKey":"feeTransaction.value","typeLabel":"string"}},"uniqueKey":"feeTransaction","typeLabel":"object"},"destinationPreview":{"type":"object","properties":{"accountOwnerName":{"type":"string","uniqueKey":"destinationPreview.accountOwnerName","typeLabel":"string"},"bankName":{"oneOf":[{"type":"string","uniqueKey":"destinationPreview.bankName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"destinationPreview.bankName.oneOf.1","typeLabel":"null"}],"uniqueKey":"destinationPreview.bankName","typeLabel":"string | null"},"documentLast4":{"oneOf":[{"type":"string","uniqueKey":"destinationPreview.documentLast4.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"destinationPreview.documentLast4.oneOf.1","typeLabel":"null"}],"uniqueKey":"destinationPreview.documentLast4","typeLabel":"string | null"}},"uniqueKey":"destinationPreview","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payoutId":"\u003cstring>","status":"\u003cstring>","fromToken":"\u003cstring>","sourceAmount":"\u003cstring>","fees":[{"code":"swap","amountUsd":"\u003cstring>","to":"\u003cstring>","status":"quoted"}],"quote":{"display":"\u003cstring>","effectiveUsdCop":"\u003cstring>"},"receipt":{"title":"Retiro Bre-B","status":"\u003cstring>","completedAt":"\u003cstring>","transactionType":"withdrawal","payoutId":"\u003cstring>","breBKey":"\u003cstring>","breBKeyLast4":"\u003cstring>","beneficiaryName":"\u003cstring>","totalPaid":{"amount":"\u003cstring>","currency":"USD"},"exchangeRate":{"display":"1 USD = 3000 COP","effectiveUsdCop":"\u003cstring>","sellRateUsdCop":"\u003cstring>"},"commission":{"mode":"included_in_rate","displayAmount":"0","displayCurrency":"COP","note":"\u003cstring>"},"totalReceived":{"amount":"\u003cstring>","currency":"COP"},"feesItemized":[{"code":"swap","amountUsd":"\u003cstring>","to":"\u003cstring>","status":"quoted"}]},"deposit":{"chain":"\u003cstring>","currency":"\u003cstring>","address":"\u003cstring>","amount":"\u003cstring>"},"transaction":{"approvalTarget":"\u003cstring>","to":"\u003cstring>","data":"\u003cstring>","value":"0"},"feeTransaction":{"approvalTarget":"\u003cstring>","to":"\u003cstring>","data":"\u003cstring>","value":"0"},"destinationPreview":{"accountOwnerName":"\u003cstring>","bankName":"\u003cstring>","documentLast4":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"0966e582-ef64-406b-9905-b983b53d6001":{"description":"API error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"errorCode":{"type":"string","enum":["below_minimum","needs_kyc","destination_mismatch","requote","tx_hash_reused","otp_invalid","mercado_cerrado","invalid_webhook_signature"],"uniqueKey":"errorCode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","errorCode":"below_minimum"}}},"exampleType":"generated"}},"exampleType":"generated"},"b88d5596-8566-402e-88b6-e7cd84a2bd45":{"description":"API error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"errorCode":{"type":"string","enum":["below_minimum","needs_kyc","destination_mismatch","requote","tx_hash_reused","otp_invalid","mercado_cerrado","invalid_webhook_signature"],"uniqueKey":"errorCode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","errorCode":"below_minimum"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1171e2fd-4dac-4570-8d32-297b4dcbef89":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Integration API key. Send as `Bearer copby_live_pk_…`.","scopes":[]}}},"servers":{"4ae65532-7c1a-4bf3-93e3-d489fa18fbf6":{"url":"https://api.copby.digitalcop.shop","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Integration API key. Send as `Bearer copby_live_pk_…`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Integration API key. Send as `Bearer copby_live_pk_…`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"cop-by","siteName":"COP By Integrations","title":"Create a BRE-B payout - COP By Integrations","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-04T21:08:35.975Z","originalFileLocation":"api-reference/bre-b/create-a-bre-b-payout.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Requires an approved customer. Creates a Bre-B external account and verifies name + key before returning the deposit transaction. 409 destination_mismatch if verify does not match. 409 needs_kyc if KYC is incomplete.\">\u003cmeta data-mint-head name=\"application-name\" content=\"COP By Integrations\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cop-by/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cop-by/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cop-by/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cop-by/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a BRE-B payout - COP By Integrations\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requires an approved customer. Creates a Bre-B external account and verifies name + key before returning the deposit transaction. 409 destination_mismatch if verify does not match. 409 needs_kyc if KYC is incomplete.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"COP By Integrations\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.copby.digitalcop.shop/api-reference/bre-b/create-a-bre-b-payout\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cop-by.mintlify.site/_mintlify/api/og/v2?division=BRE-B\u0026amp;title=Create+a+BRE-B+payout\u0026amp;description=Requires+an+approved+customer.+Creates+a+Bre-B+external+account+and%0Averifies+name+%2B+key+before+returning+the+deposit+transaction.%0A%60409+destination_mismatch%60+if+\u0026amp;theme=98a17941bf9968fb666b281f\u0026amp;signature=a48a9f1c1237dd53c1a0906d13dd0fa625b68477c1248b4d6ff7da99b27bd484\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a BRE-B payout - COP By Integrations\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requires an approved customer. Creates a Bre-B external account and verifies name + key before returning the deposit transaction. 409 destination_mismatch if verify does not match. 409 needs_kyc if KYC is incomplete.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cop-by.mintlify.site/_mintlify/api/og/v2?division=BRE-B\u0026amp;title=Create+a+BRE-B+payout\u0026amp;description=Requires+an+approved+customer.+Creates+a+Bre-B+external+account+and%0Averifies+name+%2B+key+before+returning+the+deposit+transaction.%0A%60409+destination_mismatch%60+if+\u0026amp;theme=98a17941bf9968fb666b281f\u0026amp;signature=a48a9f1c1237dd53c1a0906d13dd0fa625b68477c1248b4d6ff7da99b27bd484\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/cop-by/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"COP By Integrations\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1B4D3E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.copby.digitalcop.shop/api-reference/bre-b/create-a-bre-b-payout\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/bre-b/create-a-bre-b-payout.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.copby.digitalcop.shop/#organization\",\"name\":\"COP By Integrations\",\"url\":\"https://docs.copby.digitalcop.shop\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.copby.digitalcop.shop#website\",\"name\":\"COP By Integrations\",\"url\":\"https://docs.copby.digitalcop.shop\",\"publisher\":{\"@id\":\"https://docs.copby.digitalcop.shop/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/bre-b/create-a-bre-b-payout#webpage\",\"url\":\"https://docs.copby.digitalcop.shop/api-reference/bre-b/create-a-bre-b-payout\",\"name\":\"Create a BRE-B payout\",\"description\":\"Requires an approved customer. Creates a Bre-B external account and verifies name + key before returning the deposit transaction. 409 destination_mismatch if verify does not match. 409 needs_kyc if KYC is incomplete.\",\"dateModified\":\"2026-10-04T21:08:35.975Z\",\"isPartOf\":{\"@id\":\"https://docs.copby.digitalcop.shop#website\"},\"breadcrumb\":{\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/bre-b/create-a-bre-b-payout#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/bre-b/create-a-bre-b-payout#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"BRE-B\",\"item\":\"https://docs.copby.digitalcop.shop/api-reference/bre-b/get-a-bre-b-quote\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a BRE-B payout\",\"item\":\"https://docs.copby.digitalcop.shop/api-reference/bre-b/create-a-bre-b-payout\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/bre-b/create-a-bre-b-payout#apireference\",\"headline\":\"Create a BRE-B payout\",\"name\":\"Create a BRE-B payout\",\"description\":\"Requires an approved customer. Creates a Bre-B external account and verifies name + key before returning the deposit transaction. 409 destination_mismatch if verify does not match. 409 needs_kyc if KYC is incomplete.\",\"url\":\"https://docs.copby.digitalcop.shop/api-reference/bre-b/create-a-bre-b-payout\",\"mainEntityOfPage\":{\"@id\":\"https://docs.copby.digitalcop.shop/api-reference/bre-b/create-a-bre-b-payout#webpage\"},\"dateModified\":\"2026-10-04T21:08:35.975Z\",\"publisher\":{\"@id\":\"https://docs.copby.digitalcop.shop/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.copby.digitalcop.shop#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"COP By Integrations\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"COP By Integrations\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/bre-b/create-a-bre-b-payout.md","siteName":"COP By Integrations","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"BRE-B","pages":[{"title":"Get a BRE-B quote","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/breb/quote","href":"/api-reference/bre-b/get-a-bre-b-quote"},{"title":"Get KYC status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/breb/kyc","href":"/api-reference/bre-b/get-kyc-status"},{"title":"Start KYC","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/breb/kyc","href":"/api-reference/bre-b/start-kyc"},{"title":"Send KYC email OTP","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/breb/kyc/otp/send","href":"/api-reference/bre-b/send-kyc-email-otp"},{"title":"Verify KYC email OTP","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/breb/kyc/otp/verify","href":"/api-reference/bre-b/verify-kyc-email-otp"},{"title":"List payouts for this integration","description":null,"deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/breb/payouts","href":"/api-reference/bre-b/list-payouts-for-this-integration"},{"title":"Create a BRE-B payout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/breb/payouts","href":"/api-reference/bre-b/create-a-bre-b-payout"},{"title":"Get a payout","description":null,"deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/breb/payouts/{payoutId}","href":"/api-reference/bre-b/get-a-payout"},{"title":"Confirm a payout deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/breb/payouts/{payoutId}/confirm","href":"/api-reference/bre-b/confirm-a-payout-deposit"}]},{"group":"Webhooks","pages":[{"title":"Bridge webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/breb/webhook","href":"/api-reference/webhooks/bridge-webhook"},{"title":"Retry due partner webhook deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/webhooks/deliver","href":"/api-reference/webhooks/retry-due-partner-webhook-deliveries"},{"title":"Partner payout status outbound","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook partnerPayoutStatus","href":"/api-reference/webhooks/partner-payout-status-outbound"}]},{"group":"Swaps","pages":[{"title":"Prepare a swap","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/swaps/prepare","href":"/api-reference/swaps/prepare-a-swap"},{"title":"Confirm a swap","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/swaps/{intentId}/confirm","href":"/api-reference/swaps/confirm-a-swap"},{"title":"List confirmed swaps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/swaps","href":"/api-reference/swaps/list-confirmed-swaps"}]},{"group":"Settlement","pages":[{"title":"Create an Arc USDC to Celo COPm quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/settlements/quotes","href":"/api-reference/settlement/create-an-arc-usdc-to-celo-copm-quote"},{"title":"Create an idempotent settlement order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/settlements/orders","href":"/api-reference/settlement/create-an-idempotent-settlement-order"},{"title":"Get a settlement order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/integrations/settlements/orders/{orderId}","href":"/api-reference/settlement/get-a-settlement-order"},{"title":"Verify an Arc CCTP burn and start settlement","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/integrations/settlements/orders/{orderId}/burn","href":"/api-reference/settlement/verify-an-arc-cctp-burn-and-start-settlement"}]}]}]},"basePath":"","title":"Create a BRE-B payout - COP By Integrations","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}