API Reference

Webhook requests

When making a request, you will receive different information according to the events you are subscribed. This information will be defined here.

accepted_transaction

{
 "id": 16408,
  "event": "accepted_transaction",
  "installments": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "amount": 19999,
      "commission": 0.024,
      "due_date": "2024-01-12",
      "external_id": null,
      "name": null,
      "payable": {
        "id": "11111111-1111-1111-1111-111111111111",
        "buyer": {
          "id": "11111111-1111-1111-1111-111111111111",
          "email": "[email protected]",
          "external_id": null,
          "name": "Example Buyer"
        },
        "external_id": null,
        "payable_type": "subscription_buyer",
        "status": "active"
      },
      "payment_date": "2024-01-12T14:00:34",
      "status": "paid"
    }
  ],
  "payment_method": "oneclick",
  "status": "accepted"
}

rejected_transaction

{
  "id": 16296,
  "event": "rejected_transaction",
  "installments": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "amount": 57000,
      "commission": 0.028,
      "due_date": "2024-01-12",
      "external_id": null,
      "name": null,
      "payable": {
        "id": "11111111-1111-1111-1111-111111111111",
        "buyer": {
          "id": "11111111-1111-1111-1111-111111111111",
          "email": "[email protected]",
          "external_id": null,
          "name": "Example Buyer"
        },
        "external_id": null,
        "payable_type": "subscription_buyer",
        "status": "active"
      },
      "status": "pending"
    }
  ],
  "payment_method": null,
  "reason": "Excede monto máximo",
  "status": "rejected"
}

subscription_buyer_in_debt

{
  "id": "11111111-1111-1111-1111-111111111111",
  "buyer": {
    "id": "11111111-1111-1111-1111-111111111111",
    "email": "[email protected]",
    "external_id": null,
    "name": "Example Buyer"
  },
  "event": "subscription_buyer_in_debt",
  "expired_installments": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "amount": 32995,
      "commission": 0.028,
      "status": "expired"
    }
  ],
  "external_id": null,
  "status": "indebt",
  "subscription": {
    "id": "11111111-1111-1111-1111-111111111111",
    "external_id": null,
    "name": "Example Subscription",
    "status": "active"
  }
}

payment_plan_in_debt

{
  "id": "11111111-1111-1111-1111-111111111111",
  "buyer": {
    "id": "11111111-1111-1111-1111-111111111111",
    "email": "[email protected]",
    "external_id": null,
    "name": "Example Buyer"
  },
  "description": "Proyecto Santa Elena",
  "event": "payment_plan_in_debt",
  "expired_installments": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "amount": 120000,
      "due_date": "2024-06-07",
      "external_id": "1",
      "name": "cuota 1",
      "status": "expired",
      "total_commission": null
    }
  ],
  "external_id": "pp002",
  "image": null,
  "name": "Departamento 65A",
  "status": "in_debt"
}

transfer_to_seller

{
  "id": "11111111-1111-1111-1111-111111111111",
  "amount": 19190,
  "bank_information": {
    "account_number": 11111111,
    "account_type": "Cuenta Corriente",
    "bank_name": "Banco Estado",
    "email": "[email protected]",
    "name": "Example",
    "rut": "11.111.111-1"
  },
  "event": "transfer_to_seller",
  "installments": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "amount": 10000,
      "commission": 0.0143,
      "payment_date": "2024-01-03T13:00:11",
      "status": "paid",
      "transfered_to_client": 9595
    },
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "amount": 10000,
      "commission": 0.0143,
      "payment_date": "2024-01-03T13:00:22",
      "status": "paid",
      "transfered_to_client": 9595
    }
	],
  "status": "paid"
}

payment_plan_ap_enrollment

{
  "id": "11111111-1111-1111-1111-111111111111",
  "automatic_payment_enrolled": "PAT",
  "buyer": {
    "id": "11111111-1111-1111-1111-111111111111",
    "email": "[email protected]",
    "external_id": null,
    "name": "Example Buyer"
  },
  "description": "Proyecto Santa Elena",
  "event": "payment_plan_ap_enrollment",
  "external_id": "pp002",
  "name": "Departamento 65A",
  "status": "up_to_date"
}

subscription_buyer_ap_enrollment

{
  "id": "11111111-1111-1111-1111-111111111111",
  "automatic_payment_enrolled": "PAT",
  "buyer": {
    "id": "11111111-1111-1111-1111-111111111111",
    "email": "[email protected]",
    "external_id": null,
    "name": "Example Buyer"
  },
  "external_id": null,
  "event": "subscription_buyer_ap_enrollment",
  "status": "active",
  "subscription": {
    "id": "11111111-1111-1111-1111-111111111111",
    "external_id": null,
    "name": "plan de prueba",
    "status": "active"
  }
}