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

Développeurs

  • Folder icon closed Folder open iconHow to use the swagger >
  • Folder icon closed Folder open iconAuthentication 3DS 2.2 >
  • Folder icon closed Folder open iconBankAccount >
  • Folder icon closed Folder open iconCard token
  • Folder icon closed Folder open iconCARD Transaction
    • Transaction
    • Card
    • Credit
    • Disputes
  • Folder icon closed Folder open iconCharge
  • Folder icon closed Folder open iconCustomer >
  • Folder icon closed Folder open iconInstallment Payment >
  • Folder icon closed Folder open iconMerchantInfo >
  • Folder icon closed Folder open iconOnboarding
    • Create Enrollement
    • Complete enrollment
    • Update enrollment
    • Search enrollement
    • Enrollment Details
    • E-money
    • Misc
  • Folder icon closed Folder open iconPayout >
  • Folder icon closed Folder open iconRefund >
  • Folder icon closed Folder open iconPayment Request >
  • Folder icon closed Folder open iconSCT Transaction
    • SCT Transaction
    • SCT Transaction Reversal
    • Bank Reconciliation
    • Bank Reconciliation external
  • Folder icon closed Folder open iconSDD Transaction
    • Mandate
    • SDD Transaction
    • SDD Transaction Reversal
  • Folder icon closed Folder open iconSubscription
    • Subscription Model
    • Subscription
    • Invoice & invoiceItem
  • Folder icon closed Folder open iconTransfer >
  • Folder icon closed Folder open iconTransferReversal >
  • Folder icon closed Folder open iconWallet >
  • Folder icon closed Folder open iconBlacklist >
  • Folder icon closed Folder open iconWhiteList >
  • Folder icon closed Folder open iconWebhook notifications
    • The MERCHANT-ENROLLMENT object
    • The WALLETS object
    • 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)
  • Folder icon closed Folder open iconObject status
    • MERCHANT-ENROLLMENT status
    • TRANSFER status
    • TRANSFER REVERSAL 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
  • Folder icon closed Folder open iconResources 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 PAYOUT object

Estimated reading: 3 minutes
PAYOUT_CREATED
When a payout will be asked.
{
  "eventId": "da2e06e2-c6d5-416e-91b8-3fd398e216aa",
  "type": "PAYOUT_CREATED",
  "creationDate": "2024-01-15T15:05:36.401305+01:00",
  "object": {
    "additionalData": {},
    "amount": 1,
    "automatic": false,
    "creationDate": "2024-01-15T15:05:36.280515+01:00",
    "currency": "EUR",
    "description": "ma description",
    "destinationBankAccountId": "2377f038-d798-42b2-ac46-113105166bd4",
    "expectedArrivalDate": "2024-01-17",
    "fee": 0,
    "movementId": "e1715d31-d403-4ec5-85e4-7e41d0a3c69b",
    "net": 1,
    "payoutId": "d7cd6f62-1e56-4779-a48d-18977cdc643d",
    "payoutReference": "PAYOUT-20240115150536-a00f7a69",
    "payoutType": "SCT",
    "status": "PENDING",
    "walletId": "a00f7a69-b8c3-44b1-a8b2-aa508128b050"
  },
  "requestId": "9d99d793-ef34-4e4f-aefd-627da4b77fbc"
}

PAYOUT_UPDATED
When an ongoing payout has been updated.
{
  "eventId": "e1e8725c-eb98-400f-b3df-8f799a3ba165",
  "type": "PAYOUT_UPDATED",
  "creationDate": "2024-01-15T15:06:51.827583+01:00",
  "object": {
    "additionalData": {},
    "amount": 1,
    "automatic": false,
    "creationDate": "2024-01-15T15:05:36.280515+01:00",
    "currency": "EUR",
    "description": "ma description",
    "destinationBankAccountId": "2377f038-d798-42b2-ac46-113105166bd4",
    "expectedArrivalDate": "2024-01-17",
    "fee": 0,
    "merchantPayoutId": "Up_Test_Doc",
    "movementId": "e1715d31-d403-4ec5-85e4-7e41d0a3c69b",
    "net": 1,
    "payoutId": "d7cd6f62-1e56-4779-a48d-18977cdc643d",
    "payoutReference": "PAYOUT-20240115150536-a00f7a69",
    "payoutType": "SCT",
    "status": "PENDING",
    "walletId": "a00f7a69-b8c3-44b1-a8b2-aa508128b050"
  },
  "requestId": "a39650ab-ddcf-4da7-965e-a0e5d44949ab",
  "objectBeforeUpdate": {
    "additionalData": {},
    "amount": 1,
    "automatic": false,
    "creationDate": "2024-01-15T15:05:36.280515+01:00",
    "currency": "EUR",
    "description": "ma description",
    "destinationBankAccountId": "2377f038-d798-42b2-ac46-113105166bd4",
    "expectedArrivalDate": "2024-01-17",
    "fee": 0,
    "movementId": "e1715d31-d403-4ec5-85e4-7e41d0a3c69b",
    "net": 1,
    "payoutId": "d7cd6f62-1e56-4779-a48d-18977cdc643d",
    "payoutReference": "PAYOUT-20240115150536-a00f7a69",
    "payoutType": "SCT",
    "status": "PENDING",
    "walletId": "a00f7a69-b8c3-44b1-a8b2-aa508128b050"
  }
}

PAYOUT_CANCELED
When an ongoing payout has been canceled.
{
  "eventId": "9630cef4-e1f4-4f5d-811d-e361c4c30c78",
  "type": "PAYOUT_CANCELED",
  "creationDate": "2024-01-08T15:15:55.576036+01:00",
  "object": {
    "additionalData": {},
    "amount": 1,
    "automatic": false,
    "cancelMovementId": "258e7c45-1d4f-48fc-a026-bebb8c10014e",
    "cancellationDate": "2024-01-08T15:15:55.562863+01:00",
    "creationDate": "2024-01-08T15:15:22.435232+01:00",
    "currency": "EUR",
    "description": "ma description",
    "destinationBankAccountId": "d33c400b-9338-4916-a4ca-e8affcfd9ebc",
    "expectedArrivalDate": "2024-01-10",
    "fee": 0,
    "merchantPayoutId": "Up_Test_Doc",
    "movementId": "3d8c5417-2cc9-4c7d-9504-5446cac24e87",
    "net": 1,
    "payoutId": "d68c9005-8954-4d17-96f5-8435a81ace20",
    "payoutReference": "PAYOUT-20240108151522-a00f7a69",
    "payoutType": "SCT",
    "status": "CANCEL",
    "walletId": "a00f7a69-b8c3-44b1-a8b2-aa508128b050"
  },
  "requestId": "7b69dbff-59eb-489f-ac0a-9df343f2bd2a"
}

PAYOUT_PAID
When an ongoing payout has been properly executed.
{
  "eventId": "9a1df5b8-6b24-4274-ad52-1295999f4a6c",
  "type": "PAYOUT_PAID",
  "creationDate": "2024-01-30T11:29:15.965095+01:00",
  "object": {
    "additionalData": {},
    "amount": 100,
    "arrivalDate": "2024-01-30",
    "automatic": true,
    "creationDate": "2024-01-26T16:56:15.147347+01:00",
    "currency": "EUR",
    "destinationBankAccountId": "2377f038-d798-42b2-ac46-113105166bd4",
    "expectedArrivalDate": "2024-01-28",
    "fee": 0,
    "movementId": "b4fafbb7-e73a-4a98-bc6b-f4c7dfee7104",
    "net": 100,
    "payoutId": "f88cab14-b73e-44fc-adcf-9cb1f4f4c43b",
    "payoutReference": "PAYOUT-20240126165615-a00f7a69",
    "payoutType": "SCT",
    "status": "PAID",
    "walletId": "a00f7a69-b8c3-44b1-a8b2-aa508128b050"
  },
  "requestId": "ceffc00e-a708-45fd-bc16-fe0999455e06"
}

PAYOUT_REVERSAL_CREATED
When a payout reversal has been created
Webhook notifications - Previous The PAYMENT REQUEST object Next - Webhook notifications The REFUND object
CONTENU

Doc Contents

Doc Footnotes

Doc Elements

  • Mentions légales
  • Politique de confidentialité

© 2024 CentralPay