Guides

Webhook Acknowledgement

Suggest Edits

Webhook Acknowledgement

When Patricia sends a webhook event to your webhook URL, it expects a 200 OK response which Patricia considers and acknowledgement from your application. If your endpoint returns a non-200 response or no response within a short period of time, Patricia will retry sending the webhook event again every hour for the next 72 hours.

Event Type

  • crypto.payment.seen - for transactions that have been detected on the blockchain
  • crypto.payment.success - for transactions that have been deemed successful after payment
  • crypto.payment.failed - for transactions that were declined due to reasons such as overpayment, underpayment or abandonment
{
  "event": "crypto.payment.seen",
  "data": {
    "domain": "live",
    "reference": "PAY_q9443220s",
    "authorization_code": "kx0cAWwY",
    "status": "processing",
    "remark": "-",
    "business": {
      "name": "Big Men Enterprises",
      "code": "919871",
      "domain": "live"
    },
    "customer": {
      "full_name": "Ramsey Nouah",
      "email": "[email protected]",
      "code": "CUS_EUV6p9HL8T75"
    },
    "transaction": {
      "charged_amount": "560.00",
      "amount_paid": null,
      "currency": "USD",
      "charged_amount_in_crypto": "0.01281688",
      "amount_paid_in_crypto": null,
      "payment_method": {
        "code": "crypto_bitcoin",
        "currency": "BTC"
      },
      "crypto_transaction_hash": "stagthe01",
      "crypto_confirmations": 1
    },
    "metadata": null,
    "created_at": "2022-01-13T11:22:06.000000Z"
  }
}

{
  "event": "crypto.payment.success",
  "data": {
    "domain": "live",
    "reference": "PAY_q9443220s",
    "authorization_code": "kx0cAWwY",
    "status": "processing",
    "remark": "-",
    "business": {
      "name": "Big Men Enterprises",
      "code": "919871",
      "domain": "live"
    },
    "customer": {
      "full_name": "Ramsey Nouah",
      "email": "[email protected]",
      "code": "CUS_EUV6p9HL8T75"
    },
    "transaction": {
      "charged_amount": "560.00",
      "amount_paid": null,
      "currency": "USD",
      "charged_amount_in_crypto": "0.01281688",
      "amount_paid_in_crypto": null,
      "payment_method": {
        "code": "crypto_bitcoin",
        "currency": "BTC"
      },
      "crypto_transaction_hash": "stagthe01",
      "crypto_confirmations": 1
    },
    "metadata": null,
    "created_at": "2022-01-13T11:22:06.000000Z"
  }
}

{
  "event": "crypto.payment.failed",
  "data": {
    "domain": "live",
    "reference": "PAY_q9443220s",
    "authorization_code": "kx0cAWwY",
    "status": "processing",
    "remark": "-",
    "business": {
      "name": "Big Men Enterprises",
      "code": "919871",
      "domain": "live"
    },
    "customer": {
      "full_name": "Ramsey Nouah",
      "email": "[email protected]",
      "code": "CUS_EUV6p9HL8T75"
    },
    "transaction": {
      "charged_amount": "560.00",
      "amount_paid": null,
      "currency": "USD",
      "charged_amount_in_crypto": "0.01281688",
      "amount_paid_in_crypto": null,
      "payment_method": {
        "code": "crypto_bitcoin",
        "currency": "BTC"
      },
      "crypto_transaction_hash": "stagthe01",
      "crypto_confirmations": 1
    },
    "metadata": null,
    "created_at": "2022-01-13T11:22:06.000000Z"
  }
}

🚧

Webhooks

Please note that Patricia sends two webhooks for every transaction.

  1. The first webhook has a status of processing. This indicates that the transaction has entered the Blockchain.
  2. The second webhook sent from Patricia has a status of successful, declined, failed. The declined status indicates that the transaction was either underpaid or overpaid or something else happened. It's important to release value only when you get a successful status.

Updated almost 4 years ago