Authenticate
Exchange API credentials for a short-lived Bearer token (~20 minutes). Cache and reuse it across calls — refresh proactively before expiry.
| Content-Type | application/json |
{ "user_id": "cli_remit_co01",User IDiAPI client user id used to obtain the access token. "secret": "sk_live_Rm9xQ2pL7v"SecretiAPI client secret paired with user_id for authentication.}{ "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjbGlfcmVtaXRfY28wMSJ9.Rm8xQ3pL2nV7kWd9pT4bH6fY0gJ",Access TokeniShort-lived bearer token. Attach as Authorization: Bearer on later calls. "type": "Bearer",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "expiration_time": 1200Expiration TimeiToken lifetime in seconds.}Create USD Global Cobre Balance
Provision the USD Global Cobre Balance that holds treasury funding (SWIFT / local USD transfer) and is the source_id of every Cross-Border Money Movement. Request US funding instructions from your KAM after creation.
| Authorization | Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjbGlfcmVtaXRfY28wMSJ9.Rm8xQ3pL2nV7kWd9pT4bH6fY0gJ |
| Content-Type | application/json |
{ "provider_id": "pr_global_cobre",ProvideriCobre field at "provider_id" in this payload. "action": "create",ActioniCobre field at "action" in this payload. "metadata": {MetadataiCustom key-value metadata attached to the resource. "currency": "usd"CurrencyiISO currency code (e.g. cop, mxn). }, "alias": "Remittance USD Global"AliasiDisplay name that helps identify it and clarify its purpose.}{ "id": "acc_RemitUsd01",IdiUnique Cobre identifier for this resource. "provider_id": "pr_global_cobre",ProvideriCobre field at "provider_id" in this payload. "provider_name": "Cobre Balance Global",Provider NameiCobre field at "provider_name" in this payload. "connectivity": {ConnectivityiConnection/registration status for keys or accounts. "status": "connected",StatusiLifecycle status object for the resource or movement. "description": ""DescriptioniHuman-readable label or note. }, "alias": "Remittance USD Global",AliasiDisplay name that helps identify it and clarify its purpose. "metadata": {MetadataiCustom key-value metadata attached to the resource. "available_services": [Available ServicesiCobre field at "metadata.available_services" in this payload. "mm_push_from_account" ], "cobre_tag": "@remit00001"Cobre TagiCobre Balance tag identifying the destination account. }, "account_number": "",Account NumberiBank account or CLABE number for the counterparty. "account_type": "cobre_balance",Account TypeiCobre field at "account_type" in this payload. "obtained_balance": 0,Obtained BalanceiCobre field at "obtained_balance" in this payload. "obtained_balance_at": "2026-06-03T09:00:00Z",Obtained Balance AtiCobre field at "obtained_balance_at" in this payload. "geo": "global",GeoiGeography code (e.g. col = Colombia, mex = Mexico). "tags": [],TagsiCobre field at "tags" in this payload. "currency": "usd",CurrencyiISO currency code (e.g. cop, mxn). "created_at": "2026-06-03T09:00:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "updated_at": "2026-06-03T09:00:00Z"Updated AtiTimestamp of the last update (ISO 8601, UTC).}Create COP Cobre Balance
Provision the COP Cobre Balance that receives converted funds (Cross-Border destination_id) and funds every local payout (source_id).
| Authorization | Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjbGlfcmVtaXRfY28wMSJ9.Rm8xQ3pL2nV7kWd9pT4bH6fY0gJ |
| Content-Type | application/json |
{ "provider_id": "pr_col_cobre",ProvideriCobre field at "provider_id" in this payload. "action": "create",ActioniCobre field at "action" in this payload. "alias": "Remittance COP Master"AliasiDisplay name that helps identify it and clarify its purpose.}{ "id": "acc_RemitCop01",IdiUnique Cobre identifier for this resource. "provider_id": "pr_col_cobre",ProvideriCobre field at "provider_id" in this payload. "provider_name": "Cobre Balance Colombia",Provider NameiCobre field at "provider_name" in this payload. "connectivity": {ConnectivityiConnection/registration status for keys or accounts. "status": "connected",StatusiLifecycle status object for the resource or movement. "description": ""DescriptioniHuman-readable label or note. }, "alias": "Remittance COP Master",AliasiDisplay name that helps identify it and clarify its purpose. "metadata": {MetadataiCustom key-value metadata attached to the resource. "available_services": [Available ServicesiCobre field at "metadata.available_services" in this payload. "mm_push_from_account" ] }, "account_number": "",Account NumberiBank account or CLABE number for the counterparty. "account_type": "Cobre Balance",Account TypeiCobre field at "account_type" in this payload. "obtained_balance": 0,Obtained BalanceiCobre field at "obtained_balance" in this payload. "obtained_balance_at": "2026-06-03T09:05:00Z",Obtained Balance AtiCobre field at "obtained_balance_at" in this payload. "geo": "col",GeoiGeography code (e.g. col = Colombia, mex = Mexico). "tags": [],TagsiCobre field at "tags" in this payload. "currency": "cop",CurrencyiISO currency code (e.g. cop, mxn). "created_at": "2026-06-03T09:05:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "updated_at": "2026-06-03T09:05:00Z"Updated AtiTimestamp of the last update (ISO 8601, UTC).}Subscribe to Remittance Events
Register webhooks for Cross-Border Money Movement lifecycle, local Money Movement status, and balance credits/debits. Prefer events over polling on the critical path; verify HMAC-SHA256 signatures on every delivery.
| Authorization | Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjbGlfcmVtaXRfY28wMSJ9.Rm8xQ3pL2nV7kWd9pT4bH6fY0gJ |
| Content-Type | application/json |
{ "url": "https://remittance.example.co/webhooks/cobre",Notification URLiHTTPS URL used by this resource (e.g. webhook endpoint). "description": "USD/COP remittance lifecycle",DescriptioniHuman-readable label or note. "events": [EventsiList of webhook event types this subscription listens to. "cross_border_money_movements.status.initiated", "cross_border_money_movements.status.pending_funds", "cross_border_money_movements.status.processing", "cross_border_money_movements.status.completed", "cross_border_money_movements.status.rejected", "cross_border_money_movements.status.failed", "money_movements.status.initiated", "money_movements.status.processing", "money_movements.status.completed", "money_movements.status.rejected", "money_movements.status.failed", "money_movements.status.returned", "accounts.balance.credit", "accounts.balance.debit" ], "event_signature_key": "WHremit9xZ"Signature keyiSecret you set on the subscription; Cobre uses it to HMAC-SHA256-sign deliveries (verify via event-signature + event-timestamp headers).}{ "id": "sub_RemitCb01",IdiUnique Cobre identifier for this resource. "url": "https://remittance.example.co/webhooks/cobre",Notification URLiHTTPS URL used by this resource (e.g. webhook endpoint). "description": "USD/COP remittance lifecycle",DescriptioniHuman-readable label or note. "events": [EventsiList of webhook event types this subscription listens to. "cross_border_money_movements.status.initiated", "cross_border_money_movements.status.pending_funds", "cross_border_money_movements.status.processing", "cross_border_money_movements.status.completed", "cross_border_money_movements.status.rejected", "cross_border_money_movements.status.failed", "money_movements.status.initiated", "money_movements.status.processing", "money_movements.status.completed", "money_movements.status.rejected", "money_movements.status.failed", "money_movements.status.returned", "accounts.balance.credit", "accounts.balance.debit" ], "event_signature_key": "******9xZ",Signature keyiSecret you set on the subscription; Cobre uses it to HMAC-SHA256-sign deliveries (verify via event-signature + event-timestamp headers). "created_at": "2026-06-03T09:10:00Z"Created AtiTimestamp when the resource was created (ISO 8601, UTC).}Request USD/COP Quote
Cobre quotes USD/COP only — sender-currency-to-USD conversion is handled on your platform. For a static quote, USD must already sit in the Global Balance before execution. Quotes expire in ~1 minute; persist fxq_id against the remittance.
| Authorization | Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjbGlfcmVtaXRfY28wMSJ9.Rm8xQ3pL2nV7kWd9pT4bH6fY0gJ |
| Content-Type | application/json |
{ "currency_pair": "usd/cop",Currency pairiCobre field at "currency_pair" in this payload. "destination_amount": 200000000,Destination amount (COP, no decimals)i200000000 = COP $2,000,000.00 (amounts have no decimal point — last two digits are cents). "type": "static_quote"Quote typeistatic_quote requires pre-funded USD; rolling_quote locks a rate tier before wiring USD.}{ "id": "fxq_Remit45601",IdiUnique Cobre identifier for this resource. "type": "static_quote",Quote typeistatic_quote requires pre-funded USD; rolling_quote locks a rate tier before wiring USD. "currency_pair": "usd/cop",Currency pairiCobre field at "currency_pair" in this payload. "source_amount": 50000,Source AmountiCobre field at "source_amount" in this payload. "fees_breakdown": {Fees BreakdowniCobre field at "fees_breakdown" in this payload. "spread": 1.2SpreadiCobre field at "fees_breakdown.spread" in this payload. }, "fx_rate": 4000,Fx RateiCobre field at "fx_rate" in this payload. "destination_amount": 200000000,Destination amount (COP, no decimals)i200000000 = COP $2,000,000.00 (amounts have no decimal point — last two digits are cents). "quota_limit": 100000000,Quota LimitiCobre field at "quota_limit" in this payload. "remaining_quota": 95000000,Remaining QuotaiCobre field at "remaining_quota" in this payload. "created_at": "2026-06-03T10:00:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "valid_until": "2026-06-03T10:01:00Z",Valid UntiliCobre field at "valid_until" in this payload. "last_quote": true,Last QuoteiCobre field at "last_quote" in this payload. "off_market": falseOff MarketiCobre field at "off_market" in this payload.}Execute Cross-Border Conversion
After the end user confirms, convert USD to COP by debiting the USD Global Balance and crediting the COP Balance. Reuse the same idempotency header on retries (valid 24h). Only the most recent fxq_id for the pair may be used.
| Authorization | Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjbGlfcmVtaXRfY28wMSJ9.Rm8xQ3pL2nV7kWd9pT4bH6fY0gJ |
| Content-Type | application/json |
| idempotency | remit_cbmm_000456 |
{ "source_id": "acc_RemitUsd01",USD Global BalanceiCobre id of the source account or counterparty. "destination_id": "acc_RemitCop01",COP BalanceiCobre id of the destination account or counterparty. "forex_quote_id": "fxq_Remit45601",FX Quote IDiCobre field at "forex_quote_id" in this payload. "metadata": {MetadataiCustom key-value metadata attached to the resource. "destination_description": "Remittance remit_000456"DescriptioniCobre field at "metadata.destination_description" in this payload. }, "external_id": "remit_fx_000456"External ID (FX leg)iRecommended remit_fx_<remittance_id> — pairs with remit_payout_<remittance_id> on the local leg.}{ "id": "mm_CbmmRem456",IdiUnique Cobre identifier for this resource. "creator": "cli_remit_co01",CreatoriAPI client id that created this resource. "status": {StatusiLifecycle status object for the resource or movement. "state": "initiated",StateiCurrent lifecycle state (e.g. completed, failed, rejected). "code": "",CodeiProvider or Cobre status code when the state is failed or rejected. "description": ""DescriptioniHuman-readable detail for the current status. }, "metadata": {MetadataiCustom key-value metadata attached to the resource. "destination_description": "Remittance remit_000456",DescriptioniCobre field at "metadata.destination_description" in this payload. "forex_quote_id": "fxq_Remit45601",Forex Quote IdiCobre field at "metadata.forex_quote_id" in this payload. "forex_quote": {Forex QuoteiCobre field at "metadata.forex_quote" in this payload. "type": "static_quote",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "currency_pair": "usd/cop",Currency PairiCobre field at "metadata.forex_quote.currency_pair" in this payload. "source_amount": 50000,Source AmountiCobre field at "metadata.forex_quote.source_amount" in this payload. "fees_breakdown": {Fees BreakdowniCobre field at "metadata.forex_quote.fees_breakdown" in this payload. "spread": 1.2SpreadiCobre field at "metadata.forex_quote.fees_breakdown.spread" in this payload. }, "fx_rate": 4000,Fx RateiCobre field at "metadata.forex_quote.fx_rate" in this payload. "destination_amount": 200000000,Destination AmountiCobre field at "metadata.forex_quote.destination_amount" in this payload. "quota_limit": 100000000,Quota LimitiCobre field at "metadata.forex_quote.quota_limit" in this payload. "remaining_quota": 95000000,Remaining QuotaiCobre field at "metadata.forex_quote.remaining_quota" in this payload. "created_at": "2026-06-03T10:00:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "valid_until": "2026-06-03T10:01:00Z",Valid UntiliCobre field at "metadata.forex_quote.valid_until" in this payload. "last_quote": true,Last QuoteiCobre field at "metadata.forex_quote.last_quote" in this payload. "off_market": falseOff MarketiCobre field at "metadata.forex_quote.off_market" in this payload. } }, "external_id": "remit_fx_000456",External ID (FX leg)iRecommended remit_fx_<remittance_id> — pairs with remit_payout_<remittance_id> on the local leg. "type": "cross_border",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "source_id": "acc_RemitUsd01",USD Global BalanceiCobre id of the source account or counterparty. "destination_id": "acc_RemitCop01",COP BalanceiCobre id of the destination account or counterparty. "currency": "usd/cop",CurrencyiISO currency code (e.g. cop, mxn). "amount": 50000,AmountiAmount in cents — the last two digits are decimals. "created_at": "2026-06-03T10:00:10Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "updated_at": "2026-06-03T10:00:10Z"Updated AtiTimestamp of the last update (ISO 8601, UTC).}Webhook outcomes — Cross-border money movement
USD→COP conversion completed — COP is now available on the COP Balance. Proceed to local delivery; treasury can reconcile USD debit and COP credit via accounts.balance.debit / credit events.
Handle each terminal state in your webhook listener. Status codes reference the <a href="https://docs.cobre.com/money-movement-statuses-2032280m0" target="_blank" rel="noopener">Money Movement Statuses</a> guide.
Funds settled successfully. No error code is set (NA in the status guide). Use this webhook to mark the payment as paid in your system.
cross_border_money_movements.status.completed| Content-Type | application/json |
{ "id": "ev_CbmmRem456Cmp",IdiUnique Cobre identifier for this resource. "event_key": "cross_border_money_movements.status.completed",Event KeyiWebhook subscription key (e.g. money_movements.status.completed). "created_at": "2026-06-03T10:00:45Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "content": {ContentiEvent-specific payload — same layout as the GET response for that resource. "id": "mm_CbmmRem456",IdiUnique Cobre identifier for this resource. "creator": "cli_remit_co01",CreatoriAPI client id that created this resource. "status": {StatusiLifecycle status object for the resource or movement. "state": "completed",StateiCurrent lifecycle state (e.g. completed, failed, rejected). "code": "",CodeiProvider or Cobre status code when the state is failed or rejected. "description": ""DescriptioniHuman-readable label or note. }, "metadata": {MetadataiCustom key-value metadata attached to the resource. "destination_description": "Remittance remit_000456",Destination DescriptioniMetadata field "destination_description" attached to the resource. "forex_quote_id": "fxq_Remit45601",Forex Quote IdiMetadata field "forex_quote_id" attached to the resource. "forex_quote": {Forex QuoteiMetadata field "forex_quote" attached to the resource. "type": "static_quote",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "currency_pair": "usd/cop",Currency PairiMetadata field "forex_quote.currency_pair" attached to the resource. "source_amount": 50000,Source AmountiMetadata field "forex_quote.source_amount" attached to the resource. "fees_breakdown": {Fees BreakdowniMetadata field "forex_quote.fees_breakdown" attached to the resource. "spread": 1.2SpreadiMetadata field "forex_quote.fees_breakdown.spread" attached to the resource. }, "fx_rate": 4000,Fx RateiMetadata field "forex_quote.fx_rate" attached to the resource. "destination_amount": 200000000,Destination AmountiMetadata field "forex_quote.destination_amount" attached to the resource. "quota_limit": 100000000,Quota LimitiMetadata field "forex_quote.quota_limit" attached to the resource. "remaining_quota": 95000000,Remaining QuotaiMetadata field "forex_quote.remaining_quota" attached to the resource. "created_at": "2026-06-03T10:00:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "valid_until": "2026-06-03T10:01:00Z",Valid UntiliMetadata field "forex_quote.valid_until" attached to the resource. "last_quote": true,Last QuoteiMetadata field "forex_quote.last_quote" attached to the resource. "off_market": falseOff MarketiMetadata field "forex_quote.off_market" attached to the resource. } }, "external_id": "remit_fx_000456",External IdiYour own reference echoed by Cobre for reconciliation. "type": "cross_border",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "source_id": "acc_RemitUsd01",Source IdiCobre id of the source account or counterparty. "destination_id": "acc_RemitCop01",Destination IdiCobre id of the destination account or counterparty. "currency": "usd/cop",CurrencyiISO currency code (e.g. cop, mxn). "amount": 50000,AmountiAmount in cents — the last two digits are decimals. "created_at": "2026-06-03T10:00:10Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "updated_at": "2026-06-03T10:00:45Z"Updated AtiTimestamp of the last update (ISO 8601, UTC). }}Cobre or the rail could not process the movement. Inspect status.code and status.description — common failed codes include:
F001 | Payment processing failed — please try again. |
F002 | NSF — not sufficient funds in the designated account. |
F003 | R2P payment link expired (payins). |
F004 | Daily transaction amount limit has been reached. |
F005 | Amount exceeds the maximum allowed transaction limit. |
F098 | Could not process the money movement at this time. |
F099 | Could not process the money movement at this time. |
cross_border_money_movements.status.failed| Content-Type | application/json |
{ "id": "ev_CbmmRem456Cmp",IdiUnique Cobre identifier for this resource. "event_key": "cross_border_money_movements.status.failed",Event KeyiWebhook subscription key (e.g. money_movements.status.completed). "created_at": "2026-06-03T10:00:45Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "content": {ContentiEvent-specific payload — same layout as the GET response for that resource. "id": "mm_CbmmRem456",IdiUnique Cobre identifier for this resource. "creator": "cli_remit_co01",CreatoriAPI client id that created this resource. "status": {StatusiLifecycle status object for the resource or movement. "state": "failed",StateiCurrent lifecycle state (e.g. completed, failed, rejected). "code": "F002",CodeiProvider or Cobre status code when the state is failed or rejected. "description": "NSF — not sufficient funds in the designated account."DescriptioniHuman-readable label or note. }, "metadata": {MetadataiCustom key-value metadata attached to the resource. "destination_description": "Remittance remit_000456",Destination DescriptioniMetadata field "destination_description" attached to the resource. "forex_quote_id": "fxq_Remit45601",Forex Quote IdiMetadata field "forex_quote_id" attached to the resource. "forex_quote": {Forex QuoteiMetadata field "forex_quote" attached to the resource. "type": "static_quote",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "currency_pair": "usd/cop",Currency PairiMetadata field "forex_quote.currency_pair" attached to the resource. "source_amount": 50000,Source AmountiMetadata field "forex_quote.source_amount" attached to the resource. "fees_breakdown": {Fees BreakdowniMetadata field "forex_quote.fees_breakdown" attached to the resource. "spread": 1.2SpreadiMetadata field "forex_quote.fees_breakdown.spread" attached to the resource. }, "fx_rate": 4000,Fx RateiMetadata field "forex_quote.fx_rate" attached to the resource. "destination_amount": 200000000,Destination AmountiMetadata field "forex_quote.destination_amount" attached to the resource. "quota_limit": 100000000,Quota LimitiMetadata field "forex_quote.quota_limit" attached to the resource. "remaining_quota": 95000000,Remaining QuotaiMetadata field "forex_quote.remaining_quota" attached to the resource. "created_at": "2026-06-03T10:00:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "valid_until": "2026-06-03T10:01:00Z",Valid UntiliMetadata field "forex_quote.valid_until" attached to the resource. "last_quote": true,Last QuoteiMetadata field "forex_quote.last_quote" attached to the resource. "off_market": falseOff MarketiMetadata field "forex_quote.off_market" attached to the resource. } }, "external_id": "remit_fx_000456",External IdiYour own reference echoed by Cobre for reconciliation. "type": "cross_border",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "source_id": "acc_RemitUsd01",Source IdiCobre id of the source account or counterparty. "destination_id": "acc_RemitCop01",Destination IdiCobre id of the destination account or counterparty. "currency": "usd/cop",CurrencyiISO currency code (e.g. cop, mxn). "amount": 50000,AmountiAmount in cents — the last two digits are decimals. "created_at": "2026-06-03T10:00:10Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "updated_at": "2026-06-03T10:00:45Z"Updated AtiTimestamp of the last update (ISO 8601, UTC). }}The bank or payment network rejected the transaction. Inspect status.code — common rejected codes include:
R000 | Transaction rejected. |
R001 | Inactive or blocked account. |
R002 | Account and identification provided do not coincide. |
R005 | Account does not exist. |
R006 | Invalid account number. |
R009 | Exceeds maximum allowed amount. |
R018 | Payment rejected due to invalid key (payouts). |
R023 | Payment cancelled by the user. |
R026 | Payment rejected due to unavailable bank services. |
R034 | Account closed. |
R085 | Bank processing error (payouts). |
cross_border_money_movements.status.rejected| Content-Type | application/json |
{ "id": "ev_CbmmRem456Cmp",IdiUnique Cobre identifier for this resource. "event_key": "cross_border_money_movements.status.rejected",Event KeyiWebhook subscription key (e.g. money_movements.status.completed). "created_at": "2026-06-03T10:00:45Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "content": {ContentiEvent-specific payload — same layout as the GET response for that resource. "id": "mm_CbmmRem456",IdiUnique Cobre identifier for this resource. "creator": "cli_remit_co01",CreatoriAPI client id that created this resource. "status": {StatusiLifecycle status object for the resource or movement. "state": "rejected",StateiCurrent lifecycle state (e.g. completed, failed, rejected). "code": "R001",CodeiProvider or Cobre status code when the state is failed or rejected. "description": "Inactive or blocked account."DescriptioniHuman-readable label or note. }, "metadata": {MetadataiCustom key-value metadata attached to the resource. "destination_description": "Remittance remit_000456",Destination DescriptioniMetadata field "destination_description" attached to the resource. "forex_quote_id": "fxq_Remit45601",Forex Quote IdiMetadata field "forex_quote_id" attached to the resource. "forex_quote": {Forex QuoteiMetadata field "forex_quote" attached to the resource. "type": "static_quote",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "currency_pair": "usd/cop",Currency PairiMetadata field "forex_quote.currency_pair" attached to the resource. "source_amount": 50000,Source AmountiMetadata field "forex_quote.source_amount" attached to the resource. "fees_breakdown": {Fees BreakdowniMetadata field "forex_quote.fees_breakdown" attached to the resource. "spread": 1.2SpreadiMetadata field "forex_quote.fees_breakdown.spread" attached to the resource. }, "fx_rate": 4000,Fx RateiMetadata field "forex_quote.fx_rate" attached to the resource. "destination_amount": 200000000,Destination AmountiMetadata field "forex_quote.destination_amount" attached to the resource. "quota_limit": 100000000,Quota LimitiMetadata field "forex_quote.quota_limit" attached to the resource. "remaining_quota": 95000000,Remaining QuotaiMetadata field "forex_quote.remaining_quota" attached to the resource. "created_at": "2026-06-03T10:00:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "valid_until": "2026-06-03T10:01:00Z",Valid UntiliMetadata field "forex_quote.valid_until" attached to the resource. "last_quote": true,Last QuoteiMetadata field "forex_quote.last_quote" attached to the resource. "off_market": falseOff MarketiMetadata field "forex_quote.off_market" attached to the resource. } }, "external_id": "remit_fx_000456",External IdiYour own reference echoed by Cobre for reconciliation. "type": "cross_border",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "source_id": "acc_RemitUsd01",Source IdiCobre id of the source account or counterparty. "destination_id": "acc_RemitCop01",Destination IdiCobre id of the destination account or counterparty. "currency": "usd/cop",CurrencyiISO currency code (e.g. cop, mxn). "amount": 50000,AmountiAmount in cents — the last two digits are decimals. "created_at": "2026-06-03T10:00:10Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "updated_at": "2026-06-03T10:00:45Z"Updated AtiTimestamp of the last update (ISO 8601, UTC). }}Reconcile the Cross-Border Conversion
Match the Cross-Border completion webhook to your remittance ledger on external_id and cbmm_id. Cross-check USD debit and COP credit on the respective Cobre Balances via accounts.balance.debit / credit events or GET /accounts/{acct_id}/transactions.
Mapping the webhook payload from an earlier step onto Remittance ledger. No API call is made — this step closes the loop in your own system.
| Cobre field & value | Remittance ledger field | |
content.external_id remit_fx_000456 |
→ | fx_external_id FX leg reference — shared remittance_id suffix pairs with remit_payout_* on local delivery. |
content.id mm_CbmmRem456 |
→ | cobre_cbmm_id Cross-Border Money Movement id (cbmm_id) from Cobre. |
content.metadata.forex_quote_id fxq_Remit45601 |
→ | fxq_id |
content.amount 50000 |
→ | usd_debited_cents USD source amount debited from the Global Balance (50000 = $500.00 USD). |
content.metadata.forex_quote.destination_amount 200000000 |
→ | cop_credited_cents COP credited to the COP Balance (200000000 = $2,000,000.00 COP). |
content.status.state completed |
→ | fx_status Map completed → proceed to local delivery; failed/rejected → re-quote or re-fund. |
Create Beneficiary Counterparty
Register the Colombian beneficiary for Fast Pay / ACH (cc, ch, dp) or Bre-B (breb_key). Account-based types deduplicate idempotently — Cobre returns an existing counterparty_id when data matches.
| Authorization | Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjbGlfcmVtaXRfY28wMSJ9.Rm8xQ3pL2nV7kWd9pT4bH6fY0gJ |
| Content-Type | application/json |
{ "geo": "col",GeographyiGeography code (e.g. col = Colombia, mex = Mexico). "type": "ch",Account typeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "alias": "Beneficiary remit_000456",AliasiDisplay name that helps identify it and clarify its purpose. "metadata": {MetadataiCustom key-value metadata attached to the resource. "counterparty_fullname": "Maria Lopez Garcia",Full nameiLegal or display name of the counterparty beneficiary. "beneficiary_institution": "1007",Bank codeiBank or institution code for the destination account. "account_number": "91234567890",Account numberiBank account or CLABE number for the counterparty. "counterparty_id_type": "cc",ID typeiType of identification document for the counterparty (e.g. nit, cc, rfc). "counterparty_id_number": "1023456789"ID numberiIdentification number for the counterparty. }}{ "id": "cp_BenefRem456",IdiUnique Cobre identifier for this resource. "geo": "col",GeographyiGeography code (e.g. col = Colombia, mex = Mexico). "type": "ch",Account typeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "alias": "Beneficiary remit_000456",AliasiDisplay name that helps identify it and clarify its purpose. "metadata": {MetadataiCustom key-value metadata attached to the resource. "counterparty_fullname": "Maria Lopez Garcia",Full nameiLegal or display name of the counterparty beneficiary. "beneficiary_institution": "1007",Bank codeiBank or institution code for the destination account. "account_number": "91234567890",Account numberiBank account or CLABE number for the counterparty. "counterparty_id_type": "cc",ID typeiType of identification document for the counterparty (e.g. nit, cc, rfc). "counterparty_id_number": "1023456789",ID numberiIdentification number for the counterparty. "registered_account": falseRegistered AccountiCobre field at "metadata.registered_account" in this payload. }, "created_at": "2026-06-03T10:05:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "updated_at": "2026-06-03T10:05:00Z"Updated AtiTimestamp of the last update (ISO 8601, UTC).}Deliver COP to Beneficiary
Pay the converted COP from the COP Balance to the beneficiary. Cobre selects Fast Pay when supported, otherwise ACH — the response type shows which rail was used. Amount must match the COP credited by the cross-border leg (minus any platform fees).
| Authorization | Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjbGlfcmVtaXRfY28wMSJ9.Rm8xQ3pL2nV7kWd9pT4bH6fY0gJ |
| Content-Type | application/json |
| idempotency | remit_payout_000456 |
{ "source_id": "acc_RemitCop01",COP BalanceiCobre id of the source account or counterparty. "destination_id": "cp_BenefRem456",Beneficiary counterpartyiCobre id of the destination account or counterparty. "amount": 200000000,Amount (cents)i200000000 cents = COP $2,000,000.00. "metadata": {MetadataiCustom key-value metadata attached to the resource. "description": "Remittance payout remit_000456"DescriptioniHuman-readable label or note. }, "external_id": "remit_payout_000456"External ID (payout leg)iYour own reference echoed by Cobre for reconciliation.}{ "id": "mm_PayoutRem456",IdiUnique Cobre identifier for this resource. "status": {StatusiLifecycle status object for the resource or movement. "state": "initiated",StateiCurrent lifecycle state (e.g. completed, failed, rejected). "code": "",CodeiProvider or Cobre status code when the state is failed or rejected. "description": ""DescriptioniHuman-readable detail for the current status. }, "metadata": {MetadataiCustom key-value metadata attached to the resource. "description": "Remittance payout remit_000456"DescriptioniHuman-readable label or note. }, "creator": "cli_remit_co01",CreatoriAPI client id that created this resource. "external_id": "remit_payout_000456",External ID (payout leg)iYour own reference echoed by Cobre for reconciliation. "checker_approval": false,Checker ApprovaliWhen true, Cobre pauses at pending_approval and locks source funds until an approval/denial decision via Money Movement Approvals API. "mm_approval_id": "",Mm Approval IdiMoney Movement Approval id (mma_…) when checker_approval is true — used for the decision endpoint. "type": "fast_pay",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "geo": "col",GeoiGeography code (e.g. col = Colombia, mex = Mexico). "source_id": "acc_RemitCop01",COP BalanceiCobre id of the source account or counterparty. "destination_id": "cp_BenefRem456",Beneficiary counterpartyiCobre id of the destination account or counterparty. "currency": "cop",CurrencyiISO currency code (e.g. cop, mxn). "amount": 200000000,Amount (cents)i200000000 cents = COP $2,000,000.00. "created_at": "2026-06-03T10:06:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "updated_at": "2026-06-03T10:06:00Z"Updated AtiTimestamp of the last update (ISO 8601, UTC).}Webhook outcomes — Money movement
Local payout completed — mark the remittance delivered on your ledger using external_id remit_payout_<remittance_id>. On rejected / failed / returned, funds remain in (or return to) the COP Balance for re-attempt or refund.
Handle each terminal state in your webhook listener. Status codes reference the <a href="https://docs.cobre.com/money-movement-statuses-2032280m0" target="_blank" rel="noopener">Money Movement Statuses</a> guide. Cobre Balance transactions are covered in the <b>Transaction</b> tab.
Funds settled successfully. No error code is set (NA in the status guide). Use this webhook to mark the payment as paid in your system.
money_movements.status.completed| Content-Type | application/json |
{ "id": "ev_PayoutRem456Cmp",IdiUnique Cobre identifier for this resource. "event_key": "money_movements.status.completed",Event KeyiWebhook subscription key (e.g. money_movements.status.completed). "created_at": "2026-06-03T10:08:30Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "content": {ContentiEvent-specific payload — same layout as the GET response for that resource. "id": "mm_PayoutRem456",IdiUnique Cobre identifier for this resource. "status": {StatusiLifecycle status object for the resource or movement. "state": "completed",StateiCurrent lifecycle state (e.g. completed, failed, rejected). "code": "",CodeiProvider or Cobre status code when the state is failed or rejected. "description": ""DescriptioniHuman-readable label or note. }, "metadata": {MetadataiCustom key-value metadata attached to the resource. "description": "Remittance payout remit_000456",DescriptioniHuman-readable label or note. "tracking_key": "20260603mmPayoutRem456"Tracking KeyiBre-B tracking key for the payment. }, "creator": "cli_remit_co01",CreatoriAPI client id that created this resource. "external_id": "remit_payout_000456",External IdiYour own reference echoed by Cobre for reconciliation. "checker_approval": false,Checker ApprovaliWhen true, Cobre pauses at pending_approval and locks source funds until an approval/denial decision via Money Movement Approvals API. "mm_approval_id": "",Mm Approval IdiMoney Movement Approval id (mma_…) when checker_approval is true — used for the decision endpoint. "type": "fast_pay",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "geo": "col",GeoiGeography code (e.g. col = Colombia, mex = Mexico). "source_id": "acc_RemitCop01",Source IdiCobre id of the source account or counterparty. "destination_id": "cp_BenefRem456",Destination IdiCobre id of the destination account or counterparty. "currency": "cop",CurrencyiISO currency code (e.g. cop, mxn). "amount": 200000000,AmountiAmount in cents — the last two digits are decimals. "created_at": "2026-06-03T10:06:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "updated_at": "2026-06-03T10:08:30Z"Updated AtiTimestamp of the last update (ISO 8601, UTC). }}Cobre or the rail could not process the movement. Inspect status.code and status.description — common failed codes include:
F001 | Payment processing failed — please try again. |
F002 | NSF — not sufficient funds in the designated account. |
F003 | R2P payment link expired (payins). |
F004 | Daily transaction amount limit has been reached. |
F005 | Amount exceeds the maximum allowed transaction limit. |
F098 | Could not process the money movement at this time. |
F099 | Could not process the money movement at this time. |
money_movements.status.failed| Content-Type | application/json |
{ "id": "ev_PayoutRem456Cmp",IdiUnique Cobre identifier for this resource. "event_key": "money_movements.status.failed",Event KeyiWebhook subscription key (e.g. money_movements.status.completed). "created_at": "2026-06-03T10:08:30Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "content": {ContentiEvent-specific payload — same layout as the GET response for that resource. "id": "mm_PayoutRem456",IdiUnique Cobre identifier for this resource. "status": {StatusiLifecycle status object for the resource or movement. "state": "failed",StateiCurrent lifecycle state (e.g. completed, failed, rejected). "code": "F002",CodeiProvider or Cobre status code when the state is failed or rejected. "description": "NSF — not sufficient funds in the designated account."DescriptioniHuman-readable label or note. }, "metadata": {MetadataiCustom key-value metadata attached to the resource. "description": "Remittance payout remit_000456",DescriptioniHuman-readable label or note. "tracking_key": "20260603mmPayoutRem456"Tracking KeyiBre-B tracking key for the payment. }, "creator": "cli_remit_co01",CreatoriAPI client id that created this resource. "external_id": "remit_payout_000456",External IdiYour own reference echoed by Cobre for reconciliation. "checker_approval": false,Checker ApprovaliWhen true, Cobre pauses at pending_approval and locks source funds until an approval/denial decision via Money Movement Approvals API. "mm_approval_id": "",Mm Approval IdiMoney Movement Approval id (mma_…) when checker_approval is true — used for the decision endpoint. "type": "fast_pay",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "geo": "col",GeoiGeography code (e.g. col = Colombia, mex = Mexico). "source_id": "acc_RemitCop01",Source IdiCobre id of the source account or counterparty. "destination_id": "cp_BenefRem456",Destination IdiCobre id of the destination account or counterparty. "currency": "cop",CurrencyiISO currency code (e.g. cop, mxn). "amount": 200000000,AmountiAmount in cents — the last two digits are decimals. "created_at": "2026-06-03T10:06:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "updated_at": "2026-06-03T10:08:30Z"Updated AtiTimestamp of the last update (ISO 8601, UTC). }}The bank or payment network rejected the transaction. Inspect status.code — common rejected codes include:
R000 | Transaction rejected. |
R001 | Inactive or blocked account. |
R002 | Account and identification provided do not coincide. |
R005 | Account does not exist. |
R006 | Invalid account number. |
R009 | Exceeds maximum allowed amount. |
R018 | Payment rejected due to invalid key (payouts). |
R023 | Payment cancelled by the user. |
R026 | Payment rejected due to unavailable bank services. |
R034 | Account closed. |
R085 | Bank processing error (payouts). |
money_movements.status.rejected| Content-Type | application/json |
{ "id": "ev_PayoutRem456Cmp",IdiUnique Cobre identifier for this resource. "event_key": "money_movements.status.rejected",Event KeyiWebhook subscription key (e.g. money_movements.status.completed). "created_at": "2026-06-03T10:08:30Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "content": {ContentiEvent-specific payload — same layout as the GET response for that resource. "id": "mm_PayoutRem456",IdiUnique Cobre identifier for this resource. "status": {StatusiLifecycle status object for the resource or movement. "state": "rejected",StateiCurrent lifecycle state (e.g. completed, failed, rejected). "code": "R001",CodeiProvider or Cobre status code when the state is failed or rejected. "description": "Inactive or blocked account."DescriptioniHuman-readable label or note. }, "metadata": {MetadataiCustom key-value metadata attached to the resource. "description": "Remittance payout remit_000456",DescriptioniHuman-readable label or note. "tracking_key": "20260603mmPayoutRem456"Tracking KeyiBre-B tracking key for the payment. }, "creator": "cli_remit_co01",CreatoriAPI client id that created this resource. "external_id": "remit_payout_000456",External IdiYour own reference echoed by Cobre for reconciliation. "checker_approval": false,Checker ApprovaliWhen true, Cobre pauses at pending_approval and locks source funds until an approval/denial decision via Money Movement Approvals API. "mm_approval_id": "",Mm Approval IdiMoney Movement Approval id (mma_…) when checker_approval is true — used for the decision endpoint. "type": "fast_pay",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "geo": "col",GeoiGeography code (e.g. col = Colombia, mex = Mexico). "source_id": "acc_RemitCop01",Source IdiCobre id of the source account or counterparty. "destination_id": "cp_BenefRem456",Destination IdiCobre id of the destination account or counterparty. "currency": "cop",CurrencyiISO currency code (e.g. cop, mxn). "amount": 200000000,AmountiAmount in cents — the last two digits are decimals. "created_at": "2026-06-03T10:06:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "updated_at": "2026-06-03T10:08:30Z"Updated AtiTimestamp of the last update (ISO 8601, UTC). }}Payouts debit the source Cobre Balance while the movement is processing to lock funds. If the movement ends in failed, rejected, or canceled, Cobre posts a compensation credit (breb_credit or col_cb_credit). Payins credit the destination on completion only.
While the movement is in processing, Cobre debits the source Cobre Balance to lock the payout amount. Subscribe to accounts.balance.debit and money_movements.status.processing.
accounts.balance.debit| Content-Type | application/json |
{ "id": "ev_PayoutRem4Lk",IdiUnique Cobre identifier for this resource. "event_key": "accounts.balance.debit",Event KeyiWebhook subscription key (e.g. money_movements.status.completed). "created_at": "2026-06-03T10:06:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "content": {ContentiEvent-specific payload — same layout as the GET response for that resource. "id": "trx_PayoutRem456Lk",IdiUnique Cobre identifier for this resource. "type": "col_cb_debit",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "account_id": "acc_RemitCop01",Account IdiCobre Balance account id affected by the event. "amount": -200000000,AmountiAmount in cents — the last two digits are decimals. "previous_balance": 205000000,Previous BalanceiCobre field at "content.previous_balance" in this payload. "current_balance": 5000000,Current BalanceiCobre field at "content.current_balance" in this payload. "currency": "COP",CurrencyiISO currency code (e.g. cop, mxn). "credit_debit_type": "debit",Credit Debit Typeicredit = funds in; debit = funds out. "transaction_date": "2026-06-03T10:06:00Z",Transaction DateiTimestamp when the transaction was posted (ISO 8601, UTC). "created_at": "2026-06-03T10:06:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "metadata": {MetadataiCustom key-value metadata attached to the resource. "money_movement_id": "mm_PayoutRem456",Money Movement IdiMoney Movement that generated this balance transaction. "description": "Remittance payout remit_000456",DescriptioniHuman-readable label or note. "beneficiary_account_number": "",Beneficiary Account NumberiMetadata field "beneficiary_account_number" attached to the resource. "tracking_key": "20260603mmPayoutRem456"Tracking KeyiBre-B tracking key for the payment. } }}On completion the locked funds are sent to the beneficiary. The processing debit remains on the ledger — no compensation credit is posted.
accounts.balance.debit| Content-Type | application/json |
{ "id": "ev_PayoutRem4Lk",IdiUnique Cobre identifier for this resource. "event_key": "accounts.balance.debit",Event KeyiWebhook subscription key (e.g. money_movements.status.completed). "created_at": "2026-06-03T10:06:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "content": {ContentiEvent-specific payload — same layout as the GET response for that resource. "id": "trx_PayoutRem456Lk",IdiUnique Cobre identifier for this resource. "type": "col_cb_debit",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "account_id": "acc_RemitCop01",Account IdiCobre Balance account id affected by the event. "amount": -200000000,AmountiAmount in cents — the last two digits are decimals. "previous_balance": 205000000,Previous BalanceiCobre field at "content.previous_balance" in this payload. "current_balance": 5000000,Current BalanceiCobre field at "content.current_balance" in this payload. "currency": "COP",CurrencyiISO currency code (e.g. cop, mxn). "credit_debit_type": "debit",Credit Debit Typeicredit = funds in; debit = funds out. "transaction_date": "2026-06-03T10:06:00Z",Transaction DateiTimestamp when the transaction was posted (ISO 8601, UTC). "created_at": "2026-06-03T10:06:00Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "metadata": {MetadataiCustom key-value metadata attached to the resource. "money_movement_id": "mm_PayoutRem456",Money Movement IdiMoney Movement that generated this balance transaction. "description": "Remittance payout remit_000456",DescriptioniHuman-readable label or note. "beneficiary_account_number": "",Beneficiary Account NumberiMetadata field "beneficiary_account_number" attached to the resource. "tracking_key": "20260603mmPayoutRem456"Tracking KeyiBre-B tracking key for the payment. } }}If the movement reaches a terminal failed, rejected, or canceled state, Cobre credits the source Cobre Balance to release the lock (breb_credit for Bre-B, col_cb_credit for bank rails).
accounts.balance.credit| Content-Type | application/json |
{ "id": "ev_PayoutRem4Cp",IdiUnique Cobre identifier for this resource. "event_key": "accounts.balance.credit",Event KeyiWebhook subscription key (e.g. money_movements.status.completed). "created_at": "2026-06-03T10:08:30Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "content": {ContentiEvent-specific payload — same layout as the GET response for that resource. "id": "trx_PayoutRem456Cp",IdiUnique Cobre identifier for this resource. "type": "col_cb_credit",TypeiResource or movement type as defined by the Cobre API for this rail/product (e.g. breb_credit for Cobre Key payins). "account_id": "acc_RemitCop01",Account IdiCobre Balance account id affected by the event. "amount": 200000000,AmountiAmount in cents — the last two digits are decimals. "previous_balance": 0,Previous BalanceiCobre field at "content.previous_balance" in this payload. "current_balance": 200000000,Current BalanceiCobre field at "content.current_balance" in this payload. "currency": "COP",CurrencyiISO currency code (e.g. cop, mxn). "credit_debit_type": "credit",Credit Debit Typeicredit = funds in; debit = funds out. "transaction_date": "2026-06-03T10:08:30Z",Transaction DateiTimestamp when the transaction was posted (ISO 8601, UTC). "created_at": "2026-06-03T10:08:30Z",Created AtiTimestamp when the resource was created (ISO 8601, UTC). "metadata": {MetadataiCustom key-value metadata attached to the resource. "money_movement_id": "mm_PayoutRem456",Money Movement IdiMoney Movement that generated this balance transaction. "description": "Remittance payout remit_000456",DescriptioniHuman-readable label or note. "tracking_key": "20260603mmPayoutRem456",Tracking KeyiBre-B tracking key for the payment. "sender_name": "",Sender NameiMetadata field "sender_name" attached to the resource. "sender_id": "",Sender IdiMetadata field "sender_id" attached to the resource. "sender_account_number": ""Sender Account NumberiMetadata field "sender_account_number" attached to the resource. } }}Reconcile the Remittance
Close the local payout leg on your remittance ledger. Pair with the Cross-Border reconciliation (remit_fx_000456) for end-to-end correlation on remittance_id 000456.
Mapping the webhook payload from an earlier step onto Remittance ledger. No API call is made — this step closes the loop in your own system.
| Cobre field & value | Remittance ledger field | |
content.external_id remit_payout_000456 |
→ | payout_external_id Local leg — pair with remit_fx_000456 on the Cross-Border movement for end-to-end correlation. |
content.id mm_PayoutRem456 |
→ | cobre_mm_id |
content.amount 200000000 |
→ | delivered_amount_cents |
content.type fast_pay |
→ | payout_rail fast_pay or ach — the rail Cobre selected for bank-account delivery. |
content.status.state completed |
→ | remittance_status Map completed → DELIVERED; rejected/failed/returned → exception workflow. |