Menu

Account related hooks

The PAYOUT object

PAYOUT_CREATED

When a payout will be asked, you'll receive :

{
  "payoutId": "a6871574-5970-4af9-a271-f72097397038",
  "creationDate": "2018-05-28T00:06:07.654084+02:00",
  "merchantPayoutId": null,
  "currency": "EUR",
  "amount": 500000,
  "destinationBankAccountId": "f72097397038-b286-421d-836d-e712ccef3faf",
  "description": "Automatic Payout",
  "status": "PENDING",
  "cancellationDate": null,
  "automatic": true,
  "expectedArrivalDate": "2018-06-01",
  "arrivalDate": null,
  "payoutReference": "PAYOUT-1558908389270",
  "walletId": "f72097397038-7696-43ac-9fd4-f72097397038",
  "movementId": "f72097397038-400c-4dc8-bba2-f72097397038",
  "cancelMovementId": null,
  "additionalData": []
​}

PAYOUT_UPDATED

When an ongoing payout has been updated.

PAYOUT_CANCELED

When an ongoing payout has been canceled.

PAYOUT_PAID

When an ongoing payout has been properly executed.

You'll receive :

{
  "payoutId": "a6871574-5970-4af9-a271-f72097397038",
  "creationDate": "2018-05-28T00:06:07.654084+02:00",
  "merchantPayoutId": null,
  "currency": "EUR",
  "amount": 500000,
  "destinationBankAccountId": "f72097397038-b286-421d-836d-e712ccef3faf",
  "description": "Automatic Payout",
  "status": "PAID",
  "cancellationDate": null,
  "automatic": true,
  "expectedArrivalDate": "2018-06-01",
  "arrivalDate": null,
  "payoutReference": "PAYOUT-1558908389270",
  "walletId": "f72097397038-7696-43ac-9fd4-f72097397038",
  "movementId": "f72097397038-400c-4dc8-bba2-f72097397038",
  "cancelMovementId": null,
  "additionalData": []
}

L'objet TRANSFER

TRANSFER_SUCCEEDED

When a transfer succeeded

TRANSFER_UPDATED

When a transfer is updated

TRANSFER_CANCELED

When a transfer is cancelled

L'objet TRANSFER REVERSAL

TRANSFERREVERSAL_SUCCEEDED

When a transfer reversal succeeded

TRANSFERREVERSAL_UPDATED

When a transfer reversal is updated

L'objet DEPOSIT

DEPOSIT_CREATED

When a deposit is created

DEPOSIT_UPDATED

When a deposit is updated

L'objet CUSTOMER

CUSTOMER_CREATED

When a customer is created

CUSTOMER_UPDATED

When a customer is updated

L'objet CARD

CARD_UPDATED

When a card is updated

CARDTOKEN_CREATED

When a card token is created

ONBOARDING API

ONBOARDING_ENROLLMENT_CREATED

When the onboarding request has been accept. You will receive an enrollementId associated to you custom reference.

ONBOARDING_ENROLLMENT_STATUS_UPDATED

An ongoing onboarding has been updated.

ONBOARDING_ADDITIONAL_DOCUMENT_REQUESTED

Additionnal documents or information have been request on one ongoing onboarding.

ONBOARDING_ADDITIONAL_DOCUMENT_UPDATED

Additionnal documents or information have been provided by the account holder in one ongoing onboarding.

ONBOARDING_ENROLLMENT_DOCUMENT_INVALID

Some documents are regarded as invalid by the Centralpay conformity

ONBOARDING_PAYMENT_ACCOUNT_CREATED

The account has been created. You receive those elements 

​{
  "merchantEnrollmentId": "6d82d3056854-c1b2-4dc7-80ad-6d82d3056854",
  "merchantEnrollmentCustomReference": "YOUR REFERENCE",
  "merchantEnrollmentType": "BASIC",
  "merchantId": "fc023b3c-fc77-46f6-a2c4-6d82d3056854",
  "merchantName": "ABCDEFGH",
  "merchantWalletId": "fc023b3c-265d-4e55-a1fa-b964651a",
  "creationDate": "2018-04-17T11:15:03+0200"
}