{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["sub-heading","endpoint","br","details","required","tabs","tab","admonition","json-example"]},"type":"markdown"},"seo":{"title":"Bre-B transaction","description":"Transform your commerce with PXP's unified platform—seamless payments, real-time insights, and global growth in one powerful integration.","lang":"en-UK","siteUrl":"https://developer.pxp.io","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"bre-b-transaction","__idx":0},"children":["Bre-B transaction"]},{"$$mdtype":"Tag","name":"SubHeading","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Provision a reusable Bre-B Llave, then process online Bre-B payouts using pay by bank."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Bre-B deposits don't use a standard transaction initiation request. Instead, you provision a reusable Bre-B Llave once per shopper, display the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brebKey"]}," from that response to the shopper as the destination they should pay to, and the shopper transfers funds from their own banking app. PXP creates the deposit when the processor notifies it, and sends you the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-executed"]}," webhook as your first and authoritative notice of the deposit."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can submit a Bre-B payout in these ways:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payout (withdrawal), new Llave:"]}," Create a pay-by-bank transaction with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apmProvider"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Breb"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["intent"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payout"]},", and supply ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bankAccountNumber"]}," with the provisioned Llave (including the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@"]}," prefix). Capture ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData.payByBank.gatewayTokenId"]}," from the response to reuse the destination later."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payout (withdrawal), stored Llave:"]}," Create a payout and supply ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gatewaytokenid"]}," from an earlier accepted payout instead of resending the Llave."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Bre-B supports ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COP"]}," only. Provision and payout requests use Colombian shopper identity details (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CO"]}," in the examples below). Treat merchant webhooks as the authoritative final outcome. There's no hosted redirect step for Bre-B, and Bre-B doesn't support alias updates. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/get-started/about-webhooks"},"children":["Learn more about webhooks"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"provision-a-bre-b-llave","__idx":2},"children":["Provision a Bre-B Llave"]},{"$$mdtype":"Tag","name":"Endpoint","attributes":{"method":"POST"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["/v1/transaction-contexts"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the following request to provision a reusable Bre-B Llave for a shopper. The call creates no transaction. Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apmProvider"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Breb"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"merchant\": \"MERCHANT-1\",\n  \"site\": \"SITE-1\",\n  \"apmProvider\": \"Breb\",\n  \"shopperId\": \"Shopper_CO_01\",\n  \"userName\": \"juan.perez\",\n  \"email\": \"juan.perez@example.com\",\n  \"firstName\": \"Juan\",\n  \"lastName\": \"Perez\",\n  \"country\": \"CO\",\n  \"documentType\": \"IdentityDocument\",\n  \"documentNumber\": \"1234567890\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (≤ 20 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your unique merchant identifier, as assigned by PXP."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["site"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (≤ 20 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your unique site identifier, as assigned by PXP."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apmProvider"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The APM provider for this provision request. For Bre-B, this must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Breb"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shopperId"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your unique identifier for this shopper."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userName"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (3-50 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper's username for Bre-B provision."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (email, 3-50 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper's email address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (3-50 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper's first name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastName"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (3-50 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper's last name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (2 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper's country, in ISO 3166-1 alpha-2 format. For Bre-B, use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CO"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["documentType"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper identity document type.",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},"Possible values:",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IdentityDocument"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Passport"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaxIdNumber"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ForeignResidentCard"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CivilRegisterId"]},"."]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["documentNumber"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper identity document number. It must match Colombia format rules for the chosen ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["documentType"]},":",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IdentityDocument"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaxIdNumber"]},": 1-10 digits"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ForeignResidentCard"]},": 6-7 digits"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Passport"]},": 1-12 alphanumeric"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CivilRegisterId"]},": 10 digits"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-example","__idx":3},"children":["Response example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your request is successful, you'll receive a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Success"]},". Show the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brebKey"]}," to the shopper. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isEligibleForWithdrawal"]}," is always returned: it's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," immediately after provision and becomes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," after a successful pay-in. On failure, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Error"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["stateData"]}," carries the mapped fault detail. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brebKey"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["provisionedAt"]}," are omitted when they don't apply."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"transactionContextId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"brebKey\": \"@pxpshopper01\",\n  \"provisionedAt\": \"2026-08-28T12:00:00Z\",\n  \"isEligibleForWithdrawal\": false,\n  \"status\": \"Success\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After you display the Llave, don't call any API when the shopper deposits. Wait for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-executed"]}," webhook, which creates and confirms the deposit. Deposit notifications may have a null ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantTransactionId"]}," because there was no merchant create call. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/get-started/about-webhooks"},"children":["Learn more about webhooks"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"initiate-a-bre-b-payout","__idx":4},"children":["Initiate a Bre-B payout"]},{"$$mdtype":"Tag","name":"Endpoint","attributes":{"method":"POST"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["/v1/transactions"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-examples","__idx":5},"children":["Request examples"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Payout (new Llave)","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the following request to start a Bre-B withdrawal when you supply the destination Llave for the first time. Capture ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData.payByBank.gatewayTokenId"]}," from the response so you can reuse the same destination later."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"merchant\": \"MERCHANT-1\",\n  \"site\": \"SITE-1\",\n  \"merchantTransactionId\": \"BREB-PAYOUT-001\",\n  \"merchantTransactionDate\": \"2026-08-28T12:00:00Z\",\n  \"transactionMethod\": {\n    \"intent\": \"Payout\",\n    \"entryType\": \"Ecom\",\n    \"fundingType\": \"PayByBank\"\n  },\n  \"fundingData\": {\n    \"payByBank\": {\n      \"apmProvider\": \"Breb\",\n      \"bankAccountNumber\": \"@pxpshopper01\"\n    }\n  },\n  \"amounts\": {\n    \"transaction\": 100.00,\n    \"currencyCode\": \"COP\"\n  },\n  \"shopper\": {\n    \"id\": \"Shopper_CO_01\",\n    \"firstName\": \"Juan\",\n    \"lastName\": \"Perez\",\n    \"email\": \"juan.perez@example.com\",\n    \"countryCode\": \"CO\",\n    \"documentType\": \"IdentityDocument\",\n    \"documentNumber\": \"1234567890\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (≤ 20 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your unique merchant identifier, as assigned by PXP."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["site"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (≤ 20 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your unique site identifier, as assigned by PXP."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantTransactionId"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (≤ 50 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A unique identifier for this transaction."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantTransactionDate"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["date-time"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The date and time when the transaction happened, in ISO 8601 format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionMethod"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Details about the transaction method."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionMethod.entryType"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The entry type. For e-commerce Bre-B transactions, this is always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ecom"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionMethod.fundingType"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The funding type. For Bre-B, this is always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PayByBank"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionMethod.intent"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The payment intent. For a Bre-B withdrawal, set this to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payout"]},". Purchase create isn't supported for Bre-B on this endpoint. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/transactions/how-it-works#intents"},"children":["Learn more about intents"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amounts"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Details about the transaction amount."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amounts.transaction"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction amount. The numbers after the decimal will be zero padded if they are less than the expected ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currencyCode"]}," exponent. For example, GBP 1.1 = GBP 1.10, EUR 1 = EUR 1.00, or BHD 1.3 = 1.300. The transaction will be rejected if numbers after the decimal are greater than the expected ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currencyCode"]}," exponent (e.g., GBP 1.234), or if a decimal is supplied when the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currencyCode"]}," exponent does not require it (e.g., JPY 1.0)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amounts.currencyCode"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (1-3 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The currency code associated with the transaction, in ISO 4217 format. For Bre-B, this must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COP"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Details about the payment method used for the transaction. For Bre-B, use the Pay by bank funding shape only."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData.payByBank"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pay by bank funding details for Bre-B."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData.payByBank.apmProvider"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The APM provider. For Bre-B, this must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Breb"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData.payByBank.bankAccountNumber"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (6-21 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The destination Bre-B Llave, including the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@"]}," prefix. Required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gatewaytokenid"]}," isn't supplied. Typically the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brebKey"]}," returned when you provision a Bre-B transaction context."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shopper"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Details about the shopper receiving the payout. Include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["documentType"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["documentNumber"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shopper.countryCode"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (2 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper's country, in ISO 3166-1 alpha-2 format. For Bre-B, use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CO"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shopper.documentType"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper identity document type.",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},"Possible values:",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IdentityDocument"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Passport"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaxIdNumber"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ForeignResidentCard"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CivilRegisterId"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shopper.documentNumber"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper identity document number. It must match Colombia format rules for the chosen ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["documentType"]},"."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Payout (stored Llave)","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the following request to start a Bre-B withdrawal when you already have a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gatewaytokenid"]}," from an earlier accepted payout. You don't need to resend the Llave."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"merchant\": \"MERCHANT-1\",\n  \"site\": \"SITE-1\",\n  \"merchantTransactionId\": \"BREB-PAYOUT-002\",\n  \"merchantTransactionDate\": \"2026-08-28T12:00:00Z\",\n  \"transactionMethod\": {\n    \"intent\": \"Payout\",\n    \"entryType\": \"Ecom\",\n    \"fundingType\": \"PayByBank\"\n  },\n  \"fundingData\": {\n    \"payByBank\": {\n      \"apmProvider\": \"Breb\",\n      \"gatewaytokenid\": \"b6e2f1a4-c3d8-4f7a-b1e9-d2c3f4a5b6c7\"\n    }\n  },\n  \"amounts\": {\n    \"transaction\": 100.00,\n    \"currencyCode\": \"COP\"\n  },\n  \"shopper\": {\n    \"id\": \"Shopper_CO_01\",\n    \"firstName\": \"Juan\",\n    \"lastName\": \"Perez\",\n    \"email\": \"juan.perez@example.com\",\n    \"countryCode\": \"CO\",\n    \"documentType\": \"IdentityDocument\",\n    \"documentNumber\": \"1234567890\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (≤ 20 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your unique merchant identifier, as assigned by PXP."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["site"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (≤ 20 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your unique site identifier, as assigned by PXP."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantTransactionId"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (≤ 50 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A unique identifier for this transaction."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantTransactionDate"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["date-time"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The date and time when the transaction happened, in ISO 8601 format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionMethod"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Details about the transaction method."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionMethod.entryType"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The entry type. For e-commerce Bre-B transactions, this is always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ecom"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionMethod.fundingType"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The funding type. For Bre-B, this is always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PayByBank"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionMethod.intent"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The payment intent. For a Bre-B withdrawal, set this to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payout"]},". Purchase create isn't supported for Bre-B on this endpoint. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/transactions/how-it-works#intents"},"children":["Learn more about intents"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amounts"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Details about the transaction amount."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amounts.transaction"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction amount. The numbers after the decimal will be zero padded if they are less than the expected ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currencyCode"]}," exponent. For example, GBP 1.1 = GBP 1.10, EUR 1 = EUR 1.00, or BHD 1.3 = 1.300. The transaction will be rejected if numbers after the decimal are greater than the expected ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currencyCode"]}," exponent (e.g., GBP 1.234), or if a decimal is supplied when the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currencyCode"]}," exponent does not require it (e.g., JPY 1.0)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amounts.currencyCode"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (1-3 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The currency code associated with the transaction, in ISO 4217 format. For Bre-B, this must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COP"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Details about the payment method used for the transaction. For Bre-B, use the Pay by bank funding shape only."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData.payByBank"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pay by bank funding details for Bre-B."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData.payByBank.apmProvider"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The APM provider. For Bre-B, this must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Breb"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData.payByBank.gatewaytokenid"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The reference to a stored PXP payment account for the destination Llave. Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData.payByBank.gatewayTokenId"]}," value from an earlier accepted Bre-B payout response. The JSON property name is lowercase."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shopper"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Details about the shopper receiving the payout. Include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["documentType"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["documentNumber"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shopper.countryCode"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (2 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper's country, in ISO 3166-1 alpha-2 format. For Bre-B, use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CO"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shopper.documentType"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper identity document type.",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},"Possible values:",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IdentityDocument"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Passport"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaxIdNumber"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ForeignResidentCard"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CivilRegisterId"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shopper.documentNumber"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shopper identity document number. It must match Colombia format rules for the chosen ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["documentType"]},"."]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-example-1","__idx":6},"children":["Response example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your request is successful, you'll receive a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response. For a successful Bre-B payout initiation, expect a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Pending"]}," state with no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redirectUrl"]},", plus ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData.payByBank.paymentId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingData.payByBank.gatewayTokenId"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The final outcome is delivered by a Bre-B merchant webhook (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-executed"]},"). ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#webhooks"},"children":["See ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Webhooks"]}," below"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Always use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["systemTransactionId"]}," for later PXP API calls against the same transaction. Provider payment identifiers are for reconciliation and support only."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"state\": \"Pending\",\n  \"systemTransactionId\": \"1ed768bb-e88a-4636-91ae-67927ccbb02b\",\n  \"merchantTransactionId\": \"BREB-PAYOUT-001\",\n  \"fundingData\": {\n    \"payByBank\": {\n      \"apmProvider\": \"Breb\",\n      \"paymentId\": \"7c1d8e32-4a6b-4f9c-b2d3-1e2f3a4b5c6d\",\n      \"gatewayTokenId\": \"b6e2f1a4-c3d8-4f7a-b1e9-d2c3f4a5b6c7\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Bre-B deposits support a full refund only. Refund against the pay-in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["systemTransactionId"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["operation"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Refund"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundingType"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PayByBank"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apmProvider"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Breb"]},". See our standalone ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/transactions/refund"},"children":["Refund"]}," guide for the request shape and response."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"webhooks","__idx":7},"children":["Webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Treat Bre-B merchant webhooks as the authoritative final outcome for deposits, payouts, and refunds. Don't treat the transaction initiation response alone as settlement for a payout."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionMethod.intent"]}," to tell deposits (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Purchase"]},") and payouts (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payout"]},") apart when they share the same event code. For deposits, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-executed"]}," is your first notice of the transaction, so ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantTransactionId"]}," may be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},". Correlate deposits by using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["systemTransactionId"]}," and the shopper's Bre-B context."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following event codes apply to Bre-B:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"35%","data-label":"Event code"},"children":["Event code "]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"State"},"children":["State"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%","data-label":"Description"},"children":["Description "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-executed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorised"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A Bre-B deposit or payout has reached a successful terminal state. For deposits, this is the first notice of the transaction."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-declined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Refused"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A Bre-B payout was declined."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-expired"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Expired"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A Bre-B payout expired."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-failed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Refused"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A Bre-B payout failed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-refunded"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Refunded"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A Bre-B refund was confirmed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-rejected"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Rejected"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A Bre-B payout was rejected."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-cross-entry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Refused"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A Bre-B payout was refused because of a cross-entry outcome."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"examples","__idx":8},"children":["Examples"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Authorised","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful Bre-B deposit (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Purchase"]},") or payout (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payout"]},") uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-executed"]}," with state ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorised"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deposit (first notice of the pay-in; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantTransactionId"]}," may be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},"):"]},{"$$mdtype":"Tag","name":"JsonExample","attributes":{"json":{"eventDate":"2026-08-28T12:00:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"breb-transaction-order-executed","state":"Authorised","stateData":{"code":"APM003","message":"Payment authorised"},"amounts":{"transaction":100,"currencyCode":"COP"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Breb"}},"providerResponse":{"provider":"Breb","providerTransactionStatus":"Authorised","providerResponseCode":"EXECUTED","providerResponseMessage":"Payment authorised"},"merchantTransactionId":null,"systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"errors":[]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payout:"]},{"$$mdtype":"Tag","name":"JsonExample","attributes":{"json":{"eventDate":"2026-08-28T12:05:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"breb-transaction-order-executed","state":"Authorised","stateData":{"code":"APM003","message":"Payment authorised"},"amounts":{"transaction":100,"currencyCode":"COP"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Payout","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Breb"}},"providerResponse":{"provider":"Breb","providerTransactionStatus":"Authorised","providerResponseCode":"EXECUTED","providerResponseMessage":"Payment authorised"},"merchantTransactionId":"BREB-PAYOUT-001","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"errors":[]},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Refused","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Declined, failed, and cross-entry payouts resolve to state ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Refused"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Declined (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-declined"]},"):"]},{"$$mdtype":"Tag","name":"JsonExample","attributes":{"json":{"eventDate":"2026-08-28T12:15:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"breb-transaction-order-declined","state":"Refused","stateData":{"code":"APM004","message":"Payment declined"},"amounts":{"transaction":100,"currencyCode":"COP"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Payout","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Breb"}},"providerResponse":{"provider":"Breb","providerTransactionStatus":"Refused","providerResponseCode":"DECLINED","providerResponseMessage":"Payment declined"},"merchantTransactionId":"BREB-PAYOUT-001","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"errors":[]},"children":[]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Failed (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-failed"]},"):"]},{"$$mdtype":"Tag","name":"JsonExample","attributes":{"json":{"eventDate":"2026-08-28T12:25:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"breb-transaction-order-failed","state":"Refused","stateData":{"code":"APM012","message":"Payment failed"},"amounts":{"transaction":100,"currencyCode":"COP"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Payout","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Breb"}},"providerResponse":{"provider":"Breb","providerTransactionStatus":"Refused","providerResponseCode":"FAILED","providerResponseMessage":"Payment failed"},"merchantTransactionId":"BREB-PAYOUT-001","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"errors":[]},"children":[]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cross-entry (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-cross-entry"]},"):"]},{"$$mdtype":"Tag","name":"JsonExample","attributes":{"json":{"eventDate":"2026-08-28T12:40:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"breb-transaction-order-cross-entry","state":"Refused","stateData":{"code":"APM004","message":"Payment declined"},"amounts":{"transaction":100,"currencyCode":"COP"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Payout","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Breb"}},"providerResponse":{"provider":"Breb","providerTransactionStatus":"Refused","providerResponseCode":"CROSS_ENTRY","providerResponseMessage":"Payment declined"},"merchantTransactionId":"BREB-PAYOUT-001","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"errors":[]},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Expired","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An expired Bre-B payout uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-expired"]}," with state ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Expired"]},"."]},{"$$mdtype":"Tag","name":"JsonExample","attributes":{"json":{"eventDate":"2026-08-28T12:20:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"breb-transaction-order-expired","state":"Expired","stateData":{"code":"APM011","message":"Payment expired"},"amounts":{"transaction":100,"currencyCode":"COP"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Payout","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Breb"}},"providerResponse":{"provider":"Breb","providerTransactionStatus":"Expired","providerResponseCode":"EXPIRED","providerResponseMessage":"Payment expired"},"merchantTransactionId":"BREB-PAYOUT-001","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"errors":[]},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Refunded","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A confirmed Bre-B refund uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-refunded"]}," with state ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Refunded"]},"."]},{"$$mdtype":"Tag","name":"JsonExample","attributes":{"json":{"eventDate":"2026-08-28T12:30:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"breb-transaction-order-refunded","state":"Refunded","stateData":{"code":"APM007","message":"Payment refunded"},"amounts":{"transaction":100,"currencyCode":"COP"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Refund","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Breb"}},"providerResponse":{"provider":"Breb","providerTransactionStatus":"Refunded","providerResponseCode":"REFUNDED","providerResponseMessage":"Payment refunded"},"merchantTransactionId":"BREB-RFD-001","systemTransactionId":"3ab45678-cdef-9012-3456-789abcdef012"}},"errors":[]},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Rejected","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A rejected Bre-B payout uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breb-transaction-order-rejected"]}," with state ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Rejected"]},"."]},{"$$mdtype":"Tag","name":"JsonExample","attributes":{"json":{"eventDate":"2026-08-28T12:35:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"breb-transaction-order-rejected","state":"Rejected","stateData":{"code":"APM013","message":"Payment rejected"},"amounts":{"transaction":100,"currencyCode":"COP"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Payout","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Breb"}},"providerResponse":{"provider":"Breb","providerTransactionStatus":"Rejected","providerResponseCode":"REJECTED","providerResponseMessage":"Payment rejected"},"merchantTransactionId":"BREB-PAYOUT-001","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"errors":[]},"children":[]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To learn how to set up and process webhooks, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/get-started/manage-webhooks"},"children":["Manage webhooks"]},"."]}]}]},"headings":[{"value":"Bre-B transaction","id":"bre-b-transaction","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Provision a Bre-B Llave","id":"provision-a-bre-b-llave","depth":2},{"value":"Response example","id":"response-example","depth":3},{"value":"Initiate a Bre-B payout","id":"initiate-a-bre-b-payout","depth":2},{"value":"Request examples","id":"request-examples","depth":3},{"value":"Response example","id":"response-example-1","depth":3},{"value":"Webhooks","id":"webhooks","depth":2},{"value":"Examples","id":"examples","depth":3}],"frontmatter":{"seo":{"title":"Bre-B transaction"}},"lastModified":"2026-09-09T09:28:08.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/transactions/e-commerce/bre-b-transaction","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}