Webhook Event Response

Below is a list of webhook event payloads that we currently have:

  • Customer Payload Event
  • Payment Method Payload Event
  • Payment Method Payload for PayTo Event
  • Invoice Status Payload Event
  • Invoice Batch Payload Event
  • Subscription Payload Event
  • Transaction Payload Event
  • Credit Note Payload Event
  • Dispute Payload Event
  • Partner Invoice Event

Customer Payload Event

{
  "requestId": "290b026d-bf51-46ed-953e-2ad6b6e21224",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "CUSTOMER_CREATE",
  "createdOn": "2022-04-01T01:18:17.474",
  "data": {
    "id": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "number": "EZY426438",
    "referenceCode": null,
    "firstName": "Daniel",
    "lastName": "Lawrence",
    "email": "[email protected]",
    "companyName": null,
    "mobilePhone": null,
    "homePhone": null,
    "gender": "male",
    "dateOfBirth": "1996-08-21",
    "createdOn": "2022-04-01T01:18:17.415",
    "address": {
      "address1": "217 sample road name",
      "address2": null,
      "postalCode": "90210",
      "state": "New South Wales",
      "countryCode": "AU",
      "city": "Testville"
    },
    "metadata": {
      "foo": "bar"
    }
  }
}
{
  "requestId": "16149b99-58db-45d6-add1-305e05facd55",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "CUSTOMER_UPDATE",
  "createdOn": "2022-04-01T01:22:05.008",
  "data": {
    "id": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "number": "EZY426438",
    "referenceCode": null,
    "firstName": "Daniel",
    "lastName": "Lawrence",
    "email": "[email protected]",
    "companyName": null,
    "mobilePhone": null,
    "homePhone": null,
    "gender": "male",
    "dateOfBirth": "1996-08-22",
    "createdOn": "2022-04-01T01:18:17.415",
    "address": {
      "address1": "218 sample road name",
      "address2": null,
      "postalCode": "90210",
      "state": "New South Wales",
      "countryCode": "AU",
      "city": "Testville"
    },
    "metadata": {
      "foo": "bar"
    }
  }
}

Payment Method Payload Event

{
  "requestId": "f6083cd9-ff55-486e-a77d-26feae340a8c",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "PAYMENT_METHOD_INVALID",
  "createdOn": "2022-04-01T01:28:07.858",
  "data": {
    "paymentMethodToken": "c3187954-3a32-4c3b-a579-a48c07489704",
    "customerId": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "type": "CARD",
    "bank": null,
    "payTo": null,
    "card": {
      "first6": "559639",
      "last4": "7872",
      "accountHolderName": "Daniel Lawrence",
      "type": "MASTERCARD",
      "expiryMonth": "12",
      "expiryYear": "25"
    },
    "invalidReason": {
      "code": "invalid_payment_method",
      "description": "Payment method details are invalid. Please use a different payment method."
    },
    "lastUsedOn": "2022-04-01T01:28:06.455",
    "replacedPaymentMethodData": null,
    "valid": false,
    "primary": true
  }
}
{
  "requestId": "fa4c1f1c-6b4b-4ba4-a0ab-f4fdf44e3d3b",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "PAYMENT_METHOD_REPLACED",
  "createdOn": "2022-04-01T01:57:54.459",
  "data": {
    "paymentMethodToken": "15baddd8-8cc0-43c6-a2f8-4ad1fc571b51",
    "customerId": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "type": "CARD",
    "bank": null,
    "card": {
      "first6": "411111",
      "last4": "1111",
      "accountHolderName": "Daniel Lawrence",
      "type": "VISA",
      "expiryMonth": "12",
      "expiryYear": "25"
    },
    "invalidReason": null,
    "lastUsedOn": null,
    "replacedPaymentMethodData": {
      "paymentMethodToken": "c3187954-3a32-4c3b-a579-a48c07489704",
      "customerId": "48cb97f6-d066-4f10-94e1-bda9026be33c",
      "type": "CARD",
      "bank": null,
      "card": {
        "first6": "559639",
        "last4": "7872",
        "accountHolderName": "Daniel Lawrence",
        "type": "MASTERCARD",
        "expiryMonth": "12",
        "expiryYear": "25"
      },
      "invalidReason": {
        "code": "invalid_payment_method",
        "description": "Payment method details are invalid. Please use a different payment method."
      },
      "lastUsedOn": "2022-04-01T01:28:06.455",
      "replacedPaymentMethodData": null,
      "valid": false,
      "primary": false
    },
    "valid": true,
    "primary": true
  }
}
{
  "requestId": "3e2dc8d5-5e9f-48ef-9f62-a1fc04761ffe",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "PAYMENT_METHOD_LINKED",
  "createdOn": "2022-04-01T01:26:30.448",
  "data": {
    "paymentMethodToken": "c3187954-3a32-4c3b-a579-a48c07489704",
    "customerId": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "type": "CARD",
    "bank": null,
    "card": {
      "first6": "559639",
      "last4": "7872",
      "accountHolderName": "Daniel Lawrence",
      "type": "MASTERCARD",
      "expiryMonth": "12",
      "expiryYear": "25"
    },
    "invalidReason": null,
    "lastUsedOn": null,
    "replacedPaymentMethodData": null,
    "valid": true,
    "primary": true
  }
}
{
  "requestId": "1d4d9bc2-29c9-45b5-9878-e65af4e55ba0",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "PAYMENT_METHOD_CHANGED",
  "createdOn": "2022-04-01T01:54:17.858",
  "data": {
    "paymentMethodToken": "15baddd8-8cc0-43c6-a2f8-4ad1fc571b51",
    "customerId": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "type": "CARD",
    "bank": null,
    "card": {
      "first6": "411111",
      "last4": "1111",
      "accountHolderName": "Daniel Lawrence",
      "type": "VISA",
      "expiryMonth": "12",
      "expiryYear": "25"
    },
    "invalidReason": null,
    "lastUsedOn": null,
    "replacedPaymentMethodData": null,
    "valid": true,
    "primary": true
  }
}

Payment Method Payload Event (PayTo)

{
  "requestId": "1f9f72c2-2619-4cfa-a7f8-2ce7cebe62af",
  "merchantId": "45ed5298-ba70-4e03-a2d3-88dcb28a4d44",
  "eventType": "PAYMENT_METHOD_VALID",
  "createdOn": "2022-06-06T01:28:07.858",
  "data": {
    "paymentMethodToken": "6f2afde5-7c6d-4107-ab59-1f0eafe10734",
    "customerId": "2bf5f8b9-72e9-4b43-9c0e-17926e02194d",
    "type": "PAYTO",
    "bank": null,
    "card": null,
    "payTo": {
      "accountHolderName": "AU Test User",
      "accountType": "BBAN",
      "bBanBSB": "123456",
      "bBanAccountNo": "123456789",
      "merchantId": "64fa03f5-e8ae-47c9-b495-22300950bf0b",
      "mandateTypeId": "64fa03f5-e8ae-47c9-b495-22300950bf0c",
      "mandateStatus": "ACTV",
      "mandateReason": "Activated.",
      "mandateId": "123456",
      "description": "Testing description",
      "frequency": "ADHO",
      "validityStartDate": "2022-07-25T06:55:09.559",
      "maximumPaymentAmount": 1000
    },
    "invalidReason": null,
    "lastUsedOn": null,
    "replacedPaymentMethodData": null,
    "valid": true,
    "primary": true
  }
}
{
  "requestId": "1f9f72c2-2619-4cfa-a7f8-2ce7cebe62af",
  "merchantId": "45ed5298-ba70-4e03-a2d3-88dcb28a4d44",
  "eventType": "PAYMENT_METHOD_INVALID",
  "createdOn": "2022-06-06T01:28:07.858",
  "data": {
    "paymentMethodToken": "1e518176-a0c1-4a17-80a9-1f3b2192a892",
    "customerId": "b12bb1d0-9684-44ea-931e-ea4ec18adfd3",
    "type": "PAYTO",
    "bank": null,
    "card": null,
    "payTo": {
      "accountHolderName": "AU Test User",
      "accountType": "BBAN",
      "bBanBSB": "802950",
      "bBanAccountNo": "11223344",
      "merchantId": "45ed5298-ba70-4e03-a2d3-88dcb28a4d44",
      "mandateTypeId": "f7ae9be2-dcfc-4c5c-bb93-410f9f52ffce",
      "mandateStatus": "CNCD",
      "mandateReason": "Cancelled.",
      "mandateId": "14af31591bcc19acbeda25bfd26d6dfa",
      "description": "Testing description",
      "frequency": "ADHO",
      "validityStartDate": "2022-07-25T06:55:09.559",
      "maximumPaymentAmount": 1000
    },
    "invalidReason": {
      "code": "mandate_cancelled",
      "description": "Cancelled."
    },
    "lastUsedOn": null,
    "replacedPaymentMethodData": null,
    "valid": false,
    "primary": true
  }
}
{
  "requestId": "1f9f72c2-2619-4cfa-a7f8-2ce7cebe62af",
  "merchantId": "45ed5298-ba70-4e03-a2d3-88dcb28a4d44",
  "eventType": "PAYMENT_METHOD_REPLACED",
  "createdOn": "2022-06-06T01:28:07.858",
  "data": {
    "paymentMethodToken": "36722e66-2821-4fde-9e7f-4628db95375c",
    "customerId": "37503e54-fead-481c-98b3-c071651ce4ba",
    "type": "PAYTO",
    "bank": null,
    "payTo": {
      "accountHolderName": "John Doe",
      "accountType": "BBAN",
      "bBanBSB": "809501",
      "bBanAccountNo": "111111111",
      "merchantId": "bfdaa558-0779-4df0-98a0-41280e9dd805",
      "mandateTypeId": "4840771e-0821-449a-ab8a-6d47880cc10b",
      "mandateStatus": "ACTV",
      "mandateReason": "Activated.",
      "mandateId": "639d1cb5dca94263b11adc7ac4a6856f",
      "description": "Sample description",
      "frequency": "ADHO",
      "validityStartDate": "2022-08-05T08:15:51.923",
      "maximumPaymentAmount": 100
    },
    "card": null,
    "lastUsedOn": null,
    "replacedPaymentMethodData": {
      "paymentMethodToken": "f35e0eb4-fdc9-4233-ac10-6ad88f25b718",
      "customerId": "37503e54-fead-481c-98b3-c071651ce4ba",
      "type": "PAYTO",
      "bank": null,
      "payTo": {
        "accountHolderName": "John Doe",
        "accountType": "BBAN",
        "bBanBSB": "809501",
        "bBanAccountNo": "111111111",
        "merchantId": "bfdaa558-0779-4df0-98a0-41280e9dd805",
        "mandateTypeId": "4840771e-0821-449a-ab8a-6d47880cc10b",
        "mandateStatus": "ACTV",
        "mandateReason": "Activated.",
        "mandateId": "d41bb34e3690498c9b3e248a600892bd",
        "description": "Sample description",
        "frequency": "ADHO",
        "validityStartDate": "2022-08-01T08:15:51.923",
        "maximumPaymentAmount": 200
      },
      "card": null,
      "lastUsedOn": null,
      "replacedPaymentMethodData": null,
      "valid": false,
      "primary": false
    },
    "valid": false,
    "primary": true
  }
}
{
  "requestId": "1f9f72c2-2619-4cfa-a7f8-2ce7cebe62af",
  "merchantId": "45ed5298-ba70-4e03-a2d3-88dcb28a4d44",
  "eventType": "PAYMENT_METHOD_LINKED",
  "createdOn": "2022-06-06T01:28:07.858",
  "data": {
    "paymentMethodToken": "7f049923-9560-423b-b039-c4e15a05213e",
    "customerId": "37503e54-fead-481c-98b3-c071651ce4ba",
    "type": "PAYTO",
    "bank": null,
    "payTo": {
      "accountHolderName": "John Doe",
      "accountType": "BBAN",
      "bBanBSB": "809501",
      "bBanAccountNo": "111111111",
      "merchantId": "bfdaa558-0779-4df0-98a0-41280e9dd805",
      "mandateTypeId": "4840771e-0821-449a-ab8a-6d47880cc10b",
      "mandateStatus": "CRTD",
      "mandateReason": "Created.",
      "mandateId": "efeedd8aa72b4578a2b452878ed57383",
      "description": "Sample description",
      "frequency": "ADHO",
      "validityStartDate": "2022-08-05T07:42:05.692",
      "maximumPaymentAmount": 100
    },
    "card": null,
    "invalidReason": {
      "code": "mandate_created",
      "description": "Mandate is created but not activated yet."
    },
    "lastUsedOn": null,
    "replacedPaymentMethodData": null,
    "valid": false,
    "primary": true
  }
}
{
  "requestId": "1f9f72c2-2619-4cfa-a7f8-2ce7cebe62af",
  "merchantId": "45ed5298-ba70-4e03-a2d3-88dcb28a4d44",
  "eventType": "PAYMENT_METHOD_CHANGED",
  "createdOn": "2022-06-06T01:28:07.858",
  "data": {
    "paymentMethodToken": "f35e0eb4-fdc9-4233-ac10-6ad88f25b718",
    "customerId": "37503e54-fead-481c-98b3-c071651ce4ba",
    "type": "PAYTO",
    "bank": null,
    "payTo": {
      "accountHolderName": "John Doe",
      "accountType": "BBAN",
      "bBanBSB": "809501",
      "bBanAccountNo": "111111111",
      "merchantId": "bfdaa558-0779-4df0-98a0-41280e9dd805",
      "mandateTypeId": "4840771e-0821-449a-ab8a-6d47880cc10b",
      "mandateStatus": "ACTV",
      "mandateReason": "Activated.",
      "mandateId": "d41bb34e3690498c9b3e248a600892bd",
      "description": "Sample description",
      "frequency": "ADHO",
      "validityStartDate": "2022-08-05T08:06:12.109",
      "maximumPaymentAmount": 100
    },
    "card": null,
    "lastUsedOn": null,
    "replacedPaymentMethodData": null,
    "valid": false,
    "primary": true
  }
}

Invoice Status Payload Event

{
  "requestId": "bb6b8e4c-715a-4caa-98c0-3b51710a40e8",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "INVOICE_CREATED",
  "createdOn": "2022-04-01T01:28:06.237",
  "data": {
    "id": "1690057a-16f3-46da-bf11-725c3a616085",
    "documentNumber": "IN0000000000067222",
    "date": "2022-04-01",
    "dueDate": "2022-04-01",
    "scheduledPaymentDate": null,
    "status": "PROCESSING",
    "memo": null,
    "items": [
      {
        "description": "Standard Master/Visa Fee",
        "amount": {
          "currency": "AUD",
          "value": 0.54,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "724114a5-7646-45c4-84ff-51e9ec6ece65",
        "type": "transaction_fee",
        "discounted": {
          "currency": "AUD",
          "value": 0,
          "type": null
        },
        "accountingCode": "TEST"
      },
      {
        "description": "Load Fee",
        "amount": {
          "currency": "AUD",
          "value": 2,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "c78a7b71-9011-4dad-b578-79c6259b326b",
        "type": "load_fee",
        "discounted": {
          "currency": "AUD",
          "value": 0,
          "type": null
        },
        "accountingCode": "TEST"
      },
      {
        "description": "Boxing Beginner Plan",
        "amount": {
          "currency": "AUD",
          "value": 10,
          "type": null
        },
        "tax": {
          "rate": 0
        },
        "id": "b60bba67-f2bf-423e-ac01-cd8a3162ca4a",
        "type": "subscription_payment",
        "discounted": {
          "currency": "AUD",
          "value": 0,
          "type": null
        },
        "accountingCode": "TEST"
      }
    ],
    "amount": {
      "currency": "AUD",
      "value": 12.54,
      "type": null
    },
    "amountWithoutDiscount": {
      "currency": "AUD",
      "value": 12.54,
      "type": null
    },
    "totalDiscounted": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "totalRefunded": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "totalTax": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "customerId": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "subscriptionId": "d778a9a9-5643-4317-ab08-e5fe820407e0",
    "checkoutId": null,
    "subscriptionName": "Boxing Beginner Plan",
    "paymentMethodToken": "c3187954-3a32-4c3b-a579-a48c07489704",
    "paymentMethodData": null,
    "autoPayment": true,
    "processingModel": null,
    "createdOn": "2022-04-01T01:28:05.721",
    "payNowUrl": null,
    "channel": "api"
  }
}
{
  "requestId": "d895ced8-78a9-47d6-aa5a-b988e1767bf3",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "INVOICE_PAID",
  "createdOn": "2022-04-01T01:57:56.345",
  "data": {
    "id": "1690057a-16f3-46da-bf11-725c3a616085",
    "documentNumber": "IN0000000000067222",
    "date": "2022-04-01",
    "dueDate": "2022-04-01",
    "scheduledPaymentDate": null,
    "status": "PAID",
    "memo": null,
    "items": [
      {
        "description": "Boxing Beginner Plan",
        "amount": {
          "currency": "AUD",
          "value": 10,
          "type": null
        },
        "tax": {
          "rate": 0
        },
        "id": "b60bba67-f2bf-423e-ac01-cd8a3162ca4a",
        "type": "subscription_payment",
        "discounted": {
          "currency": "AUD",
          "value": 0,
          "type": null
        },
        "accountingCode": "TEST"
      },
      {
        "description": "Load Fee",
        "amount": {
          "currency": "AUD",
          "value": 2,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "c78a7b71-9011-4dad-b578-79c6259b326b",
        "type": "load_fee",
        "discounted": {
          "currency": "AUD",
          "value": 0,
          "type": null
        },
        "accountingCode": "TEST"
      },
      {
        "description": "Standard Master/Visa Fee",
        "amount": {
          "currency": "AUD",
          "value": 0.54,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "724114a5-7646-45c4-84ff-51e9ec6ece65",
        "type": "transaction_fee",
        "discounted": {
          "currency": "AUD",
          "value": 0,
          "type": null
        },
        "accountingCode": "TEST"
      },
      {
        "description": "Failed Payment Fee",
        "amount": {
          "currency": "AUD",
          "value": 8.5,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "6d421fb4-a8e2-4b2a-a16a-097e531a0c7e",
        "type": "failed_payment_fee",
        "discounted": {
          "currency": "AUD",
          "value": 0,
          "type": null
        },
        "accountingCode": "TEST"
      },
      {
        "description": "Standard Master/Visa Fee",
        "amount": {
          "currency": "AUD",
          "value": 0.54,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "c56dbfcb-ddf5-44a7-a3db-95db4be67e74",
        "type": "transaction_fee",
        "discounted": {
          "currency": "AUD",
          "value": 0,
          "type": null
        },
        "accountingCode": "TEST"
      }
    ],
    "amount": {
      "currency": "AUD",
      "value": 21.58,
      "type": null
    },
    "amountWithoutDiscount": {
      "currency": "AUD",
      "value": 21.58,
      "type": null
    },
    "totalDiscounted": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "totalRefunded": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "totalTax": {
      "currency": "AUD",
      "value": 0.01,
      "type": null
    },
    "customerId": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "subscriptionId": "d778a9a9-5643-4317-ab08-e5fe820407e0",
    "checkoutId": null,
    "subscriptionName": "Boxing Beginner Plan",
    "paymentMethodToken": "15baddd8-8cc0-43c6-a2f8-4ad1fc571b51",
    "paymentMethodData": null,
    "autoPayment": true,
    "processingModel": null,
    "createdOn": "2022-04-01T01:28:05.721",
    "payNowUrl": null,
    "channel": "online_payment_recovery"
  }
}
{
  "requestId": "c7a6bf09-252e-42e8-aca7-4c04ae21dd2d",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "INVOICE_PAST_DUE",
  "createdOn": "2022-04-01T01:28:08.013",
  "data": {
    "id": "1690057a-16f3-46da-bf11-725c3a616085",
    "documentNumber": "IN0000000000067222",
    "date": "2022-04-01",
    "dueDate": "2022-04-01",
    "scheduledPaymentDate": null,
    "status": "PAST_DUE",
    "memo": null,
    "items": [
      {
        "description": "Standard Master/Visa Fee",
        "amount": {
          "currency": "AUD",
          "value": 0.54,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "724114a5-7646-45c4-84ff-51e9ec6ece65",
        "type": "transaction_fee",
        "discounted": {
          "currency": "AUD",
          "value": 0,
          "type": null
        },
        "accountingCode": "TEST"
      },
      {
        "description": "Load Fee",
        "amount": {
          "currency": "AUD",
          "value": 2,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "c78a7b71-9011-4dad-b578-79c6259b326b",
        "type": "load_fee",
        "discounted": {
          "currency": "AUD",
          "value": 0,
          "type": null
        },
        "accountingCode": "TEST"
      },
      {
        "description": "Boxing Beginner Plan",
        "amount": {
          "currency": "AUD",
          "value": 10,
          "type": null
        },
        "tax": {
          "rate": 0
        },
        "id": "b60bba67-f2bf-423e-ac01-cd8a3162ca4a",
        "type": "subscription_payment",
        "discounted": {
          "currency": "AUD",
          "value": 0,
          "type": null
        },
        "accountingCode": "TEST"
      },
      {
        "description": "Failed Payment Fee",
        "amount": {
          "currency": "AUD",
          "value": 8.5,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "6d421fb4-a8e2-4b2a-a16a-097e531a0c7e",
        "type": "failed_payment_fee",
        "discounted": {
          "currency": "AUD",
          "value": 0,
          "type": null
        },
        "accountingCode": "TEST"
      }
    ],
    "amount": {
      "currency": "AUD",
      "value": 21.04,
      "type": null
    },
    "amountWithoutDiscount": {
      "currency": "AUD",
      "value": 21.04,
      "type": null
    },
    "totalDiscounted": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "totalRefunded": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "totalTax": {
      "currency": "AUD",
      "value": 0.01,
      "type": null
    },
    "customerId": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "subscriptionId": "d778a9a9-5643-4317-ab08-e5fe820407e0",
    "checkoutId": null,
    "subscriptionName": "Boxing Beginner Plan",
    "paymentMethodToken": "c3187954-3a32-4c3b-a579-a48c07489704",
    "paymentMethodData": null,
    "autoPayment": false,
    "processingModel": null,
    "createdOn": "2022-04-01T01:28:05.721",
    "failedPaymentReason": {
      "code": "invalid_payment_method",
      "description": "Payment method details are invalid. Please use a different payment method."
    },
    "paymentProviderResponse": {
      "code": "Refused",
      "description": "Invalid card number"
    },
    "payNowUrl": "https://paynow-staging.ezypay.com?token=b65029b3-920e-4165-8985-bfd56650a504|1690057a-16f3-46da-bf11-725c3a616085|48cb97f6-d066-4f10-94e1-bda9026be33c|",
    "channel": "api",
    "paymentMethodInvalid": true,
    "manualRetryPossible": false
  }
}

Invoice Batch Payload Event

{
  "requestId": "20acb5cd-cd38-419c-bfcf-f05d8fd35bca",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "INVOICE_BATCH_CREATED",
  "createdOn": "2022-04-01T06:44:07.906",
  "data": {
    "id": "7675ba08-bcd8-4f1b-9218-6554b0e0db70",
    "batchReference": "testing1234",
    "createdOn": "2022-04-01T06:44:07.849",
    "status": "SUBMITTED"
  }
}
{
  "requestId": "37e50618-4894-449b-b0c0-3ed3acfa6acb",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "INVOICE_BATCH_PROCESSING",
  "createdOn": "2022-04-01T06:44:41.198",
  "data": {
    "id": "7675ba08-bcd8-4f1b-9218-6554b0e0db70",
    "batchReference": "testing1234",
    "createdOn": "2022-04-01T06:44:07.849",
    "status": "PROCESSING"
  }
}
{
  "requestId": "366deacc-0401-4dac-bb87-f34f83ceb969",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "INVOICE_BATCH_SUCCESS",
  "createdOn": "2022-04-01T06:46:35.146",
  "data": {
    "id": "7675ba08-bcd8-4f1b-9218-6554b0e0db70",
    "batchReference": "testing1234",
    "createdOn": "2022-04-01T06:44:07.849",
    "status": "SUCCESS"
  }
}
{
  "requestId": "fcd671ef-3a88-4aa4-93d2-ba613fd4502f",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "INVOICE_BATCH_INVOICE_FAILED",
  "createdOn": "2022-04-01T07:08:08.726",
  "data": {
    "id": "a266f39e-a7c2-47ba-9869-f72de14fa5e7",
    "invoiceBatchId": "47142895-17df-469c-9fee-dc70963a3572",
    "invoiceBatchItemId": "535742e2-bc61-4d01-bb64-42b4a09be157",
    "externalInvoiceId": "7f95176f-8d8f-4f91-b7c9-a1d2f8c6ec8c",
    "failedReason": "External invoice id should be unique",
    "status": "FAILED",
    "failedOn": "2022-04-01T07:08:08.710"
  }
}

Subscription Payload Event

{
  "requestId": "779d53c5-2ee1-4692-9669-0f469ba42112",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "SUBSCRIPTION_CREATE",
  "createdOn": "2022-04-01T01:28:06.142",
  "data": {
    "id": "d778a9a9-5643-4317-ab08-e5fe820407e0",
    "customerId": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "planId": "c0922f98-ea26-4e4c-a903-f83d74c01e1c",
    "name": "Boxing Beginner Plan",
    "status": "PAST_DUE",
    "startDate": "2022-04-01",
    "endDate": "2022-04-01",
    "paymentMethodToken": "c3187954-3a32-4c3b-a579-a48c07489704",
    "accountingCode": "TEST",
    "amount": {
      "currency": "AUD",
      "value": 10,
      "type": null
    },
    "tax": {
      "rate": 0
    },
    "nextBillingDate": null,
    "nextFutureInvoice": null,
    "interval": 10,
    "intervalUnit": "DAY",
    "totalPaid": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "totalBillingCycles": 1,
    "remainingToPay": {
      "currency": "AUD",
      "value": 10,
      "type": null
    },
    "remainingBillingCycles": null,
    "endTargetAmount": {
      "currency": "AUD",
      "value": 10,
      "type": null
    },
    "endTargetBillingCycles": null,
    "cancelledDate": null,
    "failedPaymentHandling": null,
    "failedAttemptsCount": 0,
    "totalPastDue": {
      "currency": "AUD",
      "value": 10,
      "type": null
    },
    "totalDiscounted": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "metadata": null,
    "createdOn": "2022-04-01T01:28:05.630",
    "autoPayment": true,
    "setupPayments": null,
    "paymentMethodInvalidReason": null,
    "paymentMethodInvalidDescription": null,
    "paymentMethodInvalid": false
  }
}
{
  "requestId": "c9b378f8-3316-4669-84ea-a57dafcfc415",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "SUBSCRIPTION_CANCEL",
  "createdOn": "2022-04-01T02:13:09.743",
  "data": {
    "id": "4beb7e77-53ac-4be6-bd32-b7b678cffbd8",
    "customerId": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "planId": "c0922f98-ea26-4e4c-a903-f83d74c01e1c",
    "name": "Boxing Beginner Plan",
    "status": "CANCELLED",
    "startDate": null,
    "endDate": null,
    "paymentMethodToken": "15baddd8-8cc0-43c6-a2f8-4ad1fc571b51",
    "accountingCode": "TEST",
    "amount": {
      "currency": "AUD",
      "value": 10,
      "type": null
    },
    "tax": {
      "rate": 0
    },
    "nextBillingDate": null,
    "nextFutureInvoice": null,
    "interval": 10,
    "intervalUnit": "DAY",
    "totalPaid": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "totalBillingCycles": 0,
    "remainingToPay": null,
    "remainingBillingCycles": null,
    "endTargetAmount": null,
    "endTargetBillingCycles": null,
    "cancelledDate": "2022-04-01",
    "failedPaymentHandling": null,
    "failedAttemptsCount": 0,
    "totalPastDue": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "totalDiscounted": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "metadata": null,
    "createdOn": "2022-04-01T02:12:47.425",
    "autoPayment": true,
    "setupPayments": [
      {
        "amount": {
          "currency": "AUD",
          "value": 50,
          "type": "FIXED_AMOUNT"
        },
        "tax": {
          "rate": 50
        },
        "description": "setup fee",
        "accountingCode": null
      }
    ],
    "paymentMethodInvalidReason": null,
    "paymentMethodInvalidDescription": null,
    "paymentMethodInvalid": false
  }
}
{
  "requestId": "22f327d6-2d17-4d4a-87db-770bf1c6fdcc",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "SUBSCRIPTION_ACTIVATE",
  "createdOn": "2022-03-28T08:36:34.875",
  "data": {
    "id": "7a16f75a-6ffb-43ea-9ed3-8070e4ad5de8",
    "customerId": "5c8d75a1-4d28-48f8-8d80-0e41cba5bc02",
    "planId": "c0922f98-ea26-4e4c-a903-f83d74c01e1c",
    "name": "Boxing Beginner Plan",
    "status": "PAST_DUE",
    "startDate": "2022-03-28",
    "endDate": "2022-03-28",
    "paymentMethodToken": "772306c8-3998-4f96-88b9-6e0bf2d430f1",
    "accountingCode": "TEST",
    "amount": {
      "currency": "AUD",
      "value": 10,
      "type": null
    },
    "tax": {
      "rate": 0
    },
    "nextBillingDate": null,
    "nextFutureInvoice": null,
    "interval": 10,
    "intervalUnit": "DAY",
    "totalPaid": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "totalBillingCycles": 1,
    "remainingToPay": {
      "currency": "AUD",
      "value": 10,
      "type": null
    },
    "remainingBillingCycles": null,
    "endTargetAmount": {
      "currency": "AUD",
      "value": 10,
      "type": null
    },
    "endTargetBillingCycles": null,
    "cancelledDate": null,
    "failedPaymentHandling": null,
    "failedAttemptsCount": 0,
    "totalPastDue": {
      "currency": "AUD",
      "value": 10,
      "type": null
    },
    "totalDiscounted": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "metadata": {
      "recurringBillingDate": "2022-04-07"
    },
    "createdOn": "2022-03-28T08:36:34.431",
    "autoPayment": true,
    "setupPayments": null,
    "paymentMethodInvalidReason": null,
    "paymentMethodInvalidDescription": null,
    "paymentMethodInvalid": false
  }
}
{
  "requestId": "f662ef7a-fdd7-4425-a150-8b7246728a08",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "SUBSCRIPTION_PAYMENT_REACTIVATE",
  "createdOn": "2022-02-25T02:59:58.796",
  "data": {
    "name": "Sample Plan",
    "subscriptionId": "69163681-b0c8-4150-b1c1-ff19d6e59e77",
    "customerId": "2c776eb0-a97d-4663-9148-48571cafab45",
    "amount": 15,
    "firstInvoiceAmount": null,
    "interval": 10,
    "intervalUnit": "DAY",
    "startDate": "2022-02-25",
    "endTargetBillingCycles": null,
    "endTargetAmount": null,
    "endDate": null,
    "status": null,
    "onceOffPayment": false
  }
}
{
  "requestId": "2b4cb020-d694-4ceb-be0a-b38f4dfcf4fd",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "SUBSCRIPTION_PAYMENT_STOPPED",
  "createdOn": "2022-04-11T03:58:32.017",
  "data": {
    "subscriptionId": "d314e010-d849-4b6f-937e-a9d78ba37f6a",
    "customerId": "8c139209-1564-4e2b-98fe-8c39961c986b",
    "name": "Learn Something Plan",
    "amount": 20,
    "interval": 1,
    "intervalUnit": "MONTH",
    "startDate": "2022-04-11",
    "endTargetBillingCycles": null,
    "endTargetAmount": null,
    "endDate": null,
    "failedPaymentHandling": {
      "initialAction": "STOP",
      "autoRetry": true,
      "retryInDays": 3,
      "maximumFailedAttempts": 4
    },
    "failedAttemptsCount": 0,
    "autoPayment": false,
    "paymentMethodInvalidReason": "invalid_payment_method",
    "paymentMethodInvalidDescription": "Payment method details are invalid. Please use a different payment method.",
    "paymentMethodToken": "8420b09e-5039-4ddf-bb9c-1c9011e411fc",
    "paymentMethodInvalid": true
  }
}
{
  "requestId": "8d67d2f6-8fa5-4c09-b5ee-4096c975b830",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "SUBSCRIPTION_COMPLETE",
  "createdOn": "2022-03-15T03:59:56.924",
  "data": {
    "name": "Boxing Beginner Plan",
    "subscriptionId": "cef1ebc1-441c-4859-8555-48af19d2fd53",
    "customerId": "801e3cbc-6949-4acd-86b0-8a2dd2992b4a",
    "amount": 10,
    "firstInvoiceAmount": null,
    "interval": 10,
    "intervalUnit": "DAY",
    "startDate": "2022-03-15",
    "endTargetBillingCycles": null,
    "endTargetAmount": 10,
    "endDate": "2022-03-15",
    "status": null,
    "onceOffPayment": true
  }
}

Credit Note Payload Event

{
  "requestId": "f8a7f69c-0c40-43a5-ab32-c72983bfdcd7",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "CREDIT_NOTE_CREATED",
  "createdOn": "2022-04-01T02:51:40.568",
  "data": {
    "id": "606094b8-2f2b-4f43-9576-b364495dd710",
    "invoiceId": "1690057a-16f3-46da-bf11-725c3a616085",
    "documentNumber": "CN0000000000000166",
    "date": "2022-04-01",
    "status": "PROCESSING",
    "items": [
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 0.54,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "32355d5d-0493-4df8-b902-9fb9740a2cb6",
        "type": "transaction_fee",
        "accountingCode": "TEST"
      },
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 0.54,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "54a50e5f-c555-418c-b41e-5a26b92bf690",
        "type": "transaction_fee",
        "accountingCode": "TEST"
      },
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 8.5,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "b4a20435-57c2-431c-a17b-be358d474fde",
        "type": "failed_payment_fee",
        "accountingCode": "TEST"
      },
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 10,
          "type": null
        },
        "tax": {
          "rate": 0
        },
        "id": "c92d82e2-7e6c-4d67-8697-e50c3d579a12",
        "type": "subscription_payment",
        "accountingCode": "TEST"
      },
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 2,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "dde62e8e-e50c-4c17-974f-a4d2fcd59337",
        "type": "load_fee",
        "accountingCode": "TEST"
      }
    ],
    "amount": {
      "currency": "AUD",
      "value": 21.58,
      "type": null
    },
    "totalTax": {
      "currency": "AUD",
      "value": 0.02,
      "type": null
    },
    "reason": "REFUND",
    "customerId": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "paymentMethodToken": "15baddd8-8cc0-43c6-a2f8-4ad1fc571b51"
  }
}
{
  "requestId": "eb057ec2-75ae-48eb-9d6b-a161d66f533f",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "CREDIT_NOTE_PAID",
  "createdOn": "2022-04-01T02:51:52.545",
  "data": {
    "id": "606094b8-2f2b-4f43-9576-b364495dd710",
    "invoiceId": "1690057a-16f3-46da-bf11-725c3a616085",
    "documentNumber": "CN0000000000000166",
    "date": "2022-04-01",
    "status": "PAID",
    "items": [
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 0.54,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "32355d5d-0493-4df8-b902-9fb9740a2cb6",
        "type": "transaction_fee",
        "accountingCode": "TEST"
      },
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 0.54,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "54a50e5f-c555-418c-b41e-5a26b92bf690",
        "type": "transaction_fee",
        "accountingCode": "TEST"
      },
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 8.5,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "b4a20435-57c2-431c-a17b-be358d474fde",
        "type": "failed_payment_fee",
        "accountingCode": "TEST"
      },
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 10,
          "type": null
        },
        "tax": {
          "rate": 0
        },
        "id": "c92d82e2-7e6c-4d67-8697-e50c3d579a12",
        "type": "subscription_payment",
        "accountingCode": "TEST"
      },
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 2,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "dde62e8e-e50c-4c17-974f-a4d2fcd59337",
        "type": "load_fee",
        "accountingCode": "TEST"
      }
    ],
    "amount": {
      "currency": "AUD",
      "value": 21.58,
      "type": null
    },
    "totalTax": {
      "currency": "AUD",
      "value": 0.02,
      "type": null
    },
    "reason": "REFUND",
    "customerId": "48cb97f6-d066-4f10-94e1-bda9026be33c",
    "paymentMethodToken": "15baddd8-8cc0-43c6-a2f8-4ad1fc571b51"
  }
}
{
  "requestId": "a7119793-4306-47f4-b772-d63b08cb43ee",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "CREDIT_NOTE_FAILED",
  "createdOn": "2022-04-01T05:30:47.467",
  "data": {
    "id": "e3ffeb8c-edc8-44c8-8333-4d92ad7fa18d",
    "invoiceId": "28cffbe8-f2d6-49fd-8202-4e2b0b1fdb01",
    "documentNumber": "CN0000000000000199",
    "date": "2022-04-01",
    "status": "FAILED",
    "items": [
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 0.54,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "f04110a9-f9c3-488c-8ad5-574dd1595754",
        "type": "transaction_fee",
        "accountingCode": "TEST"
      },
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 10,
          "type": null
        },
        "tax": {
          "rate": 0
        },
        "id": "ed186eda-f2eb-4592-9fc7-8342c934056a",
        "type": "subscription_payment",
        "accountingCode": "TEST"
      },
      {
        "description": "Refund",
        "amount": {
          "currency": "AUD",
          "value": 2,
          "type": null
        },
        "tax": {
          "rate": 0.1
        },
        "id": "e3a23436-b02a-447a-9926-6c1b5f38d6ea",
        "type": "load_fee",
        "accountingCode": "TEST"
      }
    ],
    "amount": {
      "currency": "AUD",
      "value": 12.54,
      "type": null
    },
    "totalTax": {
      "currency": "AUD",
      "value": 0.01,
      "type": null
    },
    "reason": "REFUND",
    "customerId": "8bb7a87b-04f1-41e2-8071-41996448e4e8",
    "paymentMethodToken": "fbafefa2-3e58-4bf0-a981-a5258d14fcc0"
  }
}

Dispute Payload Event

{
  "requestId": "3b406831-68a1-42ef-9860-ca4a1ae9406e",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "DISPUTE_WON",
  "createdOn": "2022-04-01T06:05:46.841",
  "data": {
    "invoiceId": "cafabfea-086e-4d33-80f4-5752f66496f1",
    "invoiceTransactionId": "e6c9375d-3df7-4209-9c0a-b7de3714924d",
    "distributionTransactionId": null,
    "distributionRunNumber": 0,
    "invoiceDate": "2022-04-01",
    "dueDate": "2022-04-01",
    "scheduledPaymentDate": null,
    "createdOn": "2022-04-01T06:05:46.787",
    "invoiceNumber": "CN0000000000000265",
    "associatedInvoiceNumber": "IN0000000000067288",
    "associatedInvoiceId": "449dade9-7986-499f-a687-da483f4c622d",
    "paymentNumber": null,
    "collectionType": null,
    "paymentMethod": {
      "@type": "Card",
      "paymentMethodToken": "6d2c9a40-c271-4e9c-893f-48dcc9f12a65",
      "paymentMethodType": "CARD",
      "description": null,
      "bank": null,
      "creditCard": {
        "accountHolderName": null,
        "type": "VISA",
        "first6": null,
        "last4": "1111",
        "expiryMonth": null,
        "expiryYear": null,
        "fingerPrint": null
      }
    },
    "amount": 10.54,
    "currencyCode": "AUD",
    "issuedBy": {
      "id": "b65029b3-920e-4165-8985-bfd56650a504",
      "entityId": "b65029b3-920e-4165-8985-bfd56650a504",
      "name": "high_st LegalNameAU",
      "merchantTradingName": "high_st NameAU",
      "referenceCode": "49171",
      "accountType": "MERCHANT"
    },
    "issuedTo": {
      "id": "00000000-0000-0000-0000-000000000000",
      "entityId": "b4d90c49-22d7-4eb0-a9f5-056b5049f2c6",
      "name": "Adrian Foo",
      "merchantTradingName": null,
      "referenceCode": "EZY425755",
      "accountType": "CUSTOMER"
    },
    "billingRelationshipType": "MERCHANT_TO_CUSTOMER",
    "invoiceLineItems": [
      {
        "id": "3d5dee53-634f-4b20-ae3f-47eab0608c5a",
        "invoiceItemType": "subscription_payment",
        "amount": 10,
        "taxRate": 0,
        "taxAmount": 0,
        "currencyCode": "AUD",
        "description": "Boxing Beginner Plan",
        "additionalDetail": null,
        "ledgerTransactionNumber": null,
        "category": null,
        "accountingCode": "TEST",
        "pricingFeeResultId": null
      },
      {
        "id": "5178b17e-2c08-4588-b325-6da21fbfd824",
        "invoiceItemType": "transaction_fee",
        "amount": 0.54,
        "taxRate": 0.1,
        "taxAmount": 0,
        "currencyCode": "AUD",
        "description": "Standard Master/Visa Fee",
        "additionalDetail": null,
        "ledgerTransactionNumber": null,
        "category": null,
        "accountingCode": "TEST",
        "pricingFeeResultId": null
      }
    ],
    "refundReason": null,
    "countryCode": "AU",
    "invoiceType": "REGULAR_PAYMENT_INVOICE",
    "paymentResponse": {
      "paymentTransactionId": "7181809",
      "paymentTransactionDescription": null,
      "paymentResponseCode": null,
      "paymentProcessorResponseCode": null,
      "paymentProcessorResponseDescription": null,
      "paymentProcessorProcessorTransactionId": null,
      "paymentProcessor": "ADYEN",
      "action": null,
      "failedReason": null,
      "originalTransactionId": null,
      "paymentProcessorCode": null
    },
    "notificationSetting": {
      "subscriptionCreation": true,
      "paymentMethodCreation": true,
      "pastDueInvoice": true
    },
    "invoiceStatus": null,
    "billAttempts": null,
    "refundTotal": null,
    "taxTotal": null,
    "channel": null,
    "invoiceTransactionType": null,
    "invoiceTransactionSource": null,
    "merchantConnection": null,
    "externalInvoiceId": null,
    "processingModel": null,
    "merchantCategoryCode": null,
    "submerchantDetails": null,
    "rebill": false
  }
}
{
  "requestId": "0200a965-c212-4a7c-bf11-3ce526e6028c",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "DISPUTE_LOST",
  "createdOn": "2022-04-01T05:48:33.268",
  "data": {
    "invoiceId": "e343205e-3027-403f-9b21-afb4437f8e97",
    "invoiceTransactionId": "1977974e-00a5-4167-bd9d-3753473a51fc",
    "distributionTransactionId": null,
    "distributionRunNumber": 0,
    "invoiceDate": "2022-04-01",
    "dueDate": "2022-04-01",
    "scheduledPaymentDate": null,
    "createdOn": "2022-04-01T05:48:32.948",
    "invoiceNumber": "CN0000000000000232",
    "associatedInvoiceNumber": "IN0000000000067256",
    "associatedInvoiceId": "28cffbe8-f2d6-49fd-8202-4e2b0b1fdb01",
    "paymentNumber": null,
    "collectionType": null,
    "paymentMethod": {
      "@type": "Card",
      "paymentMethodToken": "fbafefa2-3e58-4bf0-a981-a5258d14fcc0",
      "paymentMethodType": "CARD",
      "description": null,
      "bank": null,
      "creditCard": {
        "accountHolderName": null,
        "type": "VISA",
        "first6": null,
        "last4": "8612",
        "expiryMonth": null,
        "expiryYear": null,
        "fingerPrint": null
      }
    },
    "amount": 12.54,
    "currencyCode": "AUD",
    "issuedBy": {
      "id": "b65029b3-920e-4165-8985-bfd56650a504",
      "entityId": "b65029b3-920e-4165-8985-bfd56650a504",
      "name": "high_st LegalNameAU",
      "merchantTradingName": "high_st NameAU",
      "referenceCode": "49171",
      "accountType": "MERCHANT"
    },
    "issuedTo": {
      "id": "00000000-0000-0000-0000-000000000000",
      "entityId": "8bb7a87b-04f1-41e2-8071-41996448e4e8",
      "name": "Eli Lawrence",
      "merchantTradingName": null,
      "referenceCode": "EZY426540",
      "accountType": "CUSTOMER"
    },
    "billingRelationshipType": "MERCHANT_TO_CUSTOMER",
    "invoiceLineItems": [
      {
        "id": "a0c1aa1d-111c-4669-88e4-9b7be006cf63",
        "invoiceItemType": "transaction_fee",
        "amount": 0.54,
        "taxRate": 0.1,
        "taxAmount": 0,
        "currencyCode": "AUD",
        "description": "Standard Master/Visa Fee",
        "additionalDetail": null,
        "ledgerTransactionNumber": null,
        "category": null,
        "accountingCode": "TEST",
        "pricingFeeResultId": null
      },
      {
        "id": "138f3e66-e8f2-4e87-b003-44479c5acb54",
        "invoiceItemType": "load_fee",
        "amount": 2,
        "taxRate": 0.1,
        "taxAmount": 0,
        "currencyCode": "AUD",
        "description": "Load Fee",
        "additionalDetail": null,
        "ledgerTransactionNumber": null,
        "category": null,
        "accountingCode": "TEST",
        "pricingFeeResultId": null
      },
      {
        "id": "4e786ebd-f0dc-49da-9c39-89c7239d13e7",
        "invoiceItemType": "subscription_payment",
        "amount": 10,
        "taxRate": 0,
        "taxAmount": 0,
        "currencyCode": "AUD",
        "description": "Boxing Beginner Plan",
        "additionalDetail": null,
        "ledgerTransactionNumber": null,
        "category": null,
        "accountingCode": "TEST",
        "pricingFeeResultId": null
      }
    ],
    "refundReason": null,
    "countryCode": "AU",
    "invoiceType": "REGULAR_PAYMENT_INVOICE",
    "paymentResponse": {
      "paymentTransactionId": "7181499",
      "paymentTransactionDescription": null,
      "paymentResponseCode": null,
      "paymentProcessorResponseCode": null,
      "paymentProcessorResponseDescription": null,
      "paymentProcessorProcessorTransactionId": null,
      "paymentProcessor": "ADYEN",
      "action": null,
      "failedReason": null,
      "originalTransactionId": null,
      "paymentProcessorCode": null
    },
    "notificationSetting": {
      "subscriptionCreation": true,
      "paymentMethodCreation": true,
      "pastDueInvoice": true
    },
    "invoiceStatus": null,
    "billAttempts": null,
    "refundTotal": null,
    "taxTotal": null,
    "channel": null,
    "invoiceTransactionType": null,
    "invoiceTransactionSource": null,
    "merchantConnection": null,
    "externalInvoiceId": null,
    "processingModel": null,
    "merchantCategoryCode": null,
    "submerchantDetails": null,
    "rebill": false
  }
}

Partner Invoice Event

📘

NOTE

The "issuerMerchant" will be the merchant that is looking to get partner amount from the main merchant account. The "recipientMerchant" will be the Main merchant wallet account. When an amount is required to be transfer from the parent/master account to the child/sub account, the child/sub account will need to generate a partner invoice to request that amount from the parent/master account.

Prerequisite:
The webhook event needs to be subscript on the child/sub account:
a) partner_invoice_created
b) partner_invoice_paid
c) partner_invoice_past_due

A best practice would be to add this subscribe the webhook events using the parent/master webhook response endpoint.

{
  "requestId": "dd12b70a-233c-468a-b9c8-b1f5ecaeb87d",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "PARTNER_INVOICE_CREATED",
  "createdOn": "2022-04-01T02:33:19.163",
  "data": {
    "id": "b2c6068d-e398-4463-ac8c-24680dba8a89",
    "documentNumber": "IN0000000000067226",
    "date": "2022-04-01",
    "dueDate": "2022-04-01",
    "status": "PROCESSING",
    "memo": null,
    "items": [
      {
        "description": "Testing1",
        "amount": {
          "currency": "AUD",
          "value": 10,
          "type": null
        },
        "tax": {
          "rate": 0
        },
        "id": "071e6e1c-f5e5-4948-838a-417bdc006f60",
        "type": "partner_on_demand",
        "accountingCode": null,
        "additionalDetail": null
      }
    ],
    "amount": {
      "currency": "AUD",
      "value": 10,
      "type": null
    },
    "totalTax": {
      "currency": "AUD",
      "value": 0,
      "type": null
    },
    "issuerMerchant": {
      "id": "b65029b3-920e-4165-8985-bfd56650a504",
      "name": "high_st NameAU",
      "legalName": "high_st LegalNameAU"
    },
    "recipientMerchant": {
      "id": "cf7e6c94-a3e6-4827-b3ca-3608dc3b56ee",
      "name": "high_st NameAU",
      "legalName": "high_st LegalNameAU"
    },
    "createdOn": "2022-04-01T02:33:19.130",
    "countryCode": "AU",
    "partnerSubscriptionId": null
  }
}
{
  "requestId": "0ff87341-8849-49da-a48e-caeaeabf6ffb",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "PARTNER_INVOICE_PAID",
  "createdOn": "2022-04-01T02:33:19.487",
  "data": {
    "id": "b2c6068d-e398-4463-ac8c-24680dba8a89",
    "documentNumber": "IN0000000000067226",
    "date": "2022-04-01",
    "dueDate": "2022-04-01",
    "status": "PAID",
    "memo": null,
    "items": [
      {
        "id": "071e6e1c-f5e5-4948-838a-417bdc006f60",
        "type": "partner_on_demand",
        "description": "Testing1",
        "amount": {
          "currency": "AUD",
          "value": 10
        },
        "tax": {
          "rate": 0
        },
        "accountingCode": null,
        "additionalDetail": null
      }
    ],
    "amount": {
      "currency": "AUD",
      "value": 10
    },
    "totalTax": {
      "currency": "AUD",
      "value": 0
    },
    "issuerMerchant": {
      "id": "b65029b3-920e-4165-8985-bfd56650a504",
      "name": "high_st LegalNameAU",
      "legalName": "high_st NameAU"
    },
    "recipientMerchant": {
      "id": "cf7e6c94-a3e6-4827-b3ca-3608dc3b56ee",
      "name": "high_st LegalNameAU",
      "legalName": "high_st NameAU"
    },
    "createdOn": "2022-04-01T13:33:19.476",
    "countryCode": "AU",
    "partnerSubscriptionId": null
  }
}
{
  "requestId": "763a2777-5a1f-4f96-95d8-77b49e8a2d78",
  "merchantId": "b65029b3-920e-4165-8985-bfd56650a504",
  "eventType": "PARTNER_INVOICE_PAST_DUE",
  "createdOn": "2022-04-01T08:01:39.450",
  "data": {
    "id": "9fdb2f9a-748b-44b7-b913-2928ddc1aeb4",
    "documentNumber": "IN0000000000067325",
    "date": "2022-04-01",
    "dueDate": "2022-04-01",
    "status": "FAILED",
    "memo": null,
    "items": [
      {
        "id": "8400f70c-fe1c-4b87-bec5-2f29566e748b",
        "type": "partner_on_demand",
        "description": "Testing5",
        "amount": {
          "currency": "AUD",
          "value": 1000000000
        },
        "tax": {
          "rate": 0
        },
        "accountingCode": null,
        "additionalDetail": null
      }
    ],
    "amount": {
      "currency": "AUD",
      "value": 1000000000
    },
    "totalTax": {
      "currency": "AUD",
      "value": 0
    },
    "issuerMerchant": {
      "id": "b65029b3-920e-4165-8985-bfd56650a504",
      "name": "high_st LegalNameAU",
      "legalName": "high_st NameAU"
    },
    "recipientMerchant": {
      "id": "cf7e6c94-a3e6-4827-b3ca-3608dc3b56ee",
      "name": "high_st LegalNameAU",
      "legalName": "high_st NameAU"
    },
    "createdOn": "2022-04-01T19:01:39.285",
    "countryCode": "AU",
    "partnerSubscriptionId": null
  }
}

Did this page help you?