API Reference
Start typing to search…

Transaction Webhooks

Información sobre los movimientos realizados por Toku. El campo type en payment_instrument indica el método de pago utilizado para la transacción. La información del método de pago se encontrará en el campo con nombre igual al valor de type en payment_instrument.

transaction.success

Transaction type soportados en Chile para transaction.success

Transaction type 🇨🇱Detalle
cardPago con tarjetas (recurrentes y onetime)
transferTransferencias bancarias y botones bancarios
pac_managementGestión de PAC (incluye a Débito Directo)
cashIntegración con Servipag

Transaction type soportados en México transaction.success

Transaction type 🇲🇽Detalle
cardPago con tarjetas (recurrentes y onetime)
transferTransferencias bancarias
cashIntegración con Servipag
walletMovimientos de billetera digital (paypal)

Transaction type soportados en Brazil transaction.success

Transaction type 🇧🇷Detalle
cardPago con tarjetas (recurrentes y onetime)
boletoDocumento o código.
pixTransferencias instántaneas

Información sobre un pago exitoso.

{
  "id": "whe_hXPK3YBs4EUfw2KFZlB6R44MiFa07vFU",
  "event_type": "transaction.success",
  "transaction": {
    "id": "trs_rInqjZCm4O3O48rqfEw3k9JH-R9uLLLZ",
    "type": "PAYMENT",
    "amount": "5246.0000",
    "currency": "CLP",
    "transaction_date": "2024-04-30 19:01:41.733489",
    "status": "SUCCESS",
    "response_code": "SUTOK0000",
    "voucher": null,
    "transaction_metadata": {},
    "id_checkout_session": "5ae476ba-7b7d-48bd-ba59-e1d23c194d61",
    "external_id": 'producto-5-deuda-124333',
    "id_payout": null
  },
  "payment_instrument": {
    "type": "...",
    "card": {...},
    "transfer": {...},
    "cash": {...},
    "wallet": {...}
  },
  "customer": {
    "id": "cus_SqTQO486U9o5LhXQjN8_saZmZsyUltoh",
    "external_id": "106056161-3520308",
    "email": "[email protected]",
    "government_id": "106056161",
    "name": "Claudio Arenas",
    "phone_number": "+56#########"
  },
  "payment_intents": [
    {
      "id": "pi_8QUrs7ozSqnX1xr0fGqqqreOmEcl-7s7",
      "amount": "5146.0000",
      "currency": "CLP",
      "id_invoice": "in_8QUrs7ozSqnX1xr0fGqqqreOmEcl-7s7",
      "id_subscription": "sub_8QUrs7ozSqnX1xr0fGqqqreOmEcl-7s7",
      "invoice_external_id": null,
      "gateway": "",
      "price_change_amount": "0.00",
      "product_id": "product_id_10",
      "status": "AUTHORIZED",
      "type": "one_time",
      "is_partial": false, // Agregado en version 2025-09-03
      "is_last_payment": true // Agregado en version 2025-09-03
    }
  ],
  "wallet_movements": [
    {
      "id": "wmv_rInqjZCm4O3O48rqfEw3k9JH-R9uLLLZ",
      "type": "SURPLUS",
      "amount": 100.00
    }
  ]
}

El campo type en payment_instrument indica el método de pago utilizado para la transacción. La información del método de pago se encontrará en el campo con nombre igual al valor de type en payment_instrument.

🇨🇱transaction.failed

Transaction type sportados en Chile para transaction.failed

Transaction type 🇨🇱Detalle
cardPago con tarjetas (recurrentes y onetime)
transferTransferencias bancarias y botones bancarios
🚧

Para el caso de las transacciones type: pac_management y cash se está trabajando en implementar este webhook

Información sobre un pago fallido

{
  "id": "wheve_FEtKHJMKLFKJnrtxDHnM8o_M5JabacIC",
  "event_type": "transaction.failed",
  "transaction": {
    "id": "trs_jMMNl5DIAXne0oi6nl2DhFec7fa6pSet",
    "type": "PAYMENT",
    "amount": "15.0000",
    "currency": "CLP",
    "transaction_date": "2025-07-04 14:54:10.658079",
    "status": "FAILED",
    "transaction_metadata": {
      "buy_order": "1445408504730000"
    },
    "response_code": null,
    "voucher": null,
    "id_checkout_session": null,
    "external_id": null,
    "id_payout": null,
    "original_response_message": null
  },
  "customer": {
    "id": "cus_KtOcpyMbNwg31tXeMXGKv4Xz6L8i4E3R",
    "external_id": "195552015",
    "email": null,
    "government_id": "195552015",
    "name": "Antonio Stark",
    "phone_number": null
  },
  "payment_intents": [
    {
      "id": "pi_RxbYiBXUljw4047PIV1yhvgEOa1hwZIM",
      "amount": "15.0000",
      "currency": "CLP",
      "id_invoice": "in_rbX1wDNp_1pYAnVsMjJNn_arCRY1khfE",
      "id_subscription": "sub_jW2elQxHzSEHytiSN463DauELmgKr_qx",
      "invoice_external_id": "test-toku-transfer-2025-01-01",
      "id_account": "acc_46spPHnwxkdG56oezATsJyJuEzF_sx_4",
      "gateway": "pb_transfer_cl_banco_de_chile",
      "price_change_amount": "0.0000",
      "product_id": "test-toku-transfer",
      "status": "ABORTED",
      "type": "one_time",
      "is_partial": false, // Agregado en version 2025-09-03
      "is_last_payment": true // Agregado en version 2025-09-03
    }
  ],
  "payment_instrument": {
    "type": "transfer",
    "card": null,
    "transfer": {
      "country": "Chile",
      "institution_id": "cl_banco_de_chile",
      "account_type": null,
      "account_number": null,
      "payer_government_id": null
    },
    "cash": null,
    "pac_management": null,
    "patpass": null
  },
  "wallet_movements": []
}

🇲🇽transaction.failed

Transaction type en México transaction.failed

Transaction type 🇲🇽Detalle
cardPago con tarjetas
transferTransferencias bancarias
cashIntegración con Servipag
walletMovimientos de billetera digital (paypal)

Información sobre un pago fallido.

{
  "id": "wheve__ETSxl6ZF3mBkphZbIfQj5_fYAf-2FHl",
  "event_type": "transaction.failed",
  "transaction": {
    "id": "trs_PBCQK8S5t9dr8euHb5WWaa0_sOELCgoc",
    "type": "PAYMENT",
    "amount": "9450.0000",
    "currency": "MXN",
    "transaction_date": "2024-12-17 16:03:31.263605",
    "status": "FAILED",
    "transaction_metadata": {
      "enroll_card_toggle": false
    },
    "response_code": "TEKSH1008",
    "voucher": null,
    "id_checkout_session": null,
    "original_response_message": "Request Error"
  },
  "customer": {
    "id": "cus_DQZYUH734lKm2ecNl0atL6Xme37uuB_5",
    "external_id": "HEGG560427MVZRRL04",
    "email": "[email protected]",
    "government_id": "HEGG560427MVZRRL04",
    "name": "Harry Potter",
    "phone_number": "+521111111111"
  },
  "payment_intents": [
    {
      "id": "pi_LawiisiJ0d5UU10ps4e8PByGMUV7jVoF",
      "amount": "9450.0000",
      "currency": "MXN",
      "id_invoice": "in_8cKh6T2lEMSmpk_rhcBP7r6KBQprfv2Q",
      "id_subscription": "sub_KX7qM_OD7U8ohrF8fpHUzu51O4iagjwi",
      "invoice_external_id": "2024-03-18 14:14:04.031199",
      "id_account": "acc_jwONBafuYIcaaQuHrRPeHJI8Gve-r-M4",
      "gateway": "payment_orchestration",
      "price_change_amount": "450.0000",
      "product_id": "example",
      "status": "FAILED",
      "type": "one_time",
      "is_partial": false, // Agregado en version 2025-09-03
      "is_last_payment": true // Agregado en version 2025-09-03
    }
  ],
  "payment_instrument": {
    "type": "...",
    "card": {...},
    "transfer": {...},
    "cash": {...},
    "wallet": {...}
  },
  "wallet_movements": []
}

🇧🇷transaction.failed

Transaction type sportados en Brazil para transaction.failed

Transaction type 🇧🇷Detalle
cardPago con tarjetas (recurrentes y onetime)
boletoDocumento o código.
pixTransferencias instántaneas

Información sobre un pago fallido.

{
  "id":"wheve_EHSOy94fFpupWxrSai-VtvSlLfKpQKj-",
  "event_type":"transaction.failed",
  "transaction":{
    "id":"trs_ubd8IWJqtCeeI-GYWawRo2GP_ucWFYZz",
    "type":"PAYMENT",
    "amount":"100.0000",
    "currency":"BRL",
    "transaction_date":"2025-12-11 13:51:25.763469",
    "status":"ABORTED",
    "transaction_metadata":{
      "external_id":"600001175",
      "external_reference_number":"ba181cd004644c2c8a5184a57c1ffb20"
    },
    "response_code":"TETOK2049",
    "voucher":null,
    "id_checkout_session":null,
    "external_id":"600001175",
    "id_payout":null,
    "original_response_message":"aborted by toku"
  },
  "customer":{
    "id":"cus_GBzsq2mdwI7v98EVhxnPPOeyXRErWbvD",
    "name":"Oscar Toku",
    "email":"[email protected]",
    "external_id":"80447414887",
    "phone_number":null,
    "government_id":"80447414887"
  },
  "payment_intents":[
    {
      "id":"pi_SJ-X5rglo6asPsQNWWiAvkXrFGijwWOa",
      "amount":"100.0000",
      "currency":"BRL",
      "status":"ABORTED",
      "id_invoice":"in_aAysdURNVsxfJMY6-1dfTtZilCxx18N7",
      "id_subscription":"sub_AfQ4chhTcjQBuJIDSyclGBExjSJSgWgD",
      "invoice_external_id":"bolepix-2025-12-11-d1765461108331993",
      "id_account":"acc_jX7rEpLESDOAZvOAqSIuT6_BjFQaeFC6",
      "gateway":"br_sicredi_boleto",
      "price_change_amount":"0.0000",
      "product_id":"bolepix-d1765461108331993",
      "type":"one_time"
    }
  ],
  "payment_instrument":{
    "type":"boleto",
    "pix":null,
    "boleto":{
      "expiration_date":"2025-12-11 00:00:00",
      "validity_date":"2025-12-12 00:00:00",
      "barcode_url":"https://boleto-barcode.storage.googleapis.com/[REDACTED].png",
      "pdf_url":"https://storage.cloud.google.com/boleto-pdf/[REDACTED].pdf",
      "barcode":"74893129200000100001160000117526041904190105",
      "typeable_line_number":"74891160090011752604619041901059312920000010000"
    },
    "card":null
  },
  "wallet_movements":[
    
  ]
}

transaction.refund

Información sobre una devolución realizada o un contracargo. Incluye como información adicional (additional_data) el id de la transacción original.

El type de la Transaction varía según si es una devolución ("type": "REVERSED") o un contracargo ("type": "CHARGEBACK").

{
  "id": "whe_hXPK3YBs4EUfw2KFZlB6R44MiFa07vFU",
  "event_type": "transaction.refund",
  "transaction": {
    "id": "trs_rInqjZCm4O3O48rqfEw3k9JH-R9uLLLZ",
    "type": "REVERSED", /* o "CHARGEBACK" */
    "amount": 5246.00,
    "currency": "MXN",
    "transaction_date": "2024-04-30 19:01:41.733489",
    "status": "SUCCESS",
    "response_code": "SUTOK0000",
    "voucher": null,
    "id_checkout_session": "cs_rInqjZCm4O3O48rqfEw3k9JH-R9uLLLZ",
    "transaction_metadata": {}
  },
  "payment_instrument": {
    "type": "...",
    "card": {...},
    "transfer": {...},
    "cash": {...},
    "wallet": {...}
  },
  "customer": {
    "id": "cus_SqTQO486U9o5LhXQjN8_saZmZsyUltoh",
    "external_id": "106056161-3520308",
    "email": "[email protected]",
    "government_id": "106056161",
    "name": "Claudio Arenas",
    "phone_number": "+56#########"
  },
  "payment_intents": [
    {
      "id": "pi_rInqjZCm4O3Or0fGqqqreOmEcl-7s7",
      "amount": 5146.00,
      "currency": "MXN",
      "id_invoice": "in_8QUrs7ozSqnX1xr0fGqqqreOmEcl-7s7",
      "id_subscription": "sub_8QUrs7ozSqnX1xr0fGqqqreOmEcl-7s7",
      "invoice_external_id": null,
      "gateway": "paycash",
      "price_change_amount": 0.00,
      "product_id": "product_id_10",
      "status": "AUTHORIZED",
      "type": "one_time",
      "is_partial": false, // Agregado en version 2025-09-03
      "is_last_payment": true // Agregado en version 2025-09-03
    }
  ],
  "wallet_movements": [],
  "additional_data": {
    "transaction": {
      "id": "trs_rInqjZCm4O3O48rqfEw3k9JH-R9uLLLZ", 
      "type": "PAYMENT"
    }
  }
}

🇲🇽transaction.bulk_success

Información sobre pagos por lotes exitosos.

{
   "id":"wheve_f1Ubbycax6D2CR9lXmLTRAm3cGTcnFrF",
   "event_type":"transaction.bulk_success",
   "events":[
      {
         "transaction":{
            "id":"trs_lJWBAqIc7QYW443Hq_J8fZ2hl9R8kXhm",
            "type":"PAYMENT",
            "amount":"20.0000",
            "currency":"MXN",
            "transaction_date":"2024-10-10 15:16:08.593568",
            "status":"SUCCESS",
            "transaction_metadata":{...},
            "response_code":"SUTOK0000",
            "voucher":null,
            "id_checkout_session":null
         },
         "customer":{
            "id":"cus_rP88zmUc-UMnhZ26oUzoeMQKJSCoFW65",
            "external_id":"PEPJ000303MASRRNA2",
            "email":null,
            "government_id":"PEPJ000303MASRRNA2",
            "name":"PEPJ000303MASRRNA2",
            "phone_number":null
         },
         "payment_intents":[
            {
               "id":"pi_n3Y7QE5LM2weWTljMA5kbWu4FXQs1Gqa",
               "amount":"20.0000",
               "currency":"MXN",
               "id_invoice":"in_7h0OF8t5BBcJRiB3KuBpafhzS-WiScdo",
               "id_subscription":"sub_LQbXg5xdUqhtRasu2UeFrby6Kk_mKtfW",
               "invoice_external_id":"ARGOSPID3-2024-10-07",
               "id_account":"acc_tDxf4VycPU9-cokayp2M0I_wkYeBJbHG",
               "gateway":"mx_banco_scotiabank_h2h_external",
               "price_change_amount":"0.0000",
               "product_id":"ARGOSPID3",
               "status":"INITIALIZED",
               "type":"recurring",
               "is_partial": false, // Agregado en version 2025-09-03
               "is_last_payment": true // Agregado en version 2025-09-03
            }
         ],
         "payment_instrument": {
            "type": "...",
            "card": {...},
            "transfer": {...},
            "cash": {...},
            "wallet": {...}
          },
         "wallet_movements":[...]
      },
      {
      	 "transaction":{
            "id":"trs_AEX7XPb6KHPED9nIsPrR8K5IhJOdynEo",
            "type":"PAYMENT",
            "amount":"21.0000",
            "currency":"MXN",
            "transaction_date":"2024-10-10 15:16:08.637128",
            "status":"SUCCESS",
            "transaction_metadata":{
               
            },
            "response_code":"SUTOK0000",
            "voucher":null,
            "id_checkout_session":null
         },
         "customer":{
            "id":"cus_caoX2Z763devjASPAwCkqPZ5vWeuP75x",
            "external_id":"PEPJ000308MASRRNA7",
            "email":null,
            "government_id":"PEPJ000308MASRRNA7",
            "name":"Patricio Pino",
            "phone_number":null
         },
         "payment_intents":[
            {
               "id":"pi_bB7OuBc0riPgjJRgGoeeRacEfNdAHEF6",
               "amount":"21.0000",
               "currency":"MXN",
               "id_invoice":"in_8nLhUkSoaeGBpujMUJ6N0RxFLHdyI75_",
               "id_subscription":"sub_fVgaHfBu-Zh7V5Of8DGGozASzXfoy7FN",
               "invoice_external_id":"ARGOSPID8-2024-10-05",
               "id_account":"acc_tDxf4VycPU9-cokayp2M0I_wkYeBJbHG",
               "gateway":"mx_banco_scotiabank_h2h_external",
               "price_change_amount":"0.0000",
               "product_id":"ARGOSPID8",
               "status":"INITIALIZED",
               "type":"recurring"
            }
         ],
         "payment_instrument":{
            "type":"account",
            "card":null,
            "transfer":null,
            "cash":null,
            "wallet":null,
            "account":{
               "account":"044180001019143859",
               "bank_id":"044",
               "bank_account_type":"40",
               "token":null,
               "status":"temporary_failed"
            }
         },
         "wallet_movements":[]
      }
   ]
}

El campo type en payment_instrument indica el método de pago utilizado para la transacción. La información del método de pago se encontrará en el campo con nombre igual al valor de type en payment_instrument. A continuación se describen las estructuras de los distintos métodos de pagos:

🇲🇽transaction.bulk_failed

Información sobre pagos por lotes fallidos.

{
   "id":"wheve_2eHNGFQFTb2v_FGiz9UXra7K1PTJUzHW",
   "event_type":"transaction.bulk_failed",
   "events":[
      {
         "transaction":{
            "id":"trs_KLOgKsJguzpXuXnNRhoukv9fEeg7WO8x",
            "type":"PAYMENT",
            "amount":"22.0000",
            "currency":"MXN",
            "transaction_date":"2024-10-10 15:16:08.656533",
            "status":"FAILED",
            "transaction_metadata":{
               
            },
            "response_code":"UETOK9999",
            "voucher":null,
            "id_checkout_session":null
         },
         "customer":{
            "id":"cus_Sd49f8yuB-pz8XmAL810TjxnOMei-aMi",
            "external_id":"PEPJ000310MASRRNA9",
            "email":null,
            "government_id":"PEPJ000310MASRRNA9",
            "name":"Tomas Cantergiani",
            "phone_number":null
         },
         "payment_intents":[
            {
               "id":"pi_d50K5mWK7gYuLbF4Jz9mNozQ8XoDb7W8",
               "amount":"22.0000",
               "currency":"MXN",
               "id_invoice":"in_hLGdLfnABuqRIziQEm6DueD32-w5cYJB",
               "id_subscription":"sub_WUOnn14D_XAQHNcj-iWRI9mGCHzTMMC4",
               "invoice_external_id":"ARGOSPID10-2024-10-05",
               "id_account":"acc_tDxf4VycPU9-cokayp2M0I_wkYeBJbHG",
               "gateway":"mx_banco_scotiabank_h2h_external",
               "price_change_amount":"0.0000",
               "product_id":"ARGOSPID10",
               "status":"INITIALIZED",
               "type":"recurring",
               "is_partial": false
            }
         ],
         "payment_instrument":{
            "type":"account",
            "card":null,
            "transfer":null,
            "cash":null,
            "wallet":null,
            "account":{
               "account":null,
               "bank_id":"40044",
               "bank_account_type":"03",
               "token":"gcd_pA7oYJW8kXs_",
               "status":"temporary_failed"
            }
         },
         "wallet_movements":[...]
      }
   ]
}

El campo type en payment_instrument indica el método de pago utilizado para la transacción. La información del método de pago se encontrará en el campo con nombre igual al valor de type en payment_instrument. A continuación se describen las estructuras de los distintos métodos de pagos:

🇨🇱 Ejemplos Chile

Transaction con instrumento de pago de tipo Card

"payment_instrument": {
  "type": "card",
  "card": {
    "bin": "424242",
    "card_type": "credit",
    "card_brand": "visa",
    "country": "Chile",
    "exp_month": null,
    "exp_year": null,
    "external_id": null,
    "card_holder": "Felipe Tapia",
    "issuer": "cl_banco_santander",
    "installments_number": 1,
    "last_digits": "1234",
    "status": "chargeable",
    "token": null,
    "three_d_secure": null
  },
  "transfer": null,
  "cash": null,
  "wallet": null
}

Campos específicos

CampotipoDescripción
binstringPrimeros 6 números de la tarjeta
card_typestringIndica si es crédito (credit), débito (debit) o prepago (prepaid)
card_brandstringIndica la marca de la tarjeta: Visa, Mastercard o Amex son los soportados actualmente
countrystringPaís de emisión de la tarjeta. Si es distinto al país de la organización la transacción se considerará con tarjeta internacional.
exp_monthnullInformación sensible de la tarjeta, siempre vendrá vacía
exp_yearnullInformación sensible de la tarjeta, siempre vendrá vacía
card_holderstringNombre que ingresa el tarjetahabiente al momento de la compra
issuerstringNombre del emisor de la tarjeta
installments_numberintNúmero de cuotas
last_digitsstringÚltimos 4 dígitos de la tarjeta ingresada para la transacción. Sirve de identificador para el usuario final

Transaction con instrumento de pago de tipo Transfer

"payment_instrument": {
  "type": "transfer",
  "card": null,
  "transfer": {
    "country": "Chile",
    "institution_id": "cl_banco_santander",
    "account_type": "sight_account",
    "account_number": "1234567654",
    "payer_government_id": "183932365"
  },
 "cash": null,
  "wallet": null
}

campos específicos

CampotipoDescripción
countrystringPaís del banco de la cuenta que se hace transferencia
institution_idstringIdentificador del banco de la cuenta que se hace transferencia
account_typestringIndica el tipo de cuenta: corriente (checking_account), vista (sight_account) y rut (rut_account)
account_numberstringNúmero de cuenta que hace la transferencia
payer_government_idstringRut de la persona que hace la transferencia

Transaction con instrumento de pago de tipo PAC

"payment_instrument": {
  "type": "pac_management",
  "card": null,
  "transfer": null,
  "cash": null,
  "pac_management": {
    "country": "Chile",
    "mandate_id": "OI288287",
    "institution_id": "cl_banco_de_chile",
    "payer_name": "Sofia Gallardo",
    "payer_government_id": "135551236",
    "sbif": "001"
}

campos específicos

CampotipoDescripción
countrystringPaís del banco de la cuenta que se hace transferencia
mandate_idstringIdentificador del Mandato, lo que sirve para cobrar directamente en la nómina del banco.
institution_idstringIdentificador del banco de la cuenta que se hace transferencia
account_typestringIndica el tipo de cuenta: corriente (checking_account), vista (sight_account) y rut (rut_account)
payer_government_idstringRut de la persona que hace la transferencia

🇲🇽 Ejemplos México

Transaction con instrumento de pago de tipo Card

"payment_instrument": {
  "type": "card",
  "card": {
    "bin": "424242",
    "card_type": "credit",
    "card_brand": "visa",
    "country": "Mexico",
    "exp_month": null,
    "exp_year": null,
    "external_id": null,
    "card_holder": "Claudio Arenas",
    "issuer": "banco_santander",
    "installments_number": 1,
    "last_digits": "4242",
    "status": "chargeable",
    "token": null,
    "three_d_secure": null
  },
  "transfer": null,
  "cash": null,
  "wallet": null
}

Campos específicos

CampotipoDescripción
binstringPrimeros 6 números de la tarjeta
card_typestringIndica si es crédito (credit), débito (debit) o prepago (prepaid)
card_brandstringIndica la marca de la tarjeta: Visa, Mastercard, Amex, etc.
countrystringPaís de emisión de la tarjeta. Si es distinto al país de la organización la transacción se considerará con tarjeta internacional.
exp_monthnullInformación sensible de la tarjeta, siempre vendrá vacía
exp_yearnullInformación sensible de la tarjeta, siempre vendrá vacía
card_holderstringNombre que ingresa el tarjetahabiente al momento de la compra
issuerstringNombre del emisor de la tarjeta
installments_numberintNúmero de cuotas
last_digitsstringÚltimos 4 dígitos de la tarjeta ingresada para la transacción. Sirve de identificador para el usuario final

Transaction con instrumento de pago de tipo Transfer

"payment_instrument": {
  "type": "transfer",
  "card": null,
  "transfer": {
    "beneficiary_clabe": "646000000000000001",
    "payer_name": "Claudio Arenas",
    "payer_clabe": "646000000000000023",
    "tracking_id": "dj8329djf8",
    "transaction_date": "2024-04-30 19:01:41.733489"
  },
  "cash": null,
  "wallet": null
}

campos específicos

CampotipoDescripción
beneficiary_clabestringCuenta CLABE que recibe de la transferencia
payer_namestringNombre del pagador
payer_clabestringCuenta CLABE que emite la transferencia
tracking_idstringIdentificador que permite hacer un tracking correcto
transaction_datestringFecha y hora de la transacción en zona horaria UTC

Transaction con instrumento de pago de tipo Cash

"payment_instrument": {
  "type": "cash",
  "card": null,
  "transfer": null,
  "cash": {
    "auth_code": null,
    "barcode_url": "https://www.barcode.com/dasuhdiau",
    "expiration_date": null,
    "reference": "d0duas0",
    "store_name": null,
    "is_recurrent": true
  },
  "wallet": null
}

Transaction con instrumento de pago de tipo Wallet

"payment_instrument": {
  "type": "cash",
  "card": null,
  "transfer": null,
  "cash": null,
  "wallet": {
    "company": "Paypal"
  }
}

🇧🇷 Ejemplos Brazil

Transaction con instrumento de pago tipo Pix

"payment_instrument":{
  "type":"pix",
  "pix":{
    "tax_id":"00326432094",
    "end_to_end_id":"E9040088820251206223851356863430",
    "bank_name": null,
    "bank_ispb": null,
    "internal_bank_id": null,
    "redirect_url": null,
    "total_installments": null,
    "provider_request_id": null,
    "error_message": null,
    "error_code": null,
    "issuer": null,
    "number": null,
    "account_type": null,
  },
  "boleto": null,
  "card": null
},

Campos específicos

CampotipoDescripción
tax_idstringId de la transacción
end_to_end_idstringId interno de pix
bank_namestringNombre del banco
bank_ispbstringISPB del banco
internal_bank_idstringId interno del banco
redirect_urlstringURL de redirección post pago
total_installmentsintCantidad de pagos
provider_request_idintId del proveedor
error_messagestringMensaje de error, si existe
error_codeintCódigo de error, si existe
issuerstringEmisor
numberintNúmero de cuenta del emisor
account_typestringTipo de cuenta del emisor

Transaction con instrumento de pago tipo Boleto

"payment_instrument":{
  "type":"boleto",
  "pix": null,
  "boleto":{
    "expiration_date":"2025-12-10 00:00:00",
    "validity_date":"2026-03-20 00:00:00",
    "barcode_url":"https://boleto-barcode.storage.googleapis.com/[REDACTED].png",
    "pdf_url":"https://storage.cloud.google.com/boleto-pdf/[REDACTED].pdf",
    "barcode":"32998129100000435520001090004444256178026540",
    "typeable_line_number":"32990001039000444425461780265403812910000043552"
  },
  "card": null
},

Campos específicos

CampotipoDescripción
expiration_datestringPrimeros 6 números de la tarjeta
validity_datestringIndica si es crédito (credit), débito (debit) o prepago (prepaid)
barcode_urlstringUrl de la imagen de código de barras
pdf_urlstringPDF del boleto
barcodestringCódigo de barra
typeable_line_numberstringCódigo de barra

Transaction con instrumento de pago tipo Card

"payment_instrument":{
  "type":"card",
  "card":{
    "bin":"485464",
    "card_type":"credit",
    "card_brand":"VISA",
    "country":"Brazil",
    "exp_month":null,
    "exp_year":null,
    "external_id":null,
    "card_holder":"JUAN A GONZALEZ D",
    "issuer":"br_",
    "installments_number":1,
    "last_digits":"1234",
    "status":null,
    "token":null,
    "three_d_secure":false
  },
  "pix":null,
  "boleto":null
},

Campos específicos

CampotipoDescripción
binstringPrimeros 6 números de la tarjeta
card_typestringIndica si es crédito (credit), débito (debit) o prepago (prepaid)
card_brandstringIndica la marca de la tarjeta: Visa, Mastercard o Amex son los soportados actualmente
countrystringPaís de emisión de la tarjeta. Si es distinto al país de la organización la transacción se considerará con tarjeta internacional.
exp_monthnullInformación sensible de la tarjeta, siempre vendrá vacía
exp_yearnullInformación sensible de la tarjeta, siempre vendrá vacía
card_holderstringNombre que ingresa el tarjetahabiente al momento de la compra
issuerstringNombre del emisor de la tarjeta
installments_numberintNúmero de cuotas
last_digitsstringÚltimos 4 dígitos de la tarjeta ingresada para la transacción. Sirve de identificador para el usuario final