Webhook Events

i-payout webhook events are specific triggers related to financial activities and transactions that notify subscribed systems or users in real-time when these activities occur. These events help automate workflows, ensure timely updates, and maintain synchronization across different financial systems and applications.

Events	Description
CUSTOMER.CREATED	Refer to events or notifications generated when a new customer account or profile is created.
CUSTOMER.UPDATED	Refer to events or notifications generated when there are changes or updates made to a customer's profile or record.
CUSTOMER.STATUS.UPDATED	Refers to an event or notification that occurs when the status of a customer changes.
CUSTOMER.BANK.CREATED	Refers to an event or notification that occurs when a customer's bank account is created or added within a system or application
CUSTOMER.BANK.UPDATED	Refers to an event or notification that occurs when there are changes or updates made to a customer's bank account information within a system or application.
PAYMENT.CREATED	Refers to an event or notification that occurs when a new payment transaction is initiated or created.
PAYMENT.STATUS.UPDATED	Refers to an event or notification that occurs when there is a change in the status of a payment transaction.
TRANSFER.CREATED	Refers to an event or notification that occurs when a new transfer of funds is initiated. Find the possible transfer statuses on the Transfer Status reference page.
TRANSFER.STATUS.UPDATED	Refers to an event or notification that occurs when there is a change in the status of a transfer transaction. Find the possible transfer statuses on the Transfer Status reference page.
CUSTOMER.SUBSCRIPTION.CREATED	Refers to an event or notification that occurs when a new subscription is created for a customer.
CUSTOMER.SUBSCRIPTION.STATUS.UPDATED	Refers to an event or notification that occurs when there is a change in the status of a customer's subscription.
CUSTOMER.PREPAIDCARD.ORDERED	Refers to an event or notification that occurs when a customer orders or requests a prepaid card.
CUSTOMER.PREPAIDCARD.REPLACED	Refers to an event or notification that occurs when a customer requests a replacement for an existing prepaid card.
PAYOUT.BATCH.APPROVED	Refers to an event or notification that occurs when a batch of payouts has been approved for processing.

Examples

Here, you will find examples of the data structures of different events.

CUSTOMER.CREATED

{
  "Data": {
    "CustomerToken": "91db0fa0-7838-4f0e-8c3a-cf7279a7e6b8",
    "Username": "mitesh115",
    "EmailAddress": "[email protected]",
    "FirstName": "Mitesh",
    "LastName": "Test",
    "CompanyName": "I-Payout",
    "PhoneNumber": "9547851236",
    "CellPhoneNumber": "9547851236",
    "Address": "540 Nw 104th Street",
    "Address2": "",
    "State": "FL",
    "City": "Fort Lauderdale",
    "ZipCode": "33301",
    "Country": "US",
    "DateOfBirth": "1994-10-24T00:10:00",
    "PreferredLanguage": "EN",
    "IsSuspended": false,
    "IsInfoVerified": false,
    "IsClosed": false,
    "CreatedDate": "2024-06-10T09:28:21.437"
  },
  "EventName": "CUSTOMER.CREATED",
  "Identifier": "2de83a4d-2dee-42cf-b06f-f11554e2fcc4",
  "DatetimeUtc": "2024-06-10T13:28:39.8444803Z"
}

CUSTOMER.UPDATED

{
  "Data": {
    "CustomerToken": "91db0fa0-7838-4f0e-8c3a-cf7279a7e6b8",
    "Username": "mitesh115",
    "EmailAddress": "[email protected]",
    "FirstName": "Mitesh",
    "LastName": "Test",
    "CompanyName": "I-Payout",
    "PhoneNumber": "9547851236",
    "CellPhoneNumber": "9547851236",
    "Address": "540 Nw 104th Street",
    "Address2": "",
    "State": "FL",
    "City": "Fort Lauderdale",
    "ZipCode": "33301",
    "Country": "US",
    "DateOfBirth": "1994-10-24T00:10:00",
    "PreferredLanguage": "EN",
    "IsSuspended": false,
    "IsInfoVerified": false,
    "IsClosed": false,
    "CreatedDate": "2024-06-10T09:28:21.437"
  },
  "EventName": "CUSTOMER.UPDATED",
  "Identifier": "2de83a4d-2dee-42cf-b06f-f11554e2fcc4",
  "DatetimeUtc": "2024-06-10T13:28:39.8444803Z"
}

TRANSFER.CREATED

{
  "Data": {
    "merchantTransactionID": "string",
    "beneficiaryToken": "string",
    "destinationTypeID": 0,
    "destinationType": "string",
    "sourceAmount": 0,
    "sourceCurrency": "string",
    "destinationAmount": 0,
    "destinationCurrency": "string",
    "statusID": 0,
    "status": "string",
    "subStatusID": 0,
    "subStatus": "string",
    "responseMessage": "string",
    "responseErrorCode": "string",
    "createdDateUTC": "2024-06-12T18:37:07.013Z",
    "updatedDateUTC": "2024-06-12T18:37:07.013Z",
    "expiryDateUTC": "2024-06-30T00:00:00Z",
    "comments": "string",
    "token": "string",
    "fxRate": 0,
    "fxQuote": {
      "quoteIdentifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sourceCurrencyCode": "string",
      "destinationCurrencyCode": "string",
      "sourceAmount": 0,
      "destinationAmount": 0,
      "fxRate": 0,
      "dateAddedUtc": "2024-06-12T18:37:07.013Z",
      "dateExpiresUtc": "2024-06-12T18:37:07.013Z"
    },
    "totalCustomerFee": 0,
    "totalMerchantFee": 0,
    "destinationToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountIdentifier1": "string",
    "accountIdentifier2": "string",
    "accountIdentifier3": "string",
    "accountIdentifier4": "string",
    "senderToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "purposeOfPaymentID": 0,
    "isTransferSubmittedToBank": true,
    "paymentDescription": "string",
    "withdrawTransactionLogID": 0,
    "transactionID": 0
  },
  "EventName": "TRANSFER.CREATED",
  "Identifier": "01f024c8-3bfe-403f-a306-4d9062403759",
  "DatetimeUtc": "2024-06-12T18:37:28.4578723Z"
}

TRANSFER.STATUS.UPDATED

{
  "Data": {
    "merchantTransactionID": "string",
    "beneficiaryToken": "string",
    "destinationTypeID": 0,
    "destinationType": "string",
    "sourceAmount": 0,
    "sourceCurrency": "string",
    "destinationAmount": 0,
    "destinationCurrency": "string",
    "statusID": 0,
    "status": "string",
    "subStatusID": 0,
    "subStatus": "string",
    "responseMessage": "string",
    "responseErrorCode": "string",
    "createdDateUTC": "2024-06-12T18:37:07.013Z",
    "updatedDateUTC": "2024-06-12T18:37:28.457Z",
    "expiryDateUTC": "2024-06-30T00:00:00Z",
    "comments": "string",
    "token": "string",
    "fxRate": 0,
    "fxQuote": {
      "quoteIdentifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sourceCurrencyCode": "string",
      "destinationCurrencyCode": "string",
      "sourceAmount": 0,
      "destinationAmount": 0,
      "fxRate": 0,
      "dateAddedUtc": "2024-06-12T18:37:07.013Z",
      "dateExpiresUtc": "2024-06-12T18:37:07.013Z"
    },
    "totalCustomerFee": 0,
    "totalMerchantFee": 0,
    "destinationToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountIdentifier1": "string",
    "accountIdentifier2": "string",
    "accountIdentifier3": "string",
    "accountIdentifier4": "string",
    "senderToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "purposeOfPaymentID": 0,
    "isTransferSubmittedToBank": true,
    "paymentDescription": "string",
    "withdrawTransactionLogID": 0,
    "transactionID": 0
  },
  "EventName": "TRANSFER.STATUS.UPDATED",
  "Identifier": "01f024c8-3bfe-403f-a306-4d9062403759",
  "DatetimeUtc": "2024-06-12T18:37:28.4578723Z"
}

What's next?

Now that you know the basics about webhooks, follow the How to Set Up Webhooks guide to start using them.