CentralPay Documentation CentralPay Documentation
  • Informations générales
  • Documentation
  • Développeurs
CentralPay Documentation CentralPay Documentation
  • Informations générales
  • Documentation
  • Développeurs

Développeurs

  • Icône de dossier fermée Icône d’ouverture de dossierHow to use the swagger >
  • Icône de dossier fermée Icône d’ouverture de dossierAuthentication 3DS 2.2 >
  • Icône de dossier fermée Icône d’ouverture de dossierBankAccount >
  • Icône de dossier fermée Icône d’ouverture de dossierCard token
  • Icône de dossier fermée Icône d’ouverture de dossierCARD Transaction
    • Transaction
    • Card
    • Credit
    • Disputes
  • Icône de dossier fermée Icône d’ouverture de dossierCharge
  • Icône de dossier fermée Icône d’ouverture de dossierCustomer >
  • Icône de dossier fermée Icône d’ouverture de dossierInstallment Payment >
  • Icône de dossier fermée Icône d’ouverture de dossierMerchantInfo >
  • Icône de dossier fermée Icône d’ouverture de dossierOnboarding
    • Create Enrollement
    • Complete enrollment
    • Update enrollment
    • Search enrollement
    • Enrollment Details
    • E-money
    • Misc
  • Icône de dossier fermée Icône d’ouverture de dossierPayout >
  • Icône de dossier fermée Icône d’ouverture de dossierRefund >
  • Icône de dossier fermée Icône d’ouverture de dossierPayment Request >
  • Icône de dossier fermée Icône d’ouverture de dossierSCT Transaction
    • SCT Transaction
    • SCT Transaction Reversal
    • Bank Reconciliation
    • Bank Reconciliation external
  • Icône de dossier fermée Icône d’ouverture de dossierSDD Transaction
    • Mandate
    • SDD Transaction
    • SDD Transaction Reversal
  • Icône de dossier fermée Icône d’ouverture de dossierSubscription
    • Subscription Model
    • Subscription
    • Invoice & invoiceItem
  • Icône de dossier fermée Icône d’ouverture de dossierTransfer >
  • Icône de dossier fermée Icône d’ouverture de dossierTransferReversal >
  • Icône de dossier fermée Icône d’ouverture de dossierWallet >
  • Icône de dossier fermée Icône d’ouverture de dossierBlacklist >
  • Icône de dossier fermée Icône d’ouverture de dossierWhiteList >
  • Icône de dossier fermée Icône d’ouverture de dossierWebhook notifications
    • The BANKACCOUNT object
    • The CARD object
    • The CREDIT object
    • The CUSTOMER object
    • The DEPOSIT object
    • The DISPUTE object
    • The INSTALLMENT object
    • The ONBOARDING object
    • The PAYMENT REQUEST object
    • The PAYOUT object
    • The REFUND object
    • The SCT Transaction object
    • The SDD TRANSACTION object
    • The MANDATE object
    • The SUBSCRIPTION object
    • The TRANSACTION object
    • The TRANSFER REVERSAL object
    • The TRANSFER object
    • The WIRETRANSFER object (Deprecated)
  • Icône de dossier fermée Icône d’ouverture de dossierObject status
    • PAYMENT REQUEST status
    • TRANSACTION status
    • REFUND status
    • CREDIT status
    • DISPUTES status
    • SUBSCRIPTION status
    • INSTALLMENT status
    • SDD TRANSACTION status
    • MANDATE status
    • BANK ACCOUNT status
    • PAYOUT status
    • SCT TRANSACTION status
  • Icône de dossier fermée Icône d’ouverture de dossierResources by type
    • Codes
      • HTTP Codes
      • Bank return codes
      • Currency codes
      • SDD return codes
      • Country codes
      • Transfer purpose codes
      • SDD purpose codes
      • Error codes
    • Test values
      • Test IBAN values
      • Test cards Values

The SUBSCRIPTION object

Temps estimé :14 minutes
SUBSCRIPTIONMODEL_CREATED
When a Subscription model is created
{
  "eventId": "396d5bf8-f494-4ba6-91ef-29bd6be595b1",
  "type": "SUBSCRIPTIONMODEL_CREATED",
  "creationDate": "2024-01-08T11:56:53.360135+01:00",
  "object": {
    "additionalData": {},
    "amount": 10000,
    "creationDate": "2024-01-08T11:56:53.353430+01:00",
    "currency": "EUR",
    "intervalCount": 1,
    "intervalUnit": "MONTH",
    "iterationCount": 12,
    "name": "Test Abo",
    "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
    "subscriptionModelId": "50eeed1d-b908-4fc3-8863-466a733b272c"
  },
  "requestId": "9dd48255-2b54-40bb-bd38-dfeac5d0535b"
}

SUBSCRIPTIONMODEL_UPDATED
When a Subscription model is updated
{
  "eventId": "d00f3f00-b2d6-4de4-8c41-a106b88054b9",
  "type": "SUBSCRIPTIONMODEL_UPDATED",
  "creationDate": "2024-01-08T11:58:22.826908+01:00",
  "object": {
    "additionalData": {},
    "amount": 10000,
    "creationDate": "2024-01-08T11:56:53.353430+01:00",
    "currency": "EUR",
    "intervalCount": 1,
    "intervalUnit": "MONTH",
    "iterationCount": 12,
    "name": "CPMInnn",
    "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
    "subscriptionModelId": "50eeed1d-b908-4fc3-8863-466a733b272c"
  },
  "requestId": "4bc97650-9a0e-4032-ba46-8088c1e31b0b",
  "objectBeforeUpdate": {
    "additionalData": {},
    "amount": 10000,
    "creationDate": "2024-01-08T11:56:53.353430+01:00",
    "currency": "EUR",
    "intervalCount": 1,
    "intervalUnit": "MONTH",
    "iterationCount": 12,
    "name": "Test Abo",
    "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
    "subscriptionModelId": "50eeed1d-b908-4fc3-8863-466a733b272c"
  }
}

SUBSCRIPTION_CREATED
When a Subscription is created
{
  "eventId": "f87999fa-ab71-4a57-bc1f-b360670ef593",
  "type": "SUBSCRIPTION_CREATED",
  "creationDate": "2024-01-08T12:24:12.821583+01:00",
  "object": {
    "additionalData": {},
    "cardId": "8750301a-f2ae-4447-8a3a-62e37675e1ca",
    "creationDate": "2024-01-08T12:24:12.700858+01:00",
    "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
    "endUserIp": "245.100.1.15",
    "expectedEndingDate": "2025-01-09",
    "merchantSubscriptionId": "Gauthier refapi",
    "quantity": 1,
    "startingDate": "2024-01-10",
    "status": "ACTIVE",
    "subscriptionId": "c64ba2e5-a0b1-43e2-867a-27555c355331",
    "subscriptionModel": {
      "additionalData": {},
      "amount": 100,
      "creationDate": "2024-01-08T12:20:23.305903+01:00",
      "currency": "EUR",
      "intervalCount": 1,
      "intervalUnit": "MONTH",
      "iterationCount": 12,
      "name": "Test refapi",
      "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
      "subscriptionModelId": "e16a35bf-ca34-48b7-9726-139c15e89fa9"
    }
  },
  "requestId": "c66d38ac-5f7d-4a52-840c-ebadade3bf4f"
}

SUBSCRIPTION_FAILED
When a Subscription failed
{
  "eventId": "3c8ca51e-aa44-41ca-ad24-872a86ed35ee",
  "type": "SUBSCRIPTION_FAILED",
  "creationDate": "2024-01-15T11:59:56.223023+01:00",
  "object": {
    "additionalData": {},
    "cancelAtPeriodEnd": false,
    "cancellationDate": "2024-01-15T11:59:55.877297+01:00",
    "cardId": "0a6b2fdc-85e4-4ffa-bffa-0ae276e11aa3",
    "creationDate": "2024-01-15T11:59:52.983206+01:00",
    "currentPeriodEnd": "2024-01-15",
    "currentPeriodStart": "2024-01-15",
    "customerId": "947a99f7-308c-46a0-b6be-aed82d39a53c",
    "endUserIp": "245.100.1.15",
    "endingDate": "2024-01-15",
    "expectedEndingDate": "2025-01-14",
    "lastInvoice": {
      "additionalData": {},
      "amount": 10000,
      "attemptCount": 1,
      "closed": true,
      "creationDate": "2024-01-15T11:59:53.614864+01:00",
      "currency": "EUR",
      "customerId": "947a99f7-308c-46a0-b6be-aed82d39a53c",
      "invoiceId": "e0909ca3-a337-43ce-9769-d65e927b3a47",
      "invoiceItems": [
        {
          "additionalData": {},
          "amount": 10000,
          "creationDate": "2024-01-15T11:59:53.357382+01:00",
          "currency": "EUR",
          "customerId": "947a99f7-308c-46a0-b6be-aed82d39a53c",
          "invoiceId": "e0909ca3-a337-43ce-9769-d65e927b3a47",
          "invoiceItemId": "0c153918-5128-4ecb-8570-7c9f71a500ec",
          "quantity": 1,
          "subscriptionId": "55cb6ba8-3d9b-4bc9-96c9-b478b576d306",
          "totalAmount": 10000,
          "type": "SUBSCRIPTION"
        }
      ],
      "nextTransactionAttempt": "2024-01-18T06:00:04+01:00",
      "paid": false,
      "sddTransactions": [],
      "subscriptionId": "55cb6ba8-3d9b-4bc9-96c9-b478b576d306",
      "transactions": [
        "19b41977-e973-4dd9-846e-5777459196a5"
      ],
      "transfers": [],
      "type": "SUBSCRIPTION"
    },
    "merchantSubscriptionId": "Test refapi gogo",
    "quantity": 1,
    "startingDate": "2024-01-15",
    "status": "CANCELED",
    "subscriptionId": "55cb6ba8-3d9b-4bc9-96c9-b478b576d306",
    "subscriptionModel": {
      "additionalData": {},
      "amount": 10000,
      "creationDate": "2024-01-11T15:02:53.061463+01:00",
      "currency": "EUR",
      "intervalCount": 1,
      "intervalUnit": "MONTH",
      "iterationCount": 12,
      "name": "Test Abo",
      "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
      "subscriptionModelId": "7cd1b504-bed3-4435-84be-2e19f2c8e2f6"
    }
  },
  "requestId": "ac2cae53-8d39-4e5a-8098-bcf0ab55a7cc"
}

SUBSCRIPTION_UPDATED
When a Subscription is updated
{
  "eventId": "3da295c6-403e-4080-9398-9cebf7efbc37",
  "type": "SUBSCRIPTION_UPDATED",
  "creationDate": "2024-01-08T12:25:27.579680+01:00",
  "object": {
    "additionalData": {},
    "cardId": "8750301a-f2ae-4447-8a3a-62e37675e1ca",
    "creationDate": "2024-01-08T12:24:12.700858+01:00",
    "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
    "endUserIp": "245.100.1.15",
    "expectedEndingDate": "2025-01-09",
    "merchantSubscriptionId": "TEST001",
    "quantity": 1,
    "startingDate": "2024-01-10",
    "status": "ACTIVE",
    "subscriptionId": "c64ba2e5-a0b1-43e2-867a-27555c355331",
    "subscriptionModel": {
      "additionalData": {},
      "amount": 100,
      "creationDate": "2024-01-08T12:20:23.305903+01:00",
      "currency": "EUR",
      "intervalCount": 1,
      "intervalUnit": "MONTH",
      "iterationCount": 12,
      "name": "Test refapi",
      "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
      "subscriptionModelId": "e16a35bf-ca34-48b7-9726-139c15e89fa9"
    }
  },
  "requestId": "10797b88-f4ff-48f5-bc79-c417333b92d5",
  "objectBeforeUpdate": {
    "additionalData": {},
    "cardId": "8750301a-f2ae-4447-8a3a-62e37675e1ca",
    "creationDate": "2024-01-08T12:24:12.700858+01:00",
    "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
    "endUserIp": "245.100.1.15",
    "expectedEndingDate": "2025-01-09",
    "merchantSubscriptionId": "Gauthier refapi",
    "quantity": 1,
    "startingDate": "2024-01-10",
    "status": "ACTIVE",
    "subscriptionId": "c64ba2e5-a0b1-43e2-867a-27555c355331",
    "subscriptionModel": {
      "additionalData": {},
      "amount": 100,
      "creationDate": "2024-01-08T12:20:23.305903+01:00",
      "currency": "EUR",
      "intervalCount": 1,
      "intervalUnit": "MONTH",
      "iterationCount": 12,
      "name": "Test refapi",
      "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
      "subscriptionModelId": "e16a35bf-ca34-48b7-9726-139c15e89fa9"
    }
  }
}

SUBSCRIPTION_CANCELED
When a Subscription is cancelled
{
  "eventId": "298e5eae-4447-4981-932e-633adbb97e5f",
  "type": "SUBSCRIPTION_CANCELED",
  "creationDate": "2024-01-08T12:26:46.705238+01:00",
  "object": {
    "additionalData": {},
    "cancelAtPeriodEnd": false,
    "cancellationDate": "2024-01-08T12:26:46.701626+01:00",
    "cardId": "8750301a-f2ae-4447-8a3a-62e37675e1ca",
    "creationDate": "2024-01-08T12:24:12.700858+01:00",
    "currentPeriodEnd": "2024-01-08",
    "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
    "endUserIp": "245.100.1.15",
    "endingDate": "2024-01-08",
    "expectedEndingDate": "2025-01-09",
    "merchantSubscriptionId": "TEST001",
    "quantity": 1,
    "startingDate": "2024-01-10",
    "status": "CANCELED",
    "subscriptionId": "c64ba2e5-a0b1-43e2-867a-27555c355331",
    "subscriptionModel": {
      "additionalData": {},
      "amount": 100,
      "creationDate": "2024-01-08T12:20:23.305903+01:00",
      "currency": "EUR",
      "intervalCount": 1,
      "intervalUnit": "MONTH",
      "iterationCount": 12,
      "name": "Test refapi",
      "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
      "subscriptionModelId": "e16a35bf-ca34-48b7-9726-139c15e89fa9"
    }
  },
  "requestId": "bd8f1a27-bae3-4cfd-8471-7f6e878c6dc7"
}

SUBSCRIPTION_ACTIVE
When a Subscription is active

SUBSCRIPTION_FAILURE
When a Subscription failed to be paid
{
  "eventId": "22c7c038-2aa4-4550-9fd0-27e5395c250d",
  "type": "SUBSCRIPTION_FAILURE",
  "creationDate": "2024-01-15T11:59:55.661209+01:00",
  "object": {
    "additionalData": {},
    "cardId": "0a6b2fdc-85e4-4ffa-bffa-0ae276e11aa3",
    "creationDate": "2024-01-15T11:59:52.983206+01:00",
    "currentPeriodEnd": "2024-02-14",
    "currentPeriodStart": "2024-01-15",
    "customerId": "947a99f7-308c-46a0-b6be-aed82d39a53c",
    "endUserIp": "245.100.1.15",
    "expectedEndingDate": "2025-01-14",
    "lastInvoice": {
      "additionalData": {},
      "amount": 10000,
      "attemptCount": 1,
      "closed": false,
      "creationDate": "2024-01-15T11:59:53.614864+01:00",
      "currency": "EUR",
      "customerId": "947a99f7-308c-46a0-b6be-aed82d39a53c",
      "invoiceId": "e0909ca3-a337-43ce-9769-d65e927b3a47",
      "invoiceItems": [
        {
          "additionalData": {},
          "amount": 10000,
          "creationDate": "2024-01-15T11:59:53.357382+01:00",
          "currency": "EUR",
          "customerId": "947a99f7-308c-46a0-b6be-aed82d39a53c",
          "invoiceId": "e0909ca3-a337-43ce-9769-d65e927b3a47",
          "invoiceItemId": "0c153918-5128-4ecb-8570-7c9f71a500ec",
          "quantity": 1,
          "subscriptionId": "55cb6ba8-3d9b-4bc9-96c9-b478b576d306",
          "totalAmount": 10000,
          "type": "SUBSCRIPTION"
        }
      ],
      "nextTransactionAttempt": "2024-01-18T06:00:04+01:00",
      "paid": false,
      "sddTransactions": [],
      "subscriptionId": "55cb6ba8-3d9b-4bc9-96c9-b478b576d306",
      "transactions": [
        "19b41977-e973-4dd9-846e-5777459196a5"
      ],
      "transfers": [],
      "type": "SUBSCRIPTION"
    },
    "merchantSubscriptionId": "Test refapi gogo",
    "quantity": 1,
    "startingDate": "2024-01-15",
    "status": "FAILURE",
    "subscriptionId": "55cb6ba8-3d9b-4bc9-96c9-b478b576d306",
    "subscriptionModel": {
      "additionalData": {},
      "amount": 10000,
      "creationDate": "2024-01-11T15:02:53.061463+01:00",
      "currency": "EUR",
      "intervalCount": 1,
      "intervalUnit": "MONTH",
      "iterationCount": 12,
      "name": "Test Abo",
      "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
      "subscriptionModelId": "7cd1b504-bed3-4435-84be-2e19f2c8e2f6"
    }
  },
  "requestId": "1c35bbaf-0f37-44e1-a7e5-c3f10be0a9a4"
}

SUBSCRIPTION_UNPAID
When a Subscription is unpaid

SUBSCRIPTION_REACTIVATED
When a Subscription is reactivated
{
  "eventId": "536eb70e-cb79-44a6-be28-4384445583c2",
  "type": "SUBSCRIPTION_REACTIVATED",
  "creationDate": "2024-01-11T15:12:05.092897+01:00",
  "object": {
    "additionalData": {},
    "cardId": "7d5f52b0-ef15-4a04-9c06-c4a9ac76f4bf",
    "creationDate": "2024-01-11T15:11:29.487853+01:00",
    "currentPeriodEnd": "2024-02-10",
    "currentPeriodStart": "2024-01-11",
    "customerId": "dc9623bd-3f3a-4d79-8ae2-0e6b3ebe367d",
    "endUserIp": "245.100.1.15",
    "lastInvoice": {
      "additionalData": {},
      "amount": 10000,
      "attemptCount": 1,
      "closed": true,
      "creationDate": "2024-01-11T15:11:30.057522+01:00",
      "currency": "EUR",
      "customerId": "dc9623bd-3f3a-4d79-8ae2-0e6b3ebe367d",
      "invoiceId": "94185799-1ac6-4206-8df2-006043d0e2a9",
      "invoiceItems": [
        {
          "additionalData": {},
          "amount": 10000,
          "creationDate": "2024-01-11T15:11:29.798622+01:00",
          "currency": "EUR",
          "customerId": "dc9623bd-3f3a-4d79-8ae2-0e6b3ebe367d",
          "invoiceId": "94185799-1ac6-4206-8df2-006043d0e2a9",
          "invoiceItemId": "cd4325ca-4f61-4886-98c6-a524682ee0e2",
          "quantity": 1,
          "subscriptionId": "cb2a2422-2a4d-4818-9647-02107e69f98b",
          "totalAmount": 10000,
          "type": "SUBSCRIPTION"
        }
      ],
      "paid": true,
      "sddTransactions": [],
      "subscriptionId": "cb2a2422-2a4d-4818-9647-02107e69f98b",
      "transactions": [
        "3f462466-4a71-480c-b062-e2023ee99b17"
      ],
      "transfers": [],
      "type": "SUBSCRIPTION"
    },
    "merchantSubscriptionId": "Test refapi gogo",
    "quantity": 1,
    "startingDate": "2024-01-11",
    "status": "ACTIVE",
    "subscriptionId": "cb2a2422-2a4d-4818-9647-02107e69f98b",
    "subscriptionModel": {
      "additionalData": {},
      "amount": 10000,
      "creationDate": "2024-01-11T15:02:53.061463+01:00",
      "currency": "EUR",
      "intervalCount": 1,
      "intervalUnit": "MONTH",
      "iterationCount": 12,
      "name": "Test Abo",
      "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
      "subscriptionModelId": "7cd1b504-bed3-4435-84be-2e19f2c8e2f6"
    }
  },
  "requestId": "69ac4f1d-059b-4065-adc2-90f0eb6a98ab"
}

INVOICEITEM_CREATED
When an invoice item is created
{
  "eventId": "6167d379-fb95-4425-8e9b-af74f4235bfc",
  "type": "INVOICEITEM_CREATED",
  "creationDate": "2024-01-08T12:30:46.157764+01:00",
  "object": {
    "additionalData": {},
    "amount": 10000,
    "creationDate": "2024-01-08T12:30:46.131739+01:00",
    "currency": "EUR",
    "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
    "invoiceItemId": "c911bfdd-3686-4e5b-8abf-d3c44fa369a3",
    "quantity": 3,
    "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
    "totalAmount": 30000,
    "type": "MANUAL"
  },
  "requestId": "d7cd40bd-88de-4956-9c42-baf5a0549f1b"
}

INVOICEITEM_UPDATED
When an invoice item is updated
{
  "eventId": "353dd2fd-934e-4a20-9f12-b47bf213a35c",
  "type": "INVOICEITEM_UPDATED",
  "creationDate": "2024-01-15T10:59:30.750004+01:00",
  "object": {
    "additionalData": {},
    "amount": 10000,
    "creationDate": "2024-01-08T12:44:49.815091+01:00",
    "currency": "EUR",
    "customerId": "33c36fb3-fec8-4930-9cb6-32e2b76d61c9",
    "invoiceItemId": "292c516b-e320-4391-995a-b4a1205e0e47",
    "quantity": 2,
    "subscriptionId": "5b217597-213f-4bf3-b94b-6749e499cf98",
    "totalAmount": 20000,
    "type": "MANUAL"
  },
  "requestId": "9678a75a-aa0c-4023-8d2a-56b56dfeae87",
  "objectBeforeUpdate": {
    "additionalData": {},
    "amount": 10000,
    "creationDate": "2024-01-08T12:44:49.815091+01:00",
    "currency": "EUR",
    "customerId": "33c36fb3-fec8-4930-9cb6-32e2b76d61c9",
    "invoiceItemId": "292c516b-e320-4391-995a-b4a1205e0e47",
    "quantity": 3,
    "subscriptionId": "5b217597-213f-4bf3-b94b-6749e499cf98",
    "totalAmount": 30000,
    "type": "MANUAL"
  }
}

INVOICEITEM_DELETED
When an invoice item is deleted
{
  "eventId": "ae992cbd-d82f-495a-b7b7-4627dc9806e8",
  "type": "INVOICEITEM_DELETED",
  "creationDate": "2024-01-15T11:00:04.748878+01:00",
  "object": {
    "additionalData": {},
    "amount": 10000,
    "creationDate": "2024-01-08T12:44:49.815091+01:00",
    "currency": "EUR",
    "customerId": "33c36fb3-fec8-4930-9cb6-32e2b76d61c9",
    "invoiceItemId": "292c516b-e320-4391-995a-b4a1205e0e47",
    "quantity": 2,
    "subscriptionId": "5b217597-213f-4bf3-b94b-6749e499cf98",
    "totalAmount": 20000,
    "type": "MANUAL"
  },
  "requestId": "fe0e462f-81d9-4640-abbd-ce6c914432b6"
}

INVOICE_CREATED
When an invoice is created
{
  "eventId": "59df2504-3ab7-46c3-8469-0957d579b014",
  "type": "INVOICE_CREATED",
  "creationDate": "2024-01-08T12:31:18.271671+01:00",
  "object": {
    "additionalData": {},
    "amount": 30000,
    "attemptCount": 0,
    "closed": false,
    "creationDate": "2024-01-08T12:31:18.264645+01:00",
    "currency": "EUR",
    "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
    "invoiceId": "6c031228-131c-453a-8dbf-4623a033c01e",
    "invoiceItems": [
      {
        "additionalData": {},
        "amount": 10000,
        "creationDate": "2024-01-08T12:30:46.131739+01:00",
        "currency": "EUR",
        "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
        "invoiceId": "6c031228-131c-453a-8dbf-4623a033c01e",
        "invoiceItemId": "c911bfdd-3686-4e5b-8abf-d3c44fa369a3",
        "quantity": 3,
        "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
        "totalAmount": 30000,
        "type": "MANUAL"
      }
    ],
    "nextTransactionAttempt": "2024-01-09T06:00:04+01:00",
    "paid": false,
    "sddTransactions": [],
    "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
    "transactions": [],
    "transfers": [],
    "type": "MANUAL"
  },
  "requestId": "1b51631e-d6d7-4632-bc8f-c67bd6f52729"
}

INVOICE_UPDATED
When an invoice is updated
{
{
  "eventId": "3c63e5da-1bce-4c5c-9dfc-1a206fda69a7",
  "type": "INVOICE_UPDATED",
  "creationDate": "2024-01-08T12:31:25.469957+01:00",
  "object": {
    "additionalData": {},
    "amount": 30000,
    "attemptCount": 0,
    "closed": false,
    "creationDate": "2024-01-08T12:31:18.264645+01:00",
    "currency": "EUR",
    "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
    "description": "ma description",
    "invoiceId": "6c031228-131c-453a-8dbf-4623a033c01e",
    "invoiceItems": [
      {
        "additionalData": {},
        "amount": 10000,
        "creationDate": "2024-01-08T12:30:46.131739+01:00",
        "currency": "EUR",
        "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
        "invoiceId": "6c031228-131c-453a-8dbf-4623a033c01e",
        "invoiceItemId": "c911bfdd-3686-4e5b-8abf-d3c44fa369a3",
        "quantity": 3,
        "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
        "totalAmount": 30000,
        "type": "MANUAL"
      }
    ],
    "nextTransactionAttempt": "2024-01-09T06:00:04+01:00",
    "paid": false,
    "sddTransactions": [],
    "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
    "transactions": [],
    "transfers": [],
    "type": "MANUAL"
  },
  "requestId": "176cf4e9-4669-473c-a9cb-f102fd6aa2ab",
  "objectBeforeUpdate": {
    "additionalData": {},
    "amount": 30000,
    "attemptCount": 0,
    "closed": false,
    "creationDate": "2024-01-08T12:31:18.264645+01:00",
    "currency": "EUR",
    "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
    "invoiceId": "6c031228-131c-453a-8dbf-4623a033c01e",
    "invoiceItems": [
      {
        "additionalData": {},
        "amount": 10000,
        "creationDate": "2024-01-08T12:30:46.131739+01:00",
        "currency": "EUR",
        "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
        "invoiceId": "6c031228-131c-453a-8dbf-4623a033c01e",
        "invoiceItemId": "c911bfdd-3686-4e5b-8abf-d3c44fa369a3",
        "quantity": 3,
        "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
        "totalAmount": 30000,
        "type": "MANUAL"
      }
    ],
    "nextTransactionAttempt": "2024-01-09T06:00:04+01:00",
    "paid": false,
    "sddTransactions": [],
    "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
    "transactions": [],
    "transfers": [],
    "type": "MANUAL"
  }
}
}

INVOICE_CLOSED
When an invoice is closed
{
  "eventId": "32cc898a-112f-43fd-921e-be8613d85b73",
  "type": "INVOICE_CLOSED",
  "creationDate": "2024-01-08T12:31:33.554755+01:00",
  "object": {
    "additionalData": {},
    "amount": 30000,
    "attemptCount": 0,
    "closed": true,
    "creationDate": "2024-01-08T12:31:18.264645+01:00",
    "currency": "EUR",
    "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
    "description": "ma description",
    "invoiceId": "6c031228-131c-453a-8dbf-4623a033c01e",
    "invoiceItems": [
      {
        "additionalData": {},
        "amount": 10000,
        "creationDate": "2024-01-08T12:30:46.131739+01:00",
        "currency": "EUR",
        "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
        "invoiceId": "6c031228-131c-453a-8dbf-4623a033c01e",
        "invoiceItemId": "c911bfdd-3686-4e5b-8abf-d3c44fa369a3",
        "quantity": 3,
        "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
        "totalAmount": 30000,
        "type": "MANUAL"
      }
    ],
    "nextTransactionAttempt": "2024-01-09T06:00:04+01:00",
    "paid": false,
    "sddTransactions": [],
    "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
    "transactions": [],
    "transfers": [],
    "type": "MANUAL"
  },
  "requestId": "36e1f1c0-b08b-41e1-a35b-bc0942b084f7"
}

INVOICE_REOPEN
When an invoice is reopen
{
  "eventId": "c3e22524-8677-447f-9c70-caee15bdb31a",
  "type": "INVOICE_REOPEN",
  "creationDate": "2024-01-08T12:31:38.069325+01:00",
  "object": {
    "additionalData": {},
    "amount": 30000,
    "attemptCount": 0,
    "closed": false,
    "creationDate": "2024-01-08T12:31:18.264645+01:00",
    "currency": "EUR",
    "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
    "description": "ma description",
    "invoiceId": "6c031228-131c-453a-8dbf-4623a033c01e",
    "invoiceItems": [
      {
        "additionalData": {},
        "amount": 10000,
        "creationDate": "2024-01-08T12:30:46.131739+01:00",
        "currency": "EUR",
        "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
        "invoiceId": "6c031228-131c-453a-8dbf-4623a033c01e",
        "invoiceItemId": "c911bfdd-3686-4e5b-8abf-d3c44fa369a3",
        "quantity": 3,
        "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
        "totalAmount": 30000,
        "type": "MANUAL"
      }
    ],
    "nextTransactionAttempt": "2024-01-09T06:00:04+01:00",
    "paid": false,
    "sddTransactions": [],
    "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
    "transactions": [],
    "transfers": [],
    "type": "MANUAL"
  },
  "requestId": "7ef43ab1-2249-43b2-834e-dcad31d609a5"
}

INVOICE_TRANSACTION_SUCCEEDED
When an invoice transaction succeeded
{
  "eventId": "58b1922a-a959-43c3-aeea-784f6970586c",
  "type": "INVOICE_TRANSACTION_SUCCEEDED",
  "creationDate": "2024-01-08T12:31:48.444350+01:00",
  "object": {
    "additionalData": {},
    "amount": 30000,
    "attemptCount": 0,
    "closed": true,
    "creationDate": "2024-01-08T12:31:18.264645+01:00",
    "currency": "EUR",
    "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
    "description": "ma description",
    "invoiceId": "6c031228-131c-453a-8dbf-4623a033c01e",
    "invoiceItems": [
      {
        "additionalData": {},
        "amount": 10000,
        "creationDate": "2024-01-08T12:30:46.131739+01:00",
        "currency": "EUR",
        "customerId": "06e3819c-9e15-42db-9194-74d5924b53e3",
        "invoiceId": "6c031228-131c-453a-8dbf-4623a033c01e",
        "invoiceItemId": "c911bfdd-3686-4e5b-8abf-d3c44fa369a3",
        "quantity": 3,
        "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
        "totalAmount": 30000,
        "type": "MANUAL"
      }
    ],
    "paid": true,
    "sddTransactions": [],
    "subscriptionId": "a35ba09e-58ea-4d5c-8207-1a5d11f32fd3",
    "transactions": [
      "67cfc05b-d06c-4f2b-8aec-2033e0c61478"
    ],
    "transfers": [],
    "type": "MANUAL"
  },
  "requestId": "01fb7049-bd27-4ec0-846d-605c352bd2f9"
}

INVOICE_TRANSACTION_FAILED
When an invoice transaction failed
{
  "eventId": "23ef2df3-0e6d-4397-b877-aba2acea2ed1",
  "type": "INVOICE_TRANSACTION_FAILED",
  "creationDate": "2024-01-15T11:59:55.647989+01:00",
  "object": {
    "additionalData": {},
    "amount": 10000,
    "attemptCount": 1,
    "closed": false,
    "creationDate": "2024-01-15T11:59:53.614864+01:00",
    "currency": "EUR",
    "customerId": "947a99f7-308c-46a0-b6be-aed82d39a53c",
    "invoiceId": "e0909ca3-a337-43ce-9769-d65e927b3a47",
    "invoiceItems": [
      {
        "additionalData": {},
        "amount": 10000,
        "creationDate": "2024-01-15T11:59:53.357382+01:00",
        "currency": "EUR",
        "customerId": "947a99f7-308c-46a0-b6be-aed82d39a53c",
        "invoiceId": "e0909ca3-a337-43ce-9769-d65e927b3a47",
        "invoiceItemId": "0c153918-5128-4ecb-8570-7c9f71a500ec",
        "quantity": 1,
        "subscriptionId": "55cb6ba8-3d9b-4bc9-96c9-b478b576d306",
        "totalAmount": 10000,
        "type": "SUBSCRIPTION"
      }
    ],
    "nextTransactionAttempt": "2024-01-18T06:00:04+01:00",
    "paid": false,
    "sddTransactions": [],
    "subscriptionId": "55cb6ba8-3d9b-4bc9-96c9-b478b576d306",
    "transactions": [
      "19b41977-e973-4dd9-846e-5777459196a5"
    ],
    "transfers": [],
    "type": "SUBSCRIPTION"
  },
  "requestId": "1c35bbaf-0f37-44e1-a7e5-c3f10be0a9a4"
}
Webhook notifications -Précédent The MANDATE object Prochain- Webhook notifications The TRANSACTION object
CONTENU

Doc Contents

Doc Footnotes

Doc Elements

  • Mentions légales
  • Politique de confidentialité

© 2024 CentralPay