Webhook events

Webhook events fired on various Issuing events

Virtual Account Created (issuing.virtual_account_created)

This event is sent when a virtual account gets created successfully.

{
    "event": "issuing.virtual_account_created",
    "data": {
      "id": "61b34fe42b64b9700b63b71b",
      "status": "active",
      "account_name": "IFEOLUWA OLAYINKA",
      "account_number": "1100037055",
      "bank_name": "Tangerine Money",
      "bank_code": "100338",
      "live": false
    }
  }

Transfer received (issuing.transfer_received)

This webhook event gets sent when a transaction is been received.

{
    "event": "issuing.transfer_received",
    "data": {
      "id": "61b1c645c27eb862e7ad5cd3",
      "amount": 10000,
      "balance": 10000,
      "narration": "App  To TANGERINE MONEY KING AHMED",
      "currency": "NGN",
      "account": "61b1c54887902462b5f2890d",
      "type": "credit",
      "date": "2021-12-09T09:02:31.989Z",
      "live": true,
      "fee": 0,
      "source": {
        "name": "OLANIPEKUN IFEOLUWA OLAYINKA",
        "account_number": "7470605015"
      }
    }
  }

Virtual Card Created for USD (issuing.virtual_card_created)

This webhook event is sent when a USD virtual card gets created.

{
    "event": "issuing.virtual_card_created",
    "data": {
      "id": "61b354e233b1ba7122226907",
      "status": "active",
      "expiry_year": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "expiry_month": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "disposable": false,
      "card_masked": "536898**9887",
      "card_number": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "last4": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "cvv": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "live": false
    }
}

Virtual Card Created for NGN (issuing.virtual_card_created)

This webhook event is sent when a NGN virtual card gets created.

{
    "event": "issuing.virtual_card_created",
    "data": {
      "id": "61b354e233b1ba7122226907",
      "status": "active",
      "expiry_year": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "expiry_month": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "disposable": false,
      "card_masked": "536898**9887",
      "card_number": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "currency": "NGN",
      "last4": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "cvv": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "live": false,
      "pin": "a545a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6a90bc",
    }
}

Card Transaction USD (issuing.card_transaction)

This webhook event is sent when a USD card transaction gets initiated.

{
    "event": "issuing.card_transaction",
    "data": {
      "id": "61b355d35fe5d3715e9a4196",
      "amount": 10000,
      "balance": 10000,
      "type": "credit",
      "currency": "USD",
      "card": "61b354e233b1ba7122226907",
      "date": "2021-12-10T13:27:41.288Z",
      "narration": "20200823t06:13:45/idigic internet nor",
      "live": false
    }
  }
}

Card Transaction NGN (issuing.card_transaction)

This webhook event is sent when a NGN card transaction gets initiated.

{
    "event": "issuing.card_transaction",
    "data": {
      "id": "61b355d35fe5d3715e9a4196",
      "amount": 10000,
      "balance": 10000,
      "type": "credit",
      "currency": "NGN",
      "card": "61b354e233b1ba7122226907",
      "date": "2021-12-10T13:27:41.288Z",
      "narration": "20200823t06:13:45/idigic internet nor",
      "live": false
    }
  }
}

Card 3d secure OTP (issuing.card_3d_secure_otp)

This webhook event is sent when your users want to authorise an online payment. When received you can send a push notification via Email, SMS or Voice call via 3rd party services so they could complete payment.

{
    "event": "issuing.card_3d_secure_otp",
    "data": {
      "card": "61b1c51687902462b5f28900",
      "account_holder": "61b1c51687902462b5212900",    
      "otp": "582550",
      "live": true
    }
  }

Virtual Account Upgraded (issuing.virtual_account_upgraded)

When a virtual account gets upgraded this webhook event is sent.

{
    "event": "issuing.virtual_account_upgraded",
    "data": {
      "id": "61a8f60ecfb84076108ebd53",
      "kyc_level": "2",
      "live": false
    }
  }

Transfer Successful (issuing.transfer_successful)

{
  "event": "issuing.transfer_successful",
  "data": {
    "amount": 10000,
    "balance": 60000,
    "narration": "test",
    "currency": "NGN",
    "account": "61c4797874f68e012cd027cd",
    "type": "debit",
    "date": "2021-12-23T13:32:38.030Z",
    "fee": 0,
    "beneficiary": {
      "name": "OLANIPEKUN OLAYINKA",
      "account_number": "0029873434",
      "bank_code": "044"
    },
    "meta": {
      "cus": "9023023 OLAYINKA",
      "charge_transfer_fee": true,
      "transaction_id": "05840643605"
    },
    "message": "Approved by Financial Institution",
    "live": true,
    "id": "61c47a7a006a37404b9fcee4"
  }
}

Transfer Failed (issuing.transfer_failed)

{
  "event": "issuing.transfer_failed",
  "data": {
    "amount": 300000,
    "balance": 30000,
    "narration": "chizoba",
    "currency": "NGN",
    "account": "61c4797874f68e012cd027cd",
    "type": "debit",
    "date": "2021-12-23T13:36:18.433Z",
    "fee": 0,
    "beneficiary": {
      "name": "OLANIPEKUN OLAYINKA",
      "account_number": "0029873434",
      "bank_code": "044"
    },
    "message": "Insufficient Funds",
    "live": true,
    "id": "61c47b56006a37404b9fcf12"
  }
}

Physical Card Created (issuing.physical_card_created)

This webhook event gets sent after a requested physical card gets created. The time it takes for this event to get sent is approximately 4 days.

{
    "event": "issuing.physical_card_created",
    "data": {
      "id": "61b354e233b1ba7122226907",
      "status": "processing",
      "expiry_year": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "expiry_month": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "card_masked": "536898**9887",
      "last4": "e745a26ba5b8bbe94f51eecf1208c17c2f27476d7a1533a6dc1eb7dcaa6ad70c",
      "live": false
    }
  }

Physical Card Creation Failed (issuing.physical_card_failed)

Webhook event for a physical card that fails to get created.

{
    "event": "issuing.physical_card_failed",
    "data": {
      "account": "61fad6ec710f4b859876947e",
      "message": "address information not complete on account holder",
      "live": true,
      "id": ""
    }
 }

Physical Card Delivered (issuing.physical_card_delivered)

This event is sent when a Physical Card has been delivered to the provided delivery address.

{
    "event": "issuing.physical_card_delivered",
    "data": {
      "id": "6229b6cc64db2fe528377970",
      "status": "active",
      "delivery_address": {
        "city": "fct",
        "lga": "Bwari",
        "address_line1": "73b joshua olayinka street",
        "address_line2": null,
        "state": "FCT"
      },
      "live": true
    }
 }

Account Budget Set (issuing.account_budget_created)

Webhook event fired when fixed budged has been made on a virtual account.

{
    "event": "issuing.account_budget_created",
    "data": {
      "amount": 35000,
      "account": "61cb8b4535afa436478bcaf7",
      "live": false
    }
}

Account Budget Removed (issuing.account_budget_removed)

Webhook event sent when a budget amount has been lifted from a virtual account.

{
    "event": "issuing.account_budget_removed",
    "data": {
      "balance": 410000,
      "account": "61cb8b4535afa436478bcaf7",
      "live": false
    }
}

Account Budget Failed (issuing.account_budget_failed)

When setting a budgeted amount on a virtual account has failed, this webhook event is fired.

{
    "event": "issuing.account_budget_failed",
    "data": {
      "amount": 25000,
      "account": "61cb8b4535afa436478bcaf7",
      "live": false
    }
}

Virtual Account Freezed (issuing.virtual_account_freezed)

If address verification fails after an account gets upgraded to KYC level 3, the account gets frozen (sub-accounts are affected too)

{
    "event": "issuing.virtual_account_freezed",
  "data": {
    id: "62508269ecc7771fda022606",
    account_holder: "92508269ecc7771fda022606",
    sub_accounts: ["42508269ecc7771fda022601"],
    message:
    'Physical Address verification for this account has failed, please update address to unfreeze this account',
    live: true,
  }
}

Did this page help you?