Using a webhook

Important: currently Coini is registering the URL of your webhook manually in development and production mode.

Please contact and provide us sending an email to [e-mail] with your webhook and check it out in our development environment.

How does it work?

Once you provide the webhook url to Coini team you can try it out in sandbox or production mode.

First

You need to create a new order using this endpoint and then you need to wait 3 minutes to receive the confirmation.

Second

After 3 minutos Coini will run and POST request pointing to the webhook URL with the following data:

Request

POST {{WEBHOOK_URL}}

Success case:

{
  "metadata": {
    "description": "Curso de prueba",
    "order": "order-001",
    "hash": "curso-001"
  },
  "item": {
    "amount": 400,
    "currency": "USD"
  },
  "transaction": {
    "status": "success",
    "orderCode": "8981981989189",
    "amount": 400,
    "timestamp": "2022-09-06T17:15:34.243Z",
    "wallet": "0xCC890d970C47dF60FCbcfDE258202Ec7e2B2a019",
    "txhash": "0x77d64c362710afe68sdzdsasadfdsadsa9272",
    "currency": "BUSD",
    "address": "0x77d64c362710af26fe683a019e20745393783d"
  }
}

Failed case:

{
  "metadata": {
    "description": "Curso de prueba",
    "order": "order-001",
    "hash": "curso-001"
  },
  "item": {
    "amount": 400,
    "currency": "USD"
  },
  "transaction": {
    "status": "failed",
    "orderCode": "8981981989189",
    "amount": 400
  }
}

Important to know:

• metadata is the data provided when you created an order.

• item is amount and currency sent when you created an order.

• transaction this object has all the details of the transaction and the most important data is the status field.

• status this field could be have two values success or failed and you can use that to confirm the order in your system.