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 dossierPayment Request >
  • Icône de dossier fermée Icône d’ouverture de dossierCARD Transaction
    • Card token
    • Transaction
    • Card
    • Credit
    • Disputes
  • Icône de dossier fermée Icône d’ouverture de dossier3DS 2.2 >
  • 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 dossierSCT Transaction
    • SCT Transaction
    • SCT Transaction Reversal
    • Bank Reconciliation
    • Bank Reconciliation external
  • Icône de dossier fermée Icône d’ouverture de dossierCustomer >
  • 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 dossierInstallment Payment >
  • Icône de dossier fermée Icône d’ouverture de dossierRefund >
  • Icône de dossier fermée Icône d’ouverture de dossierBankAccount >
  • 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 dossierWallet >
  • 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 dossierMerchantInfo >
  • 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 dossierPayout >
  • 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 MANDATE object

Temps estimé :5 minutes
MANDATE_CREATED
When a mandate is created
{
  "eventId": "ba739034-7e86-4280-9e19-b8d3be3f683c",
  "type": "MANDATE_CREATED",
  "creationDate": "2024-01-11T12:41:18.209916+01:00",
  "object": {
    "additionalData": {},
    "creationDate": "2024-01-11T12:41:17.403384+01:00",
    "creditorBankAccountId": "d33c400b-9338-4916-a4ca-e8affcfd9ebc",
    "customerId": "78497f3c-baf4-42ae-92e2-cc0cfdd69c2c",
    "debtorBankAccountId": "053c0160-9b62-4424-aaf7-6f74e6d5f7f6",
    "debtorEmail": "gduhamel@centralpay.eu",
    "debtorPhone": "+33600000000",
    "description": "ma description",
    "language": "fre",
    "mandateId": "f4d63345-b84c-47d3-ad65-bd8cb255dc8a",
    "otpExpirationDate": "2024-01-11T12:56:17.403395+01:00",
    "otpExpired": false,
    "paymentType": "PUCT",
    "rum": "GT20KDMVN",
    "sddTransactions": [],
    "status": "PENDING",
    "ultimateCreditorIdentityId": "2df8d9cd-afcc-47dd-8593-560028b66f50"
  },
  "requestId": "800c83a7-d37b-4c33-9907-8874d5c7fa87"
}

MANDATE_SIGNED
When a mandate is signed
{
  "eventId": "d60f35d6-c20a-4317-9ea9-dc90fd4bcd1b",
  "type": "MANDATE_SIGNED",
  "creationDate": "2024-01-11T12:43:07.337387+01:00",
  "object": {
    "additionalData": {},
    "creationDate": "2024-01-11T12:41:17.403384+01:00",
    "creditorBankAccountId": "d33c400b-9338-4916-a4ca-e8affcfd9ebc",
    "customerId": "78497f3c-baf4-42ae-92e2-cc0cfdd69c2c",
    "debtorBankAccountId": "053c0160-9b62-4424-aaf7-6f74e6d5f7f6",
    "debtorEmail": "gduhamel@centralpay.eu",
    "debtorPhone": "+33600000000",
    "description": "ma description",
    "language": "fre",
    "mandateId": "f4d63345-b84c-47d3-ad65-bd8cb255dc8a",
    "otpExpirationDate": "2024-01-11T12:56:17.403395+01:00",
    "otpExpired": false,
    "paymentType": "PUCT",
    "pdfFileId": "7b8d75bd-8f09-400d-af9c-c8787a0858fc",
    "rum": "GT20KDMVN",
    "sddTransactions": [],
    "signatureCity": "TOURS",
    "signatureDate": "2024-01-11T12:43:06.838810+01:00",
    "signatureIpAddress": "245.100.1.15",
    "status": "ACTIVE",
    "ultimateCreditorIdentityId": "2df8d9cd-afcc-47dd-8593-560028b66f50"
  },
  "requestId": "4c40f8ba-94fd-433c-b7eb-71bbad68f51a"
}

MANDATE_OBSOLETED
When a mandate is obsolete
{
  "eventId": "8961d9a3-1b38-4275-9ef7-1c3f9dc993e9",
  "type": "MANDATE_OBSOLETED",
  "creationDate": "2024-01-11T14:34:29.346268+01:00",
  "object": {
    "additionalData": {},
    "creationDate": "2024-01-11T12:41:17.403384+01:00",
    "creditorBankAccountId": "d33c400b-9338-4916-a4ca-e8affcfd9ebc",
    "customerId": "78497f3c-baf4-42ae-92e2-cc0cfdd69c2c",
    "debtorBankAccountId": "053c0160-9b62-4424-aaf7-6f74e6d5f7f6",
    "debtorEmail": "gduhamel@centralpay.eu",
    "debtorPhone": "+3300000000",
    "description": "ma description",
    "language": "fre",
    "mandateId": "f4d63345-b84c-47d3-ad65-bd8cb255dc8a",
    "obsolescenceDate": "2024-01-11T14:34:29.315888+01:00",
    "otpExpirationDate": "2024-01-11T12:56:17.403395+01:00",
    "otpExpired": true,
    "paymentType": "PUCT",
    "pdfFileId": "7b8d75bd-8f09-400d-af9c-c8787a0858fc",
    "rum": "GT20KDMVN",
    "sddTransactions": [
      {
        "additionalData": {},
        "amount": 12,
        "automaticValidation": true,
        "cancellationDate": "2024-01-11T12:46:20.844829+01:00",
        "creationDate": "2024-01-11T12:46:04.839313+01:00",
        "currency": "EUR",
        "endToEndIdentification": "2(OSAI,:P",
        "endUserIp": "245.100.1.15",
        "mandateId": "f4d63345-b84c-47d3-ad65-bd8cb255dc8a",
        "otpExpired": false,
        "payoutCurrency": "EUR",
        "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
        "remittanceInformation": "TEST",
        "requestedCollectionDate": "2024-01-23",
        "sddTransactionId": "a5530b31-ef60-4511-adeb-18843f61ef81",
        "sequenceType": "RCUR",
        "status": "CANCELED",
        "transactionTransfers": [],
        "validationDate": "2024-01-11T12:46:04.839337+01:00",
        "walletId": "a00f7a69-b8c3-44b1-a8b2-aa508128b050"
      },
      {
        "additionalData": {},
        "amount": 12,
        "automaticValidation": true,
        "creationDate": "2024-01-11T12:46:27.952977+01:00",
        "currency": "EUR",
        "endToEndIdentification": "MUPXTJXVK",
        "endUserIp": "245.100.1.15",
        "mandateId": "f4d63345-b84c-47d3-ad65-bd8cb255dc8a",
        "otpExpired": false,
        "payoutCurrency": "EUR",
        "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
        "remittanceInformation": "TEST",
        "requestedCollectionDate": "2024-01-23",
        "sddTransactionId": "3b781c44-ca15-4cbf-a529-f73e9c9fb0cf",
        "sequenceType": "RCUR",
        "status": "ACTIVE",
        "transactionTransfers": [],
        "validationDate": "2024-01-11T12:46:27.953004+01:00",
        "walletId": "a00f7a69-b8c3-44b1-a8b2-aa508128b050"
      },
      {
        "additionalData": {},
        "amount": 12,
        "automaticValidation": true,
        "creationDate": "2024-01-11T12:53:09.201843+01:00",
        "currency": "EUR",
        "endToEndIdentification": "7C28543RZ",
        "endUserIp": "245.100.1.15",
        "mandateId": "f4d63345-b84c-47d3-ad65-bd8cb255dc8a",
        "otpExpired": false,
        "payoutCurrency": "EUR",
        "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
        "remittanceInformation": "TEST",
        "requestedCollectionDate": "2024-01-12",
        "sddTransactionId": "af2e9240-d58f-478d-8e64-d8041ac882e0",
        "sequenceType": "RCUR",
        "status": "ACTIVE",
        "transactionTransfers": [],
        "validationDate": "2024-01-11T12:53:09.201871+01:00",
        "walletId": "a00f7a69-b8c3-44b1-a8b2-aa508128b050"
      },
      {
        "additionalData": {},
        "amount": 12,
        "automaticValidation": false,
        "creationDate": "2024-01-11T13:02:56.373932+01:00",
        "currency": "EUR",
        "endToEndIdentification": "M6C+XE3H5",
        "endUserIp": "245.100.1.15",
        "mandateId": "f4d63345-b84c-47d3-ad65-bd8cb255dc8a",
        "otpExpirationDate": "2024-01-11T13:17:56.374014+01:00",
        "otpExpired": true,
        "payoutCurrency": "EUR",
        "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
        "remittanceInformation": "TEST",
        "requestedCollectionDate": "2024-01-12",
        "sddTransactionId": "96747d6a-e6e3-4d8e-97cf-22f3e407a57e",
        "sequenceType": "RCUR",
        "status": "ACTIVE",
        "transactionTransfers": [],
        "validationDate": "2024-01-11T13:03:17.329335+01:00",
        "walletId": "a00f7a69-b8c3-44b1-a8b2-aa508128b050"
      },
      {
        "additionalData": {},
        "amount": 12,
        "automaticValidation": false,
        "commission": 0,
        "creationDate": "2024-01-11T14:28:41.754664+01:00",
        "currency": "EUR",
        "endToEndIdentification": "84J4ZDNEW",
        "endUserIp": "245.100.1.15",
        "fee": 0,
        "mandateId": "f4d63345-b84c-47d3-ad65-bd8cb255dc8a",
        "movementId": "0a6ffbe5-f067-4c03-9f62-672cb46e312c",
        "otpExpirationDate": "2024-01-11T14:43:46.129105+01:00",
        "otpExpired": false,
        "payoutAmount": 12,
        "payoutCurrency": "EUR",
        "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
        "remittanceInformation": "TEST",
        "requestedCollectionDate": "2024-01-12",
        "sddTransactionId": "f6f5ddbc-1e4c-499c-bee2-0aaa6190a698",
        "sequenceType": "RCUR",
        "status": "CLEARED",
        "transactionTransfers": [],
        "validationDate": "2024-01-11T14:30:56.448356+01:00",
        "walletId": "a00f7a69-b8c3-44b1-a8b2-aa508128b050"
      }
    ],
    "signatureCity": "TOURS",
    "signatureDate": "2024-01-11T12:43:06.838810+01:00",
    "signatureIpAddress": "245.100.1.15",
    "status": "OBSOLETE",
    "ultimateCreditorIdentityId": "2df8d9cd-afcc-47dd-8593-560028b66f50"
  },
  "requestId": "8d56fb75-1ce2-458b-b057-e8722ec22427"
}

MANDATE_RENEWOTP
When a request for an OTP renewal has been sent for an mandate
{
  "eventId": "8f103a2e-8e05-4af7-9b57-a76dc3fe1b48",
  "type": "MANDATE_RENEWOTP",
  "creationDate": "2024-01-11T14:34:56.606277+01:00",
  "object": {
    "additionalData": {},
    "creationDate": "2024-01-11T14:34:36.412083+01:00",
    "creditorBankAccountId": "d33c400b-9338-4916-a4ca-e8affcfd9ebc",
    "customerId": "78497f3c-baf4-42ae-92e2-cc0cfdd69c2c",
    "debtorBankAccountId": "053c0160-9b62-4424-aaf7-6f74e6d5f7f6",
    "debtorEmail": "gduhamel@centralpay.eu",
    "debtorPhone": "+3300000000",
    "description": "ma description",
    "language": "fre",
    "mandateId": "ffc24f5a-f43a-4e9f-b4f9-1d7d1b87a46c",
    "otpExpirationDate": "2024-01-11T14:49:56.133201+01:00",
    "otpExpired": false,
    "paymentType": "PUCT",
    "rum": "YRHCV3K37",
    "sddTransactions": [],
    "status": "PENDING",
    "ultimateCreditorIdentityId": "2df8d9cd-afcc-47dd-8593-560028b66f50"
  },
  "requestId": "a427c5b9-dbf4-4cb2-b9a5-bdf76418901b"
}
Webhook notifications -Précédent The SDD TRANSACTION object Prochain- Webhook notifications The SUBSCRIPTION object
CONTENU

Doc Contents

Doc Footnotes

Doc Elements

  • Mentions légales
  • Politique de confidentialité

© 2024 CentralPay