CentralPay provides a powerful payment processing API, enabling you to process multi-channel transactions at local and/or international levels.
If you have any problems, before do a technical support ticket, you can see in user case in doc-api.
Introduction
CentralPay API is a REST based API that allows a fast and easy integration of the payment forms. The API uses HTTP to transport and return all responses encoded in JSON.
To simplify integration and testing, CentralPay provides a sandbox where you can carry out your tests.
Authorisations are simulated in test mode.
Test and production modes can be active at the same time - each mode having separate set of public keys and two API ENDPOINT.
We ensure that the data created in test mode will never reach your customers nor cost you any money.
API ENDPOINT
The following link is the core link used to test the API: https://test-api.centralpay.net/
Presentation
The purpose of this document is to present the features of the CentralPay REST API.
By using our Tokenization service and Token.js, sensitive data will not be handled on your servers. The service is fully secure and simplifies your obligations to comply with PCI DSS rules.
2 integration methods are available:
- Push & Pay and Smart Form: Ready-to-use services with automation and pre-integrated functions .
- Custom form: A set of tools that allows you to design your own payment form using our Token.js instructions.
Creation of "Customer" and "Card"
- "Customer" and "Card" allow you to perform recurring payments and track multiple transactions associated with a unique customer.
Marketplace & Plateforme features
- Advanced features to manage marketplaces
- Creation of sub-merchants with attributes management
- Access to a back office that allows to perform transactions analysis and export the results
This new architecture of the API allows us to continuously improve the platform's functionalities and offer new features such as:
- More information on cardholders (issuing country, type of card, category, etc.)
- Directing transactions to specific acquiring accounts
- Fraud detection
- Management of recurring payments
- Managing complex business rules
- Automation system with templates and prefifined actions.
Glossary
| cardTokenId | A dematerialized token of the credit card valid for 5 minutes. |
| Transaction | An accepted, refused or abandoned credit card transaction made by a Buyer |
| PoS | A physical, mobile, or online Point of Sale |
| Customer | A consumer or buyer for which means of payment have been registered |
| Card | A Payment Card : VISA, Visa Electron, Mastercard, Maestro, American Express, Diners, ... |
| Contract | A Merchant Contract recognized by the card schemes identifying the transactions perfomed |
| Wallet |
A Wallet storing the monetary value |
Service access
The test platform url is: https://test-api.centralpay.net/v2/rest/
This test platform allows you to test all the services explained within this documentation.
CentralPay will provide you with connection logs to execute the existing functions.
Functions
All functions use the « MIME » type: "application/x-www-form-urlencoded".
Functions use the following methods:
- HTTP POST method for object creation or update
- HTTP GET method for object search
Authentication
CentralPay API uses "HTTP Basic authentication" for authentication. All requests to our API have to be authenticated (provide the username and the password given by the platform) and have to be made over HTTPS.
If you only plan on using Pop-in forms, you only need to use your "API Secret Key".
You can find your Secret Key in your account settings once you log into your account.
HTTP Request
Always use HTTP-Header for serialization formats (user_agent, ...)
The Content-Type (application/x-www-form-urlencoded or multipart/form-data) must be inquire for all the request in the header.
The use of the « Idempotence-Key » field in the HTTP header request allows to authenticate the request that has been sent.
If the same « Idempotence-Key » value is sent again, the request will be considered as already processed and will not be triggered again.
This check allows the merchant to avoid sending duplicate entries.
Note: The key of « Idempotence-Key » is valid for 24 hours.
HTTP Response
In each HTTP Response, the « Request-Id » field is written in the HTTP header.
Note: If you have a specific request to be sent via CentralPay REST API, please provide us with this information.
Test tools
All functions described in the documentation can be executed with a HTML form (See examples provided in the documentation)
In order to test CentralPay services, different tools are available to check the behaviour of the API (example: Firefox Rest Easy plugin).
Searching methods
Searching methods are the same for all objects.
Requests can use either common or specific parameters.
HTTP Request
GET https://test-api.centralpay.net/v2/rest/<type_objet>/<id_objet>
HTTP Response
OBJ Json <type_objet> type
Retrieve a single object
This function allows you to retrieve objects with the object ID.
| <id_objet> UUID (36) |
CentralPay object ID Required: yes Validation: UUID |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/<type_objet>/<id_objet>
HTTP Response
OBJ Json <type_objet> type
Retrieve multiple objects
This function allows you to search objects with multiple criteria.
Note: The field « totalCount » displays the total number of objects found from the search request.
Common parameters
| before Date ISO 8601 |
Before this date (included) Required: no Note: Included |
| after Date ISO 8601 |
After this date (included) Required: no Note: Included |
| limit Integer |
Maximum number of T Required: no Validation: > 0 and <= 100 Note: 10 by default |
| page Integer |
Page number Required: no Validation: > 0 Note: 1st page by default |
Hooks & Events
Webhook are set to receive Event notification when an action took place.
For example creation of new successful Transaction will result in TRANSACTION_CAPTURED event.
Each event belongs to an existing object:
- TRANSACTION_XXXX belongs to the TRANSACTION object.
- REFUND_XXXX belongs to the REFUND object.
- CUSTOMER_XXXX belongs to the CUSTOMER object.
For each event triggered by a change in the objet, you receive an update posted in JSON format.
You can simply create a page on your website and submit the appropriate URL of that page on your account. Then, each time a new event is created we will call your page back with information about the event.
When a new event is created we will POST to each configured webhook URL. Event data are encoded as JSON and are sent in request body.
To acknowledge receipt of a webhook, your endpoint should return a 2xx HTTP status code. Any other information returned in the request headers or request body is ignored. All response codes outside this range, including 3xx codes, will indicate to CentralPay that you did not receive the webhook. This means that a URL redirection or a "Not Modified" response will be treated as a failure. If your endpoint returns another value that a 2xx status code, we will send it again every 5 minutes during 2 hours.
Event Service
« Event» is a service used in the hook mecanism.
|
eventId String (36) |
Event identifier Note: UUID Format |
| type String |
Event type are always linked to an existing object
Note: For a list of hooks you can see it here |
| creationDate String |
Creation date Note: ISO 8601 |
| requestId String (36) |
Request Identifier
Note: UUID Format Request-Id HTTP Response header
|
| object |
Event Object Note: Depends of event type, for example it will be a JSON "transaction object" if the event type is "TRANSACTION_CAPTURED" |
Webhook notifications
The Webhook notifications is used to generate "events". These events are addressed to your information system according to the object status with which they interact.
ENROLLMENT_CREATED hook, you'll receive :
{
"enrollmentId": "88b17187-7f3e-40eb-84ca-9888dfa808fb",
"creationDate": "2021-09-15T15:23:50.312454+02:00",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"pointOfSaleId": "fb06bc29-f64a-40c0-b391-972b37f11240",
"additionalData": [],
"acsURL": "https://test-threedsecure.centralpay.net/acs",
"amount": 126326,
"currency": "EUR",
"first6": "400000",
"last4": "0002",
"merchantCountry": "FRA",
"merchantName": "POS Démo 3DS1",
"merchantTransactionIdentifier": "210915152350055",
"merchantURL": "https://test-POS.com",
"paReq": "eJxVUmty2jAQvorH/40ejjFm1sqQOJ3yww1T4AAaaQvOYJtYooHeqOfoxboipmk0o9F++95vBffn9hD9xME1fVfGYsLjCDvT26bblfF28yWZxZHzurP60HdYxhd08b2CzX5ArNZoTgMqqNE5vcOosWWMaSa0yXViihlP7qyVSVEImehMcPtjyk1hp7GC1eI7vioYKysqPJHAbpAyDmavO69Am9eH5Td1V+RcCGAjhBaHZaV4OKR9R9DpFtXqeR1Vf363fZRWa7JdlWD6U+eHi5IZB3YDcBoOau/90c0Z8+h8QsET07fAggXYRxurU5AcZTo3VtUvT2/PmydRb7aX+tf2ra62Yvm42NEtgQUPsNqjklwKXogsEulcpvNQ+6oH3YYWlJDTVE5pqncIx1Bl8dn2vw6I74H2c1FFPqM5bgjwfKT1kAeR+E8Gi87QFOPzMcLj18Cr8cTZrUORyTTjMs8DxVdLyNkExlJeXJMGACzEsnF7bFw8SZ8+xF9OwcCe",
"status": "SUCCESS"
}The 3-D SECURE object
ENROLLMENT_CREATED
When a call to create a 3D-Secure is created
When a call to create a 3D-Secure is created
ENROLLMENT_CREATED hook, you'll receive :
{
"enrollmentId": "88b17187-7f3e-40eb-84ca-9888dfa808fb",
"creationDate": "2021-09-15T15:23:50.312454+02:00",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"pointOfSaleId": "fb06bc29-f64a-40c0-b391-972b37f11240",
"additionalData": [],
"acsURL": "https://test-threedsecure.centralpay.net/acs",
"amount": 126326,
"currency": "EUR",
"first6": "400000",
"last4": "0002",
"merchantCountry": "FRA",
"merchantName": "POS Démo 3DS1",
"merchantTransactionIdentifier": "210915152350055",
"merchantURL": "https://test-POS.com",
"paReq": "eJxVUmty2jAQvorH/40ejjFm1sqQOJ3yww1T4AAaaQvOYJtYooHeqOfoxboipmk0o9F++95vBffn9hD9xME1fVfGYsLjCDvT26bblfF28yWZxZHzurP60HdYxhd08b2CzX5ArNZoTgMqqNE5vcOosWWMaSa0yXViihlP7qyVSVEImehMcPtjyk1hp7GC1eI7vioYKysqPJHAbpAyDmavO69Am9eH5Td1V+RcCGAjhBaHZaV4OKR9R9DpFtXqeR1Vf363fZRWa7JdlWD6U+eHi5IZB3YDcBoOau/90c0Z8+h8QsET07fAggXYRxurU5AcZTo3VtUvT2/PmydRb7aX+tf2ra62Yvm42NEtgQUPsNqjklwKXogsEulcpvNQ+6oH3YYWlJDTVE5pqncIx1Bl8dn2vw6I74H2c1FFPqM5bgjwfKT1kAeR+E8Gi87QFOPzMcLj18Cr8cTZrUORyTTjMs8DxVdLyNkExlJeXJMGACzEsnF7bFw8SZ8+xF9OwcCe",
"status": "SUCCESS"
}CARD_UPDATED hook, you'll received
{
"cardId": "12384636-285e-49a1-8810-e2b2746d6d91",
"creationDate": "2021-02-09T09:51:08.560651+01:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": true,
"additionalData": []
}CARDTOKEN_CREATED hook :
{
"cardTokenId": "456beed2-5317-41bd-8f3d-d86ba0f0e0ad",
"creationDate": "2021-09-08T09:39:26.955727+02:00",
"card": {
"cardId": "c0acdee8-2e56-4f47-a80f-e47eec65b80b",
"creationDate": "2021-09-08T09:39:26.955727+02:00",
"customerId": null,
"cardTokenId": "456beed2-5317-41bd-8f3d-d86ba0f0e0ad",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": []
},
"endUserIp": "91.229.230.41",
"status": "UNUSED"
}The CARD object
CARD_UPDATED
When a card is updated
When a card is updated
CARDTOKEN_CREATED
When a card token is created
When a card token is created
CARD_UPDATED hook, you'll received
{
"cardId": "12384636-285e-49a1-8810-e2b2746d6d91",
"creationDate": "2021-02-09T09:51:08.560651+01:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": true,
"additionalData": []
}CARDTOKEN_CREATED hook :
{
"cardTokenId": "456beed2-5317-41bd-8f3d-d86ba0f0e0ad",
"creationDate": "2021-09-08T09:39:26.955727+02:00",
"card": {
"cardId": "c0acdee8-2e56-4f47-a80f-e47eec65b80b",
"creationDate": "2021-09-08T09:39:26.955727+02:00",
"customerId": null,
"cardTokenId": "456beed2-5317-41bd-8f3d-d86ba0f0e0ad",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": []
},
"endUserIp": "91.229.230.41",
"status": "UNUSED"
}CREDIT_CREATED hook :
{
"creditId": "07619c2e-08d9-4a35-90dc-30104f211f11",
"creationDate": "2021-06-30T10:24:20.583553+02:00",
"merchantCreditId": "MCID-01",
"status": "UNCLEARED",
"description": null,
"currency": "EUR",
"amount": 1000,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "a7b83a0f-dcd4-4451-a10c-debcc4a47faa",
"creationDate": "2021-06-30T10:24:20.847734+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "e67c16dbf2dfd0d7c712755f6ac52d2a6653c6f7",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": []
},
"receiptEmail": null,
"endUserIp": null,
"payoutCurrency": "EUR",
"payoutAmount": 1650,
"commission": 150,
"fee": 500,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": "MANDATORY",
"lastName": "MANDATORY",
"phone": null,
"postalCode": null
},
"cardPresent": [],
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "d01bc23a-0767-42ad-bb9e-9fd4a51e737b",
"cancelMovementId": null,
"additionalData": {
"city": "Tours"
}
}CREDIT_CANCELED hook :
{
"creditId": "e3176d6e-466e-4e01-93f9-fb8a06926cd3",
"creationDate": "2021-09-08T09:39:27.242012+02:00",
"merchantCreditId": "MCID-01",
"status": "CANCELED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "c0acdee8-2e56-4f47-a80f-e47eec65b80b",
"creationDate": "2021-09-08T09:39:26.955727+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": []
},
"receiptEmail": null,
"endUserIp": null,
"payoutCurrency": "EUR",
"payoutAmount": 615,
"commission": 15,
"fee": 500,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": "MANDATORY",
"lastName": "MANDATORY",
"phone": null,
"postalCode": null
},
"cardPresent": [],
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": "2021-09-08T09:39:27.970559+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "3a65f37c-3dfc-4fde-8c89-c812459e4678",
"cancelMovementId": "5e8fa57b-46d7-4542-8ea0-598bb7aa5725",
"additionalData": {
"key1": "value1",
"test": "test"
}
}CREDIT_UPDATED hook :
{
"creditId": "2042fb08-67ce-4ffd-ba6e-5443ea6d6936",
"creationDate": "2021-02-09T11:01:47.423145+01:00",
"merchantCreditId": "MCID-01",
"status": "CLEARED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "c6302649-c13e-4ba6-8769-d11f906870d1",
"creationDate": "2021-02-09T11:01:47.615788+01:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "e67c16dbf2dfd0d7c712755f6ac52d2a6653c6f7",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": []
},
"receiptEmail": null,
"endUserIp": null,
"payoutCurrency": "EUR",
"payoutAmount": 130,
"commission": 0,
"fee": 30,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": "MANDATORY",
"lastName": "MANDATORY",
"phone": null,
"postalCode": null
},
"cardPresent": [],
"transactionTransfers": [],
"clearingDate": "2021-02-10",
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "7245c550-07f6-4303-af10-70ddc0e9e2f1",
"cancelMovementId": null,
"additionalData": {
"city": "Tours",
"address": "16JeanJau"
}
}The CREDIT object
CREDIT_CREATED
When a credit is created
When a credit is created
CREDIT_CANCELED
When a credit is cancelled
When a credit is cancelled
CREDIT_UPDATED
When a credit is updated
When a credit is updated
CREDIT_CREATED hook :
{
"creditId": "07619c2e-08d9-4a35-90dc-30104f211f11",
"creationDate": "2021-06-30T10:24:20.583553+02:00",
"merchantCreditId": "MCID-01",
"status": "UNCLEARED",
"description": null,
"currency": "EUR",
"amount": 1000,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "a7b83a0f-dcd4-4451-a10c-debcc4a47faa",
"creationDate": "2021-06-30T10:24:20.847734+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "e67c16dbf2dfd0d7c712755f6ac52d2a6653c6f7",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": []
},
"receiptEmail": null,
"endUserIp": null,
"payoutCurrency": "EUR",
"payoutAmount": 1650,
"commission": 150,
"fee": 500,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": "MANDATORY",
"lastName": "MANDATORY",
"phone": null,
"postalCode": null
},
"cardPresent": [],
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "d01bc23a-0767-42ad-bb9e-9fd4a51e737b",
"cancelMovementId": null,
"additionalData": {
"city": "Tours"
}
}CREDIT_CANCELED hook :
{
"creditId": "e3176d6e-466e-4e01-93f9-fb8a06926cd3",
"creationDate": "2021-09-08T09:39:27.242012+02:00",
"merchantCreditId": "MCID-01",
"status": "CANCELED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "c0acdee8-2e56-4f47-a80f-e47eec65b80b",
"creationDate": "2021-09-08T09:39:26.955727+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": []
},
"receiptEmail": null,
"endUserIp": null,
"payoutCurrency": "EUR",
"payoutAmount": 615,
"commission": 15,
"fee": 500,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": "MANDATORY",
"lastName": "MANDATORY",
"phone": null,
"postalCode": null
},
"cardPresent": [],
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": "2021-09-08T09:39:27.970559+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "3a65f37c-3dfc-4fde-8c89-c812459e4678",
"cancelMovementId": "5e8fa57b-46d7-4542-8ea0-598bb7aa5725",
"additionalData": {
"key1": "value1",
"test": "test"
}
}CREDIT_UPDATED hook :
{
"creditId": "2042fb08-67ce-4ffd-ba6e-5443ea6d6936",
"creationDate": "2021-02-09T11:01:47.423145+01:00",
"merchantCreditId": "MCID-01",
"status": "CLEARED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "c6302649-c13e-4ba6-8769-d11f906870d1",
"creationDate": "2021-02-09T11:01:47.615788+01:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "e67c16dbf2dfd0d7c712755f6ac52d2a6653c6f7",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": []
},
"receiptEmail": null,
"endUserIp": null,
"payoutCurrency": "EUR",
"payoutAmount": 130,
"commission": 0,
"fee": 30,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": "MANDATORY",
"lastName": "MANDATORY",
"phone": null,
"postalCode": null
},
"cardPresent": [],
"transactionTransfers": [],
"clearingDate": "2021-02-10",
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "7245c550-07f6-4303-af10-70ddc0e9e2f1",
"cancelMovementId": null,
"additionalData": {
"city": "Tours",
"address": "16JeanJau"
}
}DEPOSIT_CREATED hook :
{
"depositId": "f63ea558-6e50-4dba-a7e7-eb8676144ea0",
"creationDate": "2020-11-16T10:55:11.163214+01:00",
"description": null,
"amount": 1500000,
"currency": "EUR",
"sepaReference": null,
"movementId": "9612fe9b-e226-4e9f-a0dc-8539a24ba748",
"merchantId": "0055bff7-566c-4688-818c-85caf3601785",
"destinationBankAccountId": "d9952704-5054-47fc-a068-c6865a9d00fd"
}
The DEPOSIT object
DEPOSIT_CREATED
When a deposit is created
When a deposit is created
DEPOSIT_UPDATED
When a deposit is updated
When a deposit is updated
DEPOSIT_CREATED hook :
{
"depositId": "f63ea558-6e50-4dba-a7e7-eb8676144ea0",
"creationDate": "2020-11-16T10:55:11.163214+01:00",
"description": null,
"amount": 1500000,
"currency": "EUR",
"sepaReference": null,
"movementId": "9612fe9b-e226-4e9f-a0dc-8539a24ba748",
"merchantId": "0055bff7-566c-4688-818c-85caf3601785",
"destinationBankAccountId": "d9952704-5054-47fc-a068-c6865a9d00fd"
}
DISPUTE_UPDATED
{
"disputeId": "2ee88737-fc1c-4318-bbbb-21c66e3bd2f1",
"creationDate": "2021-02-15T09:35:32.114857+01:00",
"transactionId": "eef29853-02d8-4976-92ca-51149c828f6a",
"disputeDate": "2019-12-12",
"merchantDisputeId": null,
"description": "ma description",
"amount": 10,
"currency": "EUR",
"reason": "FRAUDULENT",
"status": "CHARGEBACK_WON",
"fee": 30,
"chargebackCode": null,
"evidencesDeadline": null,
"movementId": "ab0e84ca-0084-4cce-a237-650952f2001f",
"wonMovementId": "db42cfe8-a7f1-4b8c-9b0e-f999ced915cd",
"additionalData": []
}
The DISPUTE object
DISPUTE_UPDATED
When a dispute is created
When a dispute is created
RETRIEVAL_NOTICED
When a request for information is sent to you
When a request for information is sent to you
RETRIEVAL_CLOSE
When a request for information is correctly satisfied
When a request for information is correctly satisfied
CHARGEBACK_NOTICED
When an unpaid is addressed to you by a customer
When an unpaid is addressed to you by a customer
CHARGEBACK_WON
When an unpaid is rejected
When an unpaid is rejected
CHARGEBACK_LOST
When an unpaid is confirmed
When an unpaid is confirmed
DISPUTE_UPDATED
{
"disputeId": "2ee88737-fc1c-4318-bbbb-21c66e3bd2f1",
"creationDate": "2021-02-15T09:35:32.114857+01:00",
"transactionId": "eef29853-02d8-4976-92ca-51149c828f6a",
"disputeDate": "2019-12-12",
"merchantDisputeId": null,
"description": "ma description",
"amount": 10,
"currency": "EUR",
"reason": "FRAUDULENT",
"status": "CHARGEBACK_WON",
"fee": 30,
"chargebackCode": null,
"evidencesDeadline": null,
"movementId": "ab0e84ca-0084-4cce-a237-650952f2001f",
"wonMovementId": "db42cfe8-a7f1-4b8c-9b0e-f999ced915cd",
"additionalData": []
}
INSTALLMENTPAYMENT_CREATED
{
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"creationDate": "2021-09-13T14:32:11.649077+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"cardId": null,
"paymentRequestBreakdownId": "cae61277-18fa-4847-bf6a-ad2b8f54e7d9",
"paymentRequestId": "8703d6a2-3c05-4340-9227-fe962ffd2620",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"depositStartingDate": null,
"startingDate": "2021-09-13",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": null,
"endUserIp": "91.229.230.41",
"endUserLanguage": null,
"amount": 1235835,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 2,
"iterationCount": 2,
"status": "ACTIVE",
"endToEndIdentification": null,
"remittanceInformation": "49C8A75C41DE",
"installments": [
{
"installmentId": "ed9db4e8-f55c-4de2-9c24-be268402cd5b",
"creationDate": "2021-09-13T14:32:11.648281+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617918,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"af37becb-ea9e-49dc-9759-bf923d2825a1"
]
},
{
"installmentId": "95a48d1a-6117-4898-9c35-92d027b6127c",
"creationDate": "2021-09-13T14:32:11.649033+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617917,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-27T08:00+02:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}
INSTALLMENTPAYMENT_FAILED
{
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"creationDate": "2021-09-03T10:38:16.811541+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"cardId": "d3143e10-9660-48bb-b6a6-b2e1100ecf6f",
"paymentRequestBreakdownId": "dfd3f740-0366-411b-80ef-48ee7e387f22",
"paymentRequestId": "4d350f3d-37fb-4887-b45b-b0d256d278c8",
"mandateId": null,
"depositStartingDate": "2021-09-03",
"startingDate": "2021-09-17",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": "testInstall",
"endUserIp": "91.229.230.41",
"endUserLanguage": "fre",
"amount": 550000,
"depositAmount": 50000,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 2,
"iterationCount": 10,
"status": "UNPAID",
"endToEndIdentification": null,
"remittanceInformation": null,
"installments": [
{
"installmentId": "1a123952-cc30-47c2-8f2e-1b6182fd25a6",
"creationDate": "2021-09-03T10:38:16.809510+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 1,
"paid": false,
"type": "DEPOSIT",
"nextTransactionAttempt": "2021-09-03T08:00+02:00",
"transactions": [
"91c604d8-a63c-483c-87aa-f03181a634b5"
],
"sddTransactions": []
},
{
"installmentId": "28754849-1b22-491b-bc15-7f38d0c9a988",
"creationDate": "2021-09-03T10:38:16.810529+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-17T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "666f0320-7766-464e-949b-e7ce9997a173",
"creationDate": "2021-09-03T10:38:16.810564+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-01T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "1b88ddcc-5c9e-4b43-a3cc-6792d9162ea4",
"creationDate": "2021-09-03T10:38:16.810582+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-15T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "1f25ec3c-d846-4f9c-80e9-c5b86adef8eb",
"creationDate": "2021-09-03T10:38:16.810595+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-29T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "9d206cee-565d-4181-9987-d65f82a0ffaa",
"creationDate": "2021-09-03T10:38:16.810609+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-11-12T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "4fecfcf0-7b4a-4241-a716-a56bc840bd20",
"creationDate": "2021-09-03T10:38:16.810621+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-11-26T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "703d1c4f-f1a6-4e30-9a8c-83cd9916f42e",
"creationDate": "2021-09-03T10:38:16.810634+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-12-10T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "4c98d99f-f321-43bf-a37e-801a85d03200",
"creationDate": "2021-09-03T10:38:16.810646+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-12-24T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "893c6120-7f51-4616-9f18-7880c76747fb",
"creationDate": "2021-09-03T10:38:16.810658+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2022-01-07T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "8bf4e146-8737-4260-84f5-1a95653d1e24",
"creationDate": "2021-09-03T10:38:16.810671+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2022-01-21T07:00+01:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}
INSTALLMENTPAYMENT_UPDATED
{
"installmentPaymentId": "2351a31a-3c84-4681-8a83-cd5f260d78ab",
"creationDate": "2021-09-09T09:49:00.941254+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "3036e768-071e-4119-abd8-57d50581c371",
"cardId": "06a45250-8e22-41aa-a97a-284c225419a5",
"paymentRequestBreakdownId": "6e5ba89d-d275-4174-8cfd-9418dc6bd303",
"paymentRequestId": "c796df20-258e-4645-90d8-aad70349c547",
"mandateId": "f65ea8ce-5171-4c1e-8b8f-69654e0acf4e",
"depositStartingDate": null,
"startingDate": "2021-09-09",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": null,
"endUserIp": "92.154.127.221",
"endUserLanguage": null,
"amount": 300,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 1,
"iterationCount": 3,
"status": "ACTIVE",
"endToEndIdentification": null,
"remittanceInformation": "BCDEB2DEEB6E",
"installments": [
{
"installmentId": "ee6f170c-710a-4a9d-a79f-c163de336530",
"creationDate": "2021-09-09T09:49:00.940625+02:00",
"installmentPaymentId": "2351a31a-3c84-4681-8a83-cd5f260d78ab",
"customerId": "3036e768-071e-4119-abd8-57d50581c371",
"mandateId": "f65ea8ce-5171-4c1e-8b8f-69654e0acf4e",
"amount": 100,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"116adfc1-7996-4bd7-9678-d4a2b1a77762"
]
},
{
"installmentId": "26d5e572-4740-4c30-bbb8-5d2251e13e1d",
"creationDate": "2021-09-09T09:49:00.941206+02:00",
"installmentPaymentId": "2351a31a-3c84-4681-8a83-cd5f260d78ab",
"customerId": "3036e768-071e-4119-abd8-57d50581c371",
"mandateId": "f65ea8ce-5171-4c1e-8b8f-69654e0acf4e",
"amount": 100,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-16T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "afe58afd-712d-415f-adf5-70e980c73b57",
"creationDate": "2021-09-09T09:49:00.941224+02:00",
"installmentPaymentId": "2351a31a-3c84-4681-8a83-cd5f260d78ab",
"customerId": "3036e768-071e-4119-abd8-57d50581c371",
"mandateId": "f65ea8ce-5171-4c1e-8b8f-69654e0acf4e",
"amount": 100,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-23T08:00+02:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}
INSTALLMENTPAYMENT_CANCELED
{
"installmentPaymentId": "23717917-f981-46f1-91fe-51fddf012dc1",
"creationDate": "2021-09-08T09:40:38.410270+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"cardId": "18185a9a-865d-4871-ae9b-fdc3f0eb7d33",
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"mandateId": null,
"depositStartingDate": null,
"startingDate": "2021-09-08",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": "MIP_001",
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"amount": 1000,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 2,
"status": "CANCELED",
"endToEndIdentification": null,
"remittanceInformation": null,
"installments": [
{
"installmentId": "48e602fc-4698-4c88-bcdf-37354a4ee809",
"creationDate": "2021-09-08T09:40:38.410203+02:00",
"installmentPaymentId": "23717917-f981-46f1-91fe-51fddf012dc1",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"mandateId": null,
"amount": 500,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [
"d93c6657-e449-4cb6-8da9-b3610b6c93ca"
],
"sddTransactions": []
},
{
"installmentId": "794e76d0-26b5-4cab-a624-9ef1401fe1dd",
"creationDate": "2021-09-08T09:40:38.410238+02:00",
"installmentPaymentId": "23717917-f981-46f1-91fe-51fddf012dc1",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"mandateId": null,
"amount": 500,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": []
}
],
"additionalData": {
"Key2": "val2",
"Key1": "val1"
}
}
INSTALLMENTPAYMENT_PAID
{
"installmentPaymentId": "f922a524-c1c3-4e8f-a596-39147d1955fa",
"creationDate": "2021-09-09T10:08:02.708221+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "344eec6c-160c-4a0f-bb90-23ea81be14dc",
"cardId": null,
"paymentRequestBreakdownId": "86b86174-b3c8-4217-8a51-a5fa04cef18b",
"paymentRequestId": "cb740834-336a-4ceb-b6c1-9432e376baae",
"mandateId": "e03124c5-69e4-4f0e-86c5-df4b0ce79df9",
"depositStartingDate": null,
"startingDate": "2021-09-09",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": null,
"endUserIp": "92.154.127.221",
"endUserLanguage": null,
"amount": 5000,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 1,
"iterationCount": 2,
"status": "PAID",
"endToEndIdentification": null,
"remittanceInformation": "67E0223B52BB",
"installments": [
{
"installmentId": "91684a2d-48c7-423b-a2d8-5d94a7ab8ac1",
"creationDate": "2021-09-09T10:08:02.707421+02:00",
"installmentPaymentId": "f922a524-c1c3-4e8f-a596-39147d1955fa",
"customerId": "344eec6c-160c-4a0f-bb90-23ea81be14dc",
"mandateId": "e03124c5-69e4-4f0e-86c5-df4b0ce79df9",
"amount": 2500,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"e0eac3f2-67a9-4761-bb41-5b5165bf6f6d"
]
},
{
"installmentId": "7a526988-51fa-442b-ba55-6a13c3b85b6b",
"creationDate": "2021-09-09T10:08:02.708182+02:00",
"installmentPaymentId": "f922a524-c1c3-4e8f-a596-39147d1955fa",
"customerId": "344eec6c-160c-4a0f-bb90-23ea81be14dc",
"mandateId": "e03124c5-69e4-4f0e-86c5-df4b0ce79df9",
"amount": 2500,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"3af0aca0-a112-4f2e-a688-6cc54957d0af"
]
}
],
"additionalData": []
}
INSTALLMENTPAYMENT_UNPAID
{
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"creationDate": "2021-09-03T10:38:16.811541+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"cardId": "d3143e10-9660-48bb-b6a6-b2e1100ecf6f",
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"mandateId": null,
"depositStartingDate": "2021-09-03",
"startingDate": "2021-09-17",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": "testInstall",
"endUserIp": "91.229.230.41",
"endUserLanguage": "fre",
"amount": 550000,
"depositAmount": 50000,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 2,
"iterationCount": 10,
"status": "UNPAID",
"endToEndIdentification": null,
"remittanceInformation": null,
"installments": [
{
"installmentId": "1a123952-cc30-47c2-8f2e-1b6182fd25a6",
"creationDate": "2021-09-03T10:38:16.809510+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 1,
"paid": false,
"type": "DEPOSIT",
"nextTransactionAttempt": "2021-09-03T08:00+02:00",
"transactions": [
"91c604d8-a63c-483c-87aa-f03181a634b5"
],
"sddTransactions": []
},
{
"installmentId": "28754849-1b22-491b-bc15-7f38d0c9a988",
"creationDate": "2021-09-03T10:38:16.810529+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-17T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "666f0320-7766-464e-949b-e7ce9997a173",
"creationDate": "2021-09-03T10:38:16.810564+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-01T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "1b88ddcc-5c9e-4b43-a3cc-6792d9162ea4",
"creationDate": "2021-09-03T10:38:16.810582+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-15T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "1f25ec3c-d846-4f9c-80e9-c5b86adef8eb",
"creationDate": "2021-09-03T10:38:16.810595+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-29T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "9d206cee-565d-4181-9987-d65f82a0ffaa",
"creationDate": "2021-09-03T10:38:16.810609+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-11-12T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "4fecfcf0-7b4a-4241-a716-a56bc840bd20",
"creationDate": "2021-09-03T10:38:16.810621+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-11-26T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "703d1c4f-f1a6-4e30-9a8c-83cd9916f42e",
"creationDate": "2021-09-03T10:38:16.810634+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-12-10T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "4c98d99f-f321-43bf-a37e-801a85d03200",
"creationDate": "2021-09-03T10:38:16.810646+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-12-24T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "893c6120-7f51-4616-9f18-7880c76747fb",
"creationDate": "2021-09-03T10:38:16.810658+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2022-01-07T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "8bf4e146-8737-4260-84f5-1a95653d1e24",
"creationDate": "2021-09-03T10:38:16.810671+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2022-01-21T07:00+01:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}
INSTALLMENT_TRANSACTION_SUCCEEDED
{
"installmentId": "7a526988-51fa-442b-ba55-6a13c3b85b6b",
"creationDate": "2021-09-09T10:08:02.708182+02:00",
"installmentPaymentId": "f922a524-c1c3-4e8f-a596-39147d1955fa",
"customerId": "344eec6c-160c-4a0f-bb90-23ea81be14dc",
"mandateId": "e03124c5-69e4-4f0e-86c5-df4b0ce79df9",
"amount": 2500,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"3af0aca0-a112-4f2e-a688-6cc54957d0af"
]
}
INSTALLMENT_TRANSACTION_FAILED
{
"installmentId": "1a123952-cc30-47c2-8f2e-1b6182fd25a6",
"creationDate": "2021-09-03T10:38:16.809510+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 1,
"paid": false,
"type": "DEPOSIT",
"nextTransactionAttempt": "2021-09-03T08:00+02:00",
"transactions": [
"91c604d8-a63c-483c-87aa-f03181a634b5"
],
"sddTransactions": []
}
The INSTALLMENT object
INSTALLMENTPAYMENT_CREATED
When an installment is created
When an installment is created
INSTALLMENTPAYMENT_FAILED
When an installment failed
When an installment failed
INSTALLMENTPAYMENT_UPDATED
When an installment is updated
When an installment is updated
INSTALLMENTPAYMENT_CANCELED
When an installment is cancelled
When an installment is cancelled
INSTALLMENTPAYMENT_ACTIVATED
When an installment is activated
When an installment is activated
INSTALLMENTPAYMENT_FAILURE
When an installment failed to be paid
When an installment failed to be paid
INSTALLMENTPAYMENT_PAID
When an installment is paid
When an installment is paid
INSTALLMENTPAYMENT_UNPAID
When an installment is unpaid
When an installment is unpaid
INSTALLMENT_TRANSACTION
When a transaction of an installment is make
When a transaction of an installment is make
INSTALLMENTPAYMENT_CREATED
{
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"creationDate": "2021-09-13T14:32:11.649077+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"cardId": null,
"paymentRequestBreakdownId": "cae61277-18fa-4847-bf6a-ad2b8f54e7d9",
"paymentRequestId": "8703d6a2-3c05-4340-9227-fe962ffd2620",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"depositStartingDate": null,
"startingDate": "2021-09-13",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": null,
"endUserIp": "91.229.230.41",
"endUserLanguage": null,
"amount": 1235835,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 2,
"iterationCount": 2,
"status": "ACTIVE",
"endToEndIdentification": null,
"remittanceInformation": "49C8A75C41DE",
"installments": [
{
"installmentId": "ed9db4e8-f55c-4de2-9c24-be268402cd5b",
"creationDate": "2021-09-13T14:32:11.648281+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617918,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"af37becb-ea9e-49dc-9759-bf923d2825a1"
]
},
{
"installmentId": "95a48d1a-6117-4898-9c35-92d027b6127c",
"creationDate": "2021-09-13T14:32:11.649033+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617917,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-27T08:00+02:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}
INSTALLMENTPAYMENT_FAILED
{
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"creationDate": "2021-09-03T10:38:16.811541+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"cardId": "d3143e10-9660-48bb-b6a6-b2e1100ecf6f",
"paymentRequestBreakdownId": "dfd3f740-0366-411b-80ef-48ee7e387f22",
"paymentRequestId": "4d350f3d-37fb-4887-b45b-b0d256d278c8",
"mandateId": null,
"depositStartingDate": "2021-09-03",
"startingDate": "2021-09-17",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": "testInstall",
"endUserIp": "91.229.230.41",
"endUserLanguage": "fre",
"amount": 550000,
"depositAmount": 50000,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 2,
"iterationCount": 10,
"status": "UNPAID",
"endToEndIdentification": null,
"remittanceInformation": null,
"installments": [
{
"installmentId": "1a123952-cc30-47c2-8f2e-1b6182fd25a6",
"creationDate": "2021-09-03T10:38:16.809510+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 1,
"paid": false,
"type": "DEPOSIT",
"nextTransactionAttempt": "2021-09-03T08:00+02:00",
"transactions": [
"91c604d8-a63c-483c-87aa-f03181a634b5"
],
"sddTransactions": []
},
{
"installmentId": "28754849-1b22-491b-bc15-7f38d0c9a988",
"creationDate": "2021-09-03T10:38:16.810529+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-17T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "666f0320-7766-464e-949b-e7ce9997a173",
"creationDate": "2021-09-03T10:38:16.810564+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-01T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "1b88ddcc-5c9e-4b43-a3cc-6792d9162ea4",
"creationDate": "2021-09-03T10:38:16.810582+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-15T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "1f25ec3c-d846-4f9c-80e9-c5b86adef8eb",
"creationDate": "2021-09-03T10:38:16.810595+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-29T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "9d206cee-565d-4181-9987-d65f82a0ffaa",
"creationDate": "2021-09-03T10:38:16.810609+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-11-12T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "4fecfcf0-7b4a-4241-a716-a56bc840bd20",
"creationDate": "2021-09-03T10:38:16.810621+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-11-26T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "703d1c4f-f1a6-4e30-9a8c-83cd9916f42e",
"creationDate": "2021-09-03T10:38:16.810634+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-12-10T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "4c98d99f-f321-43bf-a37e-801a85d03200",
"creationDate": "2021-09-03T10:38:16.810646+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-12-24T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "893c6120-7f51-4616-9f18-7880c76747fb",
"creationDate": "2021-09-03T10:38:16.810658+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2022-01-07T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "8bf4e146-8737-4260-84f5-1a95653d1e24",
"creationDate": "2021-09-03T10:38:16.810671+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2022-01-21T07:00+01:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}
INSTALLMENTPAYMENT_UPDATED
{
"installmentPaymentId": "2351a31a-3c84-4681-8a83-cd5f260d78ab",
"creationDate": "2021-09-09T09:49:00.941254+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "3036e768-071e-4119-abd8-57d50581c371",
"cardId": "06a45250-8e22-41aa-a97a-284c225419a5",
"paymentRequestBreakdownId": "6e5ba89d-d275-4174-8cfd-9418dc6bd303",
"paymentRequestId": "c796df20-258e-4645-90d8-aad70349c547",
"mandateId": "f65ea8ce-5171-4c1e-8b8f-69654e0acf4e",
"depositStartingDate": null,
"startingDate": "2021-09-09",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": null,
"endUserIp": "92.154.127.221",
"endUserLanguage": null,
"amount": 300,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 1,
"iterationCount": 3,
"status": "ACTIVE",
"endToEndIdentification": null,
"remittanceInformation": "BCDEB2DEEB6E",
"installments": [
{
"installmentId": "ee6f170c-710a-4a9d-a79f-c163de336530",
"creationDate": "2021-09-09T09:49:00.940625+02:00",
"installmentPaymentId": "2351a31a-3c84-4681-8a83-cd5f260d78ab",
"customerId": "3036e768-071e-4119-abd8-57d50581c371",
"mandateId": "f65ea8ce-5171-4c1e-8b8f-69654e0acf4e",
"amount": 100,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"116adfc1-7996-4bd7-9678-d4a2b1a77762"
]
},
{
"installmentId": "26d5e572-4740-4c30-bbb8-5d2251e13e1d",
"creationDate": "2021-09-09T09:49:00.941206+02:00",
"installmentPaymentId": "2351a31a-3c84-4681-8a83-cd5f260d78ab",
"customerId": "3036e768-071e-4119-abd8-57d50581c371",
"mandateId": "f65ea8ce-5171-4c1e-8b8f-69654e0acf4e",
"amount": 100,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-16T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "afe58afd-712d-415f-adf5-70e980c73b57",
"creationDate": "2021-09-09T09:49:00.941224+02:00",
"installmentPaymentId": "2351a31a-3c84-4681-8a83-cd5f260d78ab",
"customerId": "3036e768-071e-4119-abd8-57d50581c371",
"mandateId": "f65ea8ce-5171-4c1e-8b8f-69654e0acf4e",
"amount": 100,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-23T08:00+02:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}
INSTALLMENTPAYMENT_CANCELED
{
"installmentPaymentId": "23717917-f981-46f1-91fe-51fddf012dc1",
"creationDate": "2021-09-08T09:40:38.410270+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"cardId": "18185a9a-865d-4871-ae9b-fdc3f0eb7d33",
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"mandateId": null,
"depositStartingDate": null,
"startingDate": "2021-09-08",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": "MIP_001",
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"amount": 1000,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 2,
"status": "CANCELED",
"endToEndIdentification": null,
"remittanceInformation": null,
"installments": [
{
"installmentId": "48e602fc-4698-4c88-bcdf-37354a4ee809",
"creationDate": "2021-09-08T09:40:38.410203+02:00",
"installmentPaymentId": "23717917-f981-46f1-91fe-51fddf012dc1",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"mandateId": null,
"amount": 500,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [
"d93c6657-e449-4cb6-8da9-b3610b6c93ca"
],
"sddTransactions": []
},
{
"installmentId": "794e76d0-26b5-4cab-a624-9ef1401fe1dd",
"creationDate": "2021-09-08T09:40:38.410238+02:00",
"installmentPaymentId": "23717917-f981-46f1-91fe-51fddf012dc1",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"mandateId": null,
"amount": 500,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": []
}
],
"additionalData": {
"Key2": "val2",
"Key1": "val1"
}
}
INSTALLMENTPAYMENT_PAID
{
"installmentPaymentId": "f922a524-c1c3-4e8f-a596-39147d1955fa",
"creationDate": "2021-09-09T10:08:02.708221+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "344eec6c-160c-4a0f-bb90-23ea81be14dc",
"cardId": null,
"paymentRequestBreakdownId": "86b86174-b3c8-4217-8a51-a5fa04cef18b",
"paymentRequestId": "cb740834-336a-4ceb-b6c1-9432e376baae",
"mandateId": "e03124c5-69e4-4f0e-86c5-df4b0ce79df9",
"depositStartingDate": null,
"startingDate": "2021-09-09",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": null,
"endUserIp": "92.154.127.221",
"endUserLanguage": null,
"amount": 5000,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 1,
"iterationCount": 2,
"status": "PAID",
"endToEndIdentification": null,
"remittanceInformation": "67E0223B52BB",
"installments": [
{
"installmentId": "91684a2d-48c7-423b-a2d8-5d94a7ab8ac1",
"creationDate": "2021-09-09T10:08:02.707421+02:00",
"installmentPaymentId": "f922a524-c1c3-4e8f-a596-39147d1955fa",
"customerId": "344eec6c-160c-4a0f-bb90-23ea81be14dc",
"mandateId": "e03124c5-69e4-4f0e-86c5-df4b0ce79df9",
"amount": 2500,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"e0eac3f2-67a9-4761-bb41-5b5165bf6f6d"
]
},
{
"installmentId": "7a526988-51fa-442b-ba55-6a13c3b85b6b",
"creationDate": "2021-09-09T10:08:02.708182+02:00",
"installmentPaymentId": "f922a524-c1c3-4e8f-a596-39147d1955fa",
"customerId": "344eec6c-160c-4a0f-bb90-23ea81be14dc",
"mandateId": "e03124c5-69e4-4f0e-86c5-df4b0ce79df9",
"amount": 2500,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"3af0aca0-a112-4f2e-a688-6cc54957d0af"
]
}
],
"additionalData": []
}
INSTALLMENTPAYMENT_UNPAID
{
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"creationDate": "2021-09-03T10:38:16.811541+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"cardId": "d3143e10-9660-48bb-b6a6-b2e1100ecf6f",
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"mandateId": null,
"depositStartingDate": "2021-09-03",
"startingDate": "2021-09-17",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": "testInstall",
"endUserIp": "91.229.230.41",
"endUserLanguage": "fre",
"amount": 550000,
"depositAmount": 50000,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 2,
"iterationCount": 10,
"status": "UNPAID",
"endToEndIdentification": null,
"remittanceInformation": null,
"installments": [
{
"installmentId": "1a123952-cc30-47c2-8f2e-1b6182fd25a6",
"creationDate": "2021-09-03T10:38:16.809510+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 1,
"paid": false,
"type": "DEPOSIT",
"nextTransactionAttempt": "2021-09-03T08:00+02:00",
"transactions": [
"91c604d8-a63c-483c-87aa-f03181a634b5"
],
"sddTransactions": []
},
{
"installmentId": "28754849-1b22-491b-bc15-7f38d0c9a988",
"creationDate": "2021-09-03T10:38:16.810529+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-17T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "666f0320-7766-464e-949b-e7ce9997a173",
"creationDate": "2021-09-03T10:38:16.810564+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-01T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "1b88ddcc-5c9e-4b43-a3cc-6792d9162ea4",
"creationDate": "2021-09-03T10:38:16.810582+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-15T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "1f25ec3c-d846-4f9c-80e9-c5b86adef8eb",
"creationDate": "2021-09-03T10:38:16.810595+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-29T08:00+02:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "9d206cee-565d-4181-9987-d65f82a0ffaa",
"creationDate": "2021-09-03T10:38:16.810609+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-11-12T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "4fecfcf0-7b4a-4241-a716-a56bc840bd20",
"creationDate": "2021-09-03T10:38:16.810621+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-11-26T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "703d1c4f-f1a6-4e30-9a8c-83cd9916f42e",
"creationDate": "2021-09-03T10:38:16.810634+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-12-10T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "4c98d99f-f321-43bf-a37e-801a85d03200",
"creationDate": "2021-09-03T10:38:16.810646+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-12-24T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "893c6120-7f51-4616-9f18-7880c76747fb",
"creationDate": "2021-09-03T10:38:16.810658+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2022-01-07T07:00+01:00",
"transactions": [],
"sddTransactions": []
},
{
"installmentId": "8bf4e146-8737-4260-84f5-1a95653d1e24",
"creationDate": "2021-09-03T10:38:16.810671+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2022-01-21T07:00+01:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}
INSTALLMENT_TRANSACTION_SUCCEEDED
{
"installmentId": "7a526988-51fa-442b-ba55-6a13c3b85b6b",
"creationDate": "2021-09-09T10:08:02.708182+02:00",
"installmentPaymentId": "f922a524-c1c3-4e8f-a596-39147d1955fa",
"customerId": "344eec6c-160c-4a0f-bb90-23ea81be14dc",
"mandateId": "e03124c5-69e4-4f0e-86c5-df4b0ce79df9",
"amount": 2500,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"3af0aca0-a112-4f2e-a688-6cc54957d0af"
]
}
INSTALLMENT_TRANSACTION_FAILED
{
"installmentId": "1a123952-cc30-47c2-8f2e-1b6182fd25a6",
"creationDate": "2021-09-03T10:38:16.809510+02:00",
"installmentPaymentId": "67e18dd5-f990-425f-9234-908ec3e17b4a",
"customerId": "5d6f77d7-2a77-4ec0-9789-aff4a65751a5",
"mandateId": null,
"amount": 50000,
"currency": "EUR",
"attemptCount": 1,
"paid": false,
"type": "DEPOSIT",
"nextTransactionAttempt": "2021-09-03T08:00+02:00",
"transactions": [
"91c604d8-a63c-483c-87aa-f03181a634b5"
],
"sddTransactions": []
}
ONBOARDING_ENROLLMENT_CREATED :
{
"workflow": null,
"identity_badge": null,
"representatives_list": null,
"uuid": "ca9756cb-94a5-4fb5-b44c-0bb7759e3252",
"risk_points": null,
"created_at": "2021-09-15T13:24:15+02:00",
"last_updated_at": null,
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": null,
"type": null,
"enrollment_account": null,
"profile": {
"uuid": "692c0518-c326-4fdb-9353-d772749a265e",
"workflow": {
"uuid": "4e66d4ca-a1c9-4fc0-bdd7-0053470af953",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "d53c818e-b3f8-4716-8a19-95c678ba0f42",
"value": "TestSiren",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "3f0db34e-4f56-47f8-8f5d-bf17b9507c37",
"value": "testSiren",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "6fc52bd4-43e3-429f-bd68-518d8a3ae960",
"value": "dhjfzefvkuye@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "5263d9c5-2f33-4736-9a2d-11d57bb107c5",
"value": "+33682242649",
"element-type": "phone"
}
],
"uuid": "aa8e2a25-d1ed-49cb-b9bd-e833ef01ebd1",
"name": "identityInfos",
"state": "TODO",
"category": "identity",
"created_at": "2021-09-15T13:24:15+02:00"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "d53c818e-b3f8-4716-8a19-95c678ba0f42",
"value": "TestSiren",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "3f0db34e-4f56-47f8-8f5d-bf17b9507c37",
"value": "testSiren",
"element-type": "lastname"
},
"email": {
"status": "COMPLETED",
"uuid": "6fc52bd4-43e3-429f-bd68-518d8a3ae960",
"value": "dhjfzefvkuye@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "2ce10428-f112-4353-85ee-696549701f93",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "5263d9c5-2f33-4736-9a2d-11d57bb107c5",
"value": "+33682242649",
"element-type": "phone"
},
"birthday": null,
"login": null,
"bo_user_uuid": null
},
"activity_sector": {
"name": "Artisans (plumber, electricians, ...)"
},
"data": null,
"custom_reference": null,
"conformity_status": "ON_GOING",
"conformity_status_level_two": null,
"comments_level_two": null,
"validator_level_one": null,
"validator_level_two": null,
"merchant_uuid": null,
"validation_date": null,
"validation_date_level_two": null,
"sub_type": null,
"api_infogreffe_attempt": 0
}ONBOARDING_ENROLLMENT_STATUS_UPDATED
{
"workflow": null,
"identity_badge": null,
"representatives_list": null,
"uuid": "ca9756cb-94a5-4fb5-b44c-0bb7759e3252",
"risk_points": null,
"created_at": "2021-09-15T13:24:15+02:00",
"last_updated_at": "2021-09-15T13:25:37+02:00",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": null,
"type": null,
"enrollment_account": null,
"profile": {
"uuid": "692c0518-c326-4fdb-9353-d772749a265e",
"workflow": {
"uuid": "4e66d4ca-a1c9-4fc0-bdd7-0053470af953",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "9dcf7991-f262-4a27-8255-1145338e44dc",
"country": "FRA",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "bfc5722c-8763-4936-8cd3-89870cb30280",
"value": "Tours",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "bf4c1d41-ad3a-47df-851a-7ceba41e8164",
"value": "1967-10-03T00:00:00+01:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "5263d9c5-2f33-4736-9a2d-11d57bb107c5",
"value": "+33682242649",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "6fc52bd4-43e3-429f-bd68-518d8a3ae960",
"value": "dhjfzefvkuye@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "3f0db34e-4f56-47f8-8f5d-bf17b9507c37",
"value": "testSiren",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "d53c818e-b3f8-4716-8a19-95c678ba0f42",
"value": "TestSiren",
"element-type": "firstname"
}
],
"uuid": "aa8e2a25-d1ed-49cb-b9bd-e833ef01ebd1",
"name": "identityInfos",
"state": "OK",
"category": "identity",
"created_at": "2021-09-15T13:24:15+02:00"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "26d21e86-57b5-445d-935a-c43884de3327",
"name_line1": "19 rue Edouard Vaillant",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Tours",
"postal_code": "37000",
"country": "FRA",
"element-type": "address"
}
],
"uuid": "b692800b-1fb7-4e3b-88bc-1ac6cec5a39d",
"name": "domiciliation",
"state": "OK",
"category": "identity",
"created_at": "2021-09-15T13:25:23+02:00"
},
{
"step_elements": [],
"uuid": null,
"name": "finished",
"state": "OK",
"category": null,
"created_at": null
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "d53c818e-b3f8-4716-8a19-95c678ba0f42",
"value": "TestSiren",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "3f0db34e-4f56-47f8-8f5d-bf17b9507c37",
"value": "testSiren",
"element-type": "lastname"
},
"email": {
"status": "COMPLETED",
"uuid": "6fc52bd4-43e3-429f-bd68-518d8a3ae960",
"value": "dhjfzefvkuye@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "2ce10428-f112-4353-85ee-696549701f93",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "5263d9c5-2f33-4736-9a2d-11d57bb107c5",
"value": "+33682242649",
"element-type": "phone"
},
"birthday": {
"status": "COMPLETED",
"uuid": "bf4c1d41-ad3a-47df-851a-7ceba41e8164",
"value": "1967-10-03T00:00:00+01:00",
"element-type": "birthday"
},
"login": null,
"bo_user_uuid": null
},
"activity_sector": {
"name": "Artisans (plumber, electricians, ...)"
},
"data": null,
"custom_reference": null,
"conformity_status": "ON_GOING",
"conformity_status_level_two": null,
"comments_level_two": null,
"validator_level_one": null,
"validator_level_two": null,
"merchant_uuid": null,
"validation_date": null,
"validation_date_level_two": null,
"sub_type": null,
"api_infogreffe_attempt": 0
}ONBOARDING_ADDITIONAL_DOCUMENT_REQUESTED
{
"uuid": "1ad91002-fcad-4056-a41f-82ab63687af2",
"additional_documents": {
"uuid": "eb0b568a-a619-4d80-b35a-846144ef1925",
"created_at": "2021-03-23T17:30:35+01:00",
"type": "AUDITED_FINANCIAL_REPORT",
"additional_documents_history": [
{
"uuid": "1a330b31-9150-45cd-9fc3-bb3bed751b7b",
"created_at": "2021-03-23T17:30:35+01:00",
"status": "NOT_UPLOADED",
"comment": "en couleur de moins de 3 mois",
"additional_document_history_status": [
{
"changed_at": "2021-03-23T17:30:35+01:00",
"value": "NOT_UPLOADED"
}
]
}
]
}
}ONBOARDING_PAYMENT_ACCOUNT_CREATED
{
"merchantEnrollmentId": "1ad91002-fcad-4056-a41f-82ab63687af2",
"merchantEnrollmentCustomReference": null,
"merchantEnrollmentType": "BASIC",
"merchantId": "95bf21f9-751b-418a-860a-255b4f59a839",
"merchantName": "xsths",
"merchantWalletId": "d7e810ed-d210-45ce-92ae-52e51b247ac4",
"creationDate": "2021-03-23T17:33:05+0100"
}The ONBOARDING object
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
ONBOARDING_ENROLLMENT_CREATED :
{
"workflow": null,
"identity_badge": null,
"representatives_list": null,
"uuid": "ca9756cb-94a5-4fb5-b44c-0bb7759e3252",
"risk_points": null,
"created_at": "2021-09-15T13:24:15+02:00",
"last_updated_at": null,
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": null,
"type": null,
"enrollment_account": null,
"profile": {
"uuid": "692c0518-c326-4fdb-9353-d772749a265e",
"workflow": {
"uuid": "4e66d4ca-a1c9-4fc0-bdd7-0053470af953",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "d53c818e-b3f8-4716-8a19-95c678ba0f42",
"value": "TestSiren",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "3f0db34e-4f56-47f8-8f5d-bf17b9507c37",
"value": "testSiren",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "6fc52bd4-43e3-429f-bd68-518d8a3ae960",
"value": "dhjfzefvkuye@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "5263d9c5-2f33-4736-9a2d-11d57bb107c5",
"value": "+33682242649",
"element-type": "phone"
}
],
"uuid": "aa8e2a25-d1ed-49cb-b9bd-e833ef01ebd1",
"name": "identityInfos",
"state": "TODO",
"category": "identity",
"created_at": "2021-09-15T13:24:15+02:00"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "d53c818e-b3f8-4716-8a19-95c678ba0f42",
"value": "TestSiren",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "3f0db34e-4f56-47f8-8f5d-bf17b9507c37",
"value": "testSiren",
"element-type": "lastname"
},
"email": {
"status": "COMPLETED",
"uuid": "6fc52bd4-43e3-429f-bd68-518d8a3ae960",
"value": "dhjfzefvkuye@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "2ce10428-f112-4353-85ee-696549701f93",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "5263d9c5-2f33-4736-9a2d-11d57bb107c5",
"value": "+33682242649",
"element-type": "phone"
},
"birthday": null,
"login": null,
"bo_user_uuid": null
},
"activity_sector": {
"name": "Artisans (plumber, electricians, ...)"
},
"data": null,
"custom_reference": null,
"conformity_status": "ON_GOING",
"conformity_status_level_two": null,
"comments_level_two": null,
"validator_level_one": null,
"validator_level_two": null,
"merchant_uuid": null,
"validation_date": null,
"validation_date_level_two": null,
"sub_type": null,
"api_infogreffe_attempt": 0
}ONBOARDING_ENROLLMENT_STATUS_UPDATED
{
"workflow": null,
"identity_badge": null,
"representatives_list": null,
"uuid": "ca9756cb-94a5-4fb5-b44c-0bb7759e3252",
"risk_points": null,
"created_at": "2021-09-15T13:24:15+02:00",
"last_updated_at": "2021-09-15T13:25:37+02:00",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": null,
"type": null,
"enrollment_account": null,
"profile": {
"uuid": "692c0518-c326-4fdb-9353-d772749a265e",
"workflow": {
"uuid": "4e66d4ca-a1c9-4fc0-bdd7-0053470af953",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "9dcf7991-f262-4a27-8255-1145338e44dc",
"country": "FRA",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "bfc5722c-8763-4936-8cd3-89870cb30280",
"value": "Tours",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "bf4c1d41-ad3a-47df-851a-7ceba41e8164",
"value": "1967-10-03T00:00:00+01:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "5263d9c5-2f33-4736-9a2d-11d57bb107c5",
"value": "+33682242649",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "6fc52bd4-43e3-429f-bd68-518d8a3ae960",
"value": "dhjfzefvkuye@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "3f0db34e-4f56-47f8-8f5d-bf17b9507c37",
"value": "testSiren",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "d53c818e-b3f8-4716-8a19-95c678ba0f42",
"value": "TestSiren",
"element-type": "firstname"
}
],
"uuid": "aa8e2a25-d1ed-49cb-b9bd-e833ef01ebd1",
"name": "identityInfos",
"state": "OK",
"category": "identity",
"created_at": "2021-09-15T13:24:15+02:00"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "26d21e86-57b5-445d-935a-c43884de3327",
"name_line1": "19 rue Edouard Vaillant",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Tours",
"postal_code": "37000",
"country": "FRA",
"element-type": "address"
}
],
"uuid": "b692800b-1fb7-4e3b-88bc-1ac6cec5a39d",
"name": "domiciliation",
"state": "OK",
"category": "identity",
"created_at": "2021-09-15T13:25:23+02:00"
},
{
"step_elements": [],
"uuid": null,
"name": "finished",
"state": "OK",
"category": null,
"created_at": null
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "d53c818e-b3f8-4716-8a19-95c678ba0f42",
"value": "TestSiren",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "3f0db34e-4f56-47f8-8f5d-bf17b9507c37",
"value": "testSiren",
"element-type": "lastname"
},
"email": {
"status": "COMPLETED",
"uuid": "6fc52bd4-43e3-429f-bd68-518d8a3ae960",
"value": "dhjfzefvkuye@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "2ce10428-f112-4353-85ee-696549701f93",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "5263d9c5-2f33-4736-9a2d-11d57bb107c5",
"value": "+33682242649",
"element-type": "phone"
},
"birthday": {
"status": "COMPLETED",
"uuid": "bf4c1d41-ad3a-47df-851a-7ceba41e8164",
"value": "1967-10-03T00:00:00+01:00",
"element-type": "birthday"
},
"login": null,
"bo_user_uuid": null
},
"activity_sector": {
"name": "Artisans (plumber, electricians, ...)"
},
"data": null,
"custom_reference": null,
"conformity_status": "ON_GOING",
"conformity_status_level_two": null,
"comments_level_two": null,
"validator_level_one": null,
"validator_level_two": null,
"merchant_uuid": null,
"validation_date": null,
"validation_date_level_two": null,
"sub_type": null,
"api_infogreffe_attempt": 0
}ONBOARDING_ADDITIONAL_DOCUMENT_REQUESTED
{
"uuid": "1ad91002-fcad-4056-a41f-82ab63687af2",
"additional_documents": {
"uuid": "eb0b568a-a619-4d80-b35a-846144ef1925",
"created_at": "2021-03-23T17:30:35+01:00",
"type": "AUDITED_FINANCIAL_REPORT",
"additional_documents_history": [
{
"uuid": "1a330b31-9150-45cd-9fc3-bb3bed751b7b",
"created_at": "2021-03-23T17:30:35+01:00",
"status": "NOT_UPLOADED",
"comment": "en couleur de moins de 3 mois",
"additional_document_history_status": [
{
"changed_at": "2021-03-23T17:30:35+01:00",
"value": "NOT_UPLOADED"
}
]
}
]
}
}ONBOARDING_PAYMENT_ACCOUNT_CREATED
{
"merchantEnrollmentId": "1ad91002-fcad-4056-a41f-82ab63687af2",
"merchantEnrollmentCustomReference": null,
"merchantEnrollmentType": "BASIC",
"merchantId": "95bf21f9-751b-418a-860a-255b4f59a839",
"merchantName": "xsths",
"merchantWalletId": "d7e810ed-d210-45ce-92ae-52e51b247ac4",
"creationDate": "2021-03-23T17:33:05+0100"
}PAYMENTREQUEST_CREATED
{
"paymentRequestId": "76aa4749-ba80-426b-96a0-0d9c65130043",
"creationDate": "2021-09-15T11:55:30.659900+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": null,
"linkExpirationDate": null,
"endingDate": null,
"scenarioId": null,
"scenarioStartingDate": null,
"scenarios": [],
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "ACTIVE",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"TRANSACTION"
],
"transaction": {
"paymentRequestTransactionId": "66707a47-6ba7-4bfb-ae29-d4b419d48904",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"receiptEmail": null,
"source": "EC",
"capture": true,
"customAcceptanceData": []
},
"installment": null,
"subscription": null,
"sdd": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "5d1cf887-dff0-4182-81a0-b1cc99313c04",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 100000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/a9f7c854-f65b-4238-9c21-af65550eec9b",
"email": "jonh@gmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": false,
"paymentAttempted": false,
"paid": false,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": null,
"amount": 100000,
"fee": 0,
"merchantTransferId": null
}
],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": []
}PAYMENTREQUEST_CANCELED
{
"paymentRequestId": "b575ee42-3cc6-4353-9275-99ae38b6b70d",
"creationDate": "2021-09-10T09:25:43.021954+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": null,
"linkExpirationDate": null,
"endingDate": "2021-09-10T09:26:12.226586+02:00",
"scenarioId": null,
"scenarioStartingDate": null,
"scenarios": [],
"paymentFormTemplateId": null,
"merchantPaymentRequestId": "test",
"description": null,
"currency": "EUR",
"totalAmount": 95000,
"paymentRequestStatus": "CANCELED",
"paymentStatus": "UNPAID",
"createCustomer": true,
"paymentMethods": [
"INSTALLMENT"
],
"transaction": null,
"installment": {
"paymentRequestInstallmentId": "90e3fd45-808d-4936-af9c-fb6136d5d2c2",
"depositStartingDate": null,
"startingDate": null,
"creditorBankAccountId": null,
"ultimateCreditorIdentityId": null,
"depositAmount": 0,
"feeAmount": null,
"intervalUnit": "MONTH",
"intervalCount": 91,
"iterationCount": 12,
"source": "CARD",
"rum": null,
"endToEndIdentification": null,
"remittanceInformation": null,
"requestedCollectionDate": null
},
"subscription": null,
"sdd": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "7f41d2ff-33ba-4957-8e5c-d69ac2b67b1e",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 95000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/610f2c25-b076-4c2e-9a17-4813521255dc",
"email": "abonnet@centralpay.eu",
"phone": null,
"firstName": "",
"lastName": "",
"entered": true,
"paymentAttempted": false,
"paid": false,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "fre",
"redirectUrl": null,
"closeComment": null,
"additionalData": []
}PAYMENTREQUEST_CLOSED
{
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"creationDate": "2021-09-13T14:32:11.649077+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"cardId": null,
"paymentRequestBreakdownId": "cae61277-18fa-4847-bf6a-ad2b8f54e7d9",
"paymentRequestId": "8703d6a2-3c05-4340-9227-fe962ffd2620",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"depositStartingDate": null,
"startingDate": "2021-09-13",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": null,
"endUserIp": "91.229.230.41",
"endUserLanguage": null,
"amount": 1235835,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 2,
"iterationCount": 2,
"status": "ACTIVE",
"endToEndIdentification": null,
"remittanceInformation": "49C8A75C41DE",
"installments": [
{
"installmentId": "ed9db4e8-f55c-4de2-9c24-be268402cd5b",
"creationDate": "2021-09-13T14:32:11.648281+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617918,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"af37becb-ea9e-49dc-9759-bf923d2825a1"
]
},
{
"installmentId": "95a48d1a-6117-4898-9c35-92d027b6127c",
"creationDate": "2021-09-13T14:32:11.649033+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617917,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-27T08:00+02:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}PAYMENTREQUEST_PAID
{
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"creationDate": "2021-09-13T14:32:11.649077+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"cardId": null,
"paymentRequestBreakdownId": "cae61277-18fa-4847-bf6a-ad2b8f54e7d9",
"paymentRequestId": "8703d6a2-3c05-4340-9227-fe962ffd2620",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"depositStartingDate": null,
"startingDate": "2021-09-13",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": null,
"endUserIp": "91.229.230.41",
"endUserLanguage": null,
"amount": 1235835,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 2,
"iterationCount": 2,
"status": "ACTIVE",
"endToEndIdentification": null,
"remittanceInformation": "49C8A75C41DE",
"installments": [
{
"installmentId": "ed9db4e8-f55c-4de2-9c24-be268402cd5b",
"creationDate": "2021-09-13T14:32:11.648281+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617918,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"af37becb-ea9e-49dc-9759-bf923d2825a1"
]
},
{
"installmentId": "95a48d1a-6117-4898-9c35-92d027b6127c",
"creationDate": "2021-09-13T14:32:11.649033+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617917,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-27T08:00+02:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}PAYMENTREQUEST_INSTALLMENT_FAILED
{
"installmentPaymentId": "23717917-f981-46f1-91fe-51fddf012dc1",
"creationDate": "2021-09-08T09:40:38.410270+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"cardId": "63afa65e-5674-49bf-9ac3-a98b82d16e92",
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"mandateId": null,
"depositStartingDate": null,
"startingDate": "2021-09-08",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": "MIP_001",
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"amount": 1000,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 2,
"status": "ACTIVE",
"endToEndIdentification": null,
"remittanceInformation": null,
"installments": [
{
"installmentId": "48e602fc-4698-4c88-bcdf-37354a4ee809",
"creationDate": "2021-09-08T09:40:38.410203+02:00",
"installmentPaymentId": "23717917-f981-46f1-91fe-51fddf012dc1",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"mandateId": null,
"amount": 500,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [
"d93c6657-e449-4cb6-8da9-b3610b6c93ca"
],
"sddTransactions": []
},
{
"installmentId": "794e76d0-26b5-4cab-a624-9ef1401fe1dd",
"creationDate": "2021-09-08T09:40:38.410238+02:00",
"installmentPaymentId": "23717917-f981-46f1-91fe-51fddf012dc1",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"mandateId": null,
"amount": 500,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-08T08:00+02:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": {
"Key1": "val1"
}
}PAYMENTREQUEST_INSTALLMENT_SUCCEEDED
{
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"creationDate": "2021-09-13T14:32:11.649077+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"cardId": null,
"paymentRequestBreakdownId": "cae61277-18fa-4847-bf6a-ad2b8f54e7d9",
"paymentRequestId": "8703d6a2-3c05-4340-9227-fe962ffd2620",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"depositStartingDate": null,
"startingDate": "2021-09-13",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": null,
"endUserIp": "91.229.230.41",
"endUserLanguage": null,
"amount": 1235835,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 2,
"iterationCount": 2,
"status": "ACTIVE",
"endToEndIdentification": null,
"remittanceInformation": "49C8A75C41DE",
"installments": [
{
"installmentId": "ed9db4e8-f55c-4de2-9c24-be268402cd5b",
"creationDate": "2021-09-13T14:32:11.648281+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617918,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"af37becb-ea9e-49dc-9759-bf923d2825a1"
]
},
{
"installmentId": "95a48d1a-6117-4898-9c35-92d027b6127c",
"creationDate": "2021-09-13T14:32:11.649033+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617917,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-27T08:00+02:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}PAYMENTREQUEST_SUBSCRIPTION_FAILED
{
"subscriptionId": "26815c6a-19fe-49bd-b619-f14719f3e4ba",
"creationDate": "2021-09-08T09:39:06.212604+02:00",
"walletId": null,
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"cardId": "63afa65e-5674-49bf-9ac3-a98b82d16e92",
"mandateId": null,
"startingDate": "2021-09-08",
"endingDate": null,
"expectedEndingDate": "2022-09-07",
"currentPeriodStart": "2021-09-08",
"currentPeriodEnd": "2021-10-07",
"requestedCollectionDate": null,
"cancellationDate": null,
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"merchantSubscriptionId": null,
"subscriptionModel": {
"subscriptionModelId": "01c3f578-a589-4ef7-9bb6-d855ff0fa121",
"creationDate": "2021-09-08T09:39:06.137368+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": null,
"amount": 10000,
"currency": "EUR",
"name": "Test Abo",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 12,
"additionalData": []
},
"quantity": 1,
"status": "ACTIVE",
"cancelAtPeriodEnd": null,
"lastInvoice": {
"invoiceId": "da0622d1-723b-4567-ad40-917a92a84e05",
"creationDate": "2021-09-08T09:39:06.562016+02:00",
"subscriptionId": "26815c6a-19fe-49bd-b619-f14719f3e4ba",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceId": null,
"amount": 10000,
"currency": "EUR",
"closed": true,
"invoiceItems": [
{
"invoiceItemId": "e8b03ea3-85ca-4e85-ab3d-6b1c83122508",
"creationDate": "2021-09-08T09:39:06.469080+02:00",
"invoiceId": "da0622d1-723b-4567-ad40-917a92a84e05",
"subscriptionId": "26815c6a-19fe-49bd-b619-f14719f3e4ba",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 10000,
"totalAmount": 10000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 1,
"paid": true,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": null,
"transactions": [
"d0bcd686-1b6b-45aa-bf8a-c4cedab81127"
],
"transfers": [],
"sddTransactions": [],
"eventReceivedDate": null,
"additionalData": []
},
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"endToEndIdentification": null,
"remittanceInformation": null,
"redirect": null,
"additionalData": []
}PAYMENTREQUEST_SUBSCRIPTION_SUCCEEDED
{
"subscriptionId": "da6a4622-4e5d-4da5-8d29-6c49d4052b69",
"creationDate": "2021-09-09T10:32:15.675280+02:00",
"walletId": null,
"customerId": "2f2e6ce9-e0bb-4377-8eb9-6a8506c0baa4",
"cardId": null,
"mandateId": "b08bb9e0-72e4-426a-9998-585f083338fc",
"startingDate": "2021-09-09",
"endingDate": null,
"expectedEndingDate": null,
"currentPeriodStart": "2021-09-09",
"currentPeriodEnd": "2021-10-08",
"requestedCollectionDate": "2021-09-15",
"cancellationDate": null,
"paymentRequestBreakdownId": "825c03a4-fa3e-4df0-812d-f3d094f88ca3",
"paymentRequestId": "ef4bf0e4-c77c-42a3-910e-b85e84b3c92b",
"merchantSubscriptionId": null,
"subscriptionModel": {
"subscriptionModelId": "b1561842-46c1-422c-84a6-69ea8e1c8051",
"creationDate": "2017-05-10T09:20:14.268+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": "a00e2d1b-87a1-4fb2-8e15-5d6132006d5b",
"amount": 2000,
"currency": "EUR",
"name": "premium",
"description": "abbonnement premium",
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": null,
"additionalData": []
},
"quantity": 1,
"status": "ACTIVE",
"cancelAtPeriodEnd": null,
"lastInvoice": {
"invoiceId": "e257896b-86a1-41cf-865b-ac0531e2ea4a",
"creationDate": "2021-09-09T10:32:16.072897+02:00",
"subscriptionId": "da6a4622-4e5d-4da5-8d29-6c49d4052b69",
"customerId": "2f2e6ce9-e0bb-4377-8eb9-6a8506c0baa4",
"walletId": null,
"mandateId": "b08bb9e0-72e4-426a-9998-585f083338fc",
"merchantInvoiceId": null,
"amount": 2000,
"currency": "EUR",
"closed": true,
"invoiceItems": [
{
"invoiceItemId": "0dabd4f2-6e36-4731-989a-d00bdf93e748",
"creationDate": "2021-09-09T10:32:15.860404+02:00",
"invoiceId": "e257896b-86a1-41cf-865b-ac0531e2ea4a",
"subscriptionId": "da6a4622-4e5d-4da5-8d29-6c49d4052b69",
"customerId": "2f2e6ce9-e0bb-4377-8eb9-6a8506c0baa4",
"walletId": null,
"mandateId": "b08bb9e0-72e4-426a-9998-585f083338fc",
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 2000,
"totalAmount": 2000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 1,
"paid": true,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": null,
"transactions": [],
"transfers": [],
"sddTransactions": [
"0fd0d6cb-076a-4df5-9e89-7a62b74791e8"
],
"eventReceivedDate": null,
"additionalData": []
},
"endUserIp": "92.154.127.221",
"endUserLanguage": null,
"endToEndIdentification": null,
"remittanceInformation": "PREMIUM",
"redirect": null,
"additionalData": []
}PAYMENTREQUEST_TRANSACTION_FAILED
{
"transactionId": "1d5650f1-8ec5-4280-8b4a-12038ebbc30d",
"creationDate": "2021-09-08T09:39:45.432609+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "FAILURE",
"authorizationStatus": "FAILURE",
"bankCode": "5",
"bankMessage": "Simulation : Do Not Honour",
"authorizationCode": null,
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": null,
"commission": null,
"fee": 500,
"amount": 10,
"partialAuthorization": false,
"partialAuthorized": false,
"partialAuthorizedAmount": null,
"totalAmount": 10,
"card": {
"cardId": "5e7cebc9-af26-4f87-b853-8c9eefad5ec4",
"creationDate": "2021-09-08T09:39:45.657797+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0085",
"expirationMonth": 1,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "3d4059579d3fc46f0ecc16c4fb3c6dfc11c4d2e4",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": []
},
"captureStatus": "UNCAPTURED",
"amountCaptured": 0,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"transactiontransfers": [
{
"destinationWalletId": "654b389f-e14f-46bd-a46d-23c2ed583f72",
"escrowDate": "2021-09-10",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": "MANDATORY",
"lastName": "MANDATORY",
"phone": null,
"postalCode": null
},
"dispute": null,
"cardPresent": [],
"clearingNumber": null,
"merchantCategoryCode": "6012",
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": null,
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": null,
"authorizationMovementId": "e496789a-1b0c-4b5e-ad6b-74fff88a68a6",
"cancelMovementId": null,
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"customAcceptanceData": [],
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}PAYMENTREQUEST_TRANSACTION_SUCCEEDED
{
"transactionId": "9b9cc883-08cb-454a-9efc-188731512e6d",
"creationDate": "2021-09-09T15:07:25.773036+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": "test",
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulation : Transaction Approved",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": "test",
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 18000,
"commission": 2700,
"fee": 1000,
"amount": 18000,
"partialAuthorization": false,
"partialAuthorized": false,
"partialAuthorizedAmount": null,
"totalAmount": 18000,
"card": {
"cardId": "b274fc0e-0113-4d86-bb7b-3721151e1d4a",
"creationDate": "2021-09-09T15:07:25.046180+02:00",
"customerId": null,
"cardTokenId": "2f4d57eb-d748-45df-b233-1e81f148aa30",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2021,
"country": null,
"cardholderName": null,
"cardholderEmail": "vderrier@centralpay.eu",
"description": null,
"fingerprint": "1c65b5dd653bee788c5e8e049dfccd4b9e9ca6bc",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": []
},
"captureStatus": "CAPTURED",
"amountCaptured": 18000,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "81.185.165.107",
"endUserLanguage": "fre",
"browserUserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/93.0.4577.63 Safari/537.36",
"browserAcceptLanguage": "fr_FR",
"country": null,
"receiptEmail": "vderrier@centralpay.eu",
"transactiontransfers": [],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": "vderrier@centralpay.eu",
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"cardPresent": [],
"clearingNumber": null,
"merchantCategoryCode": "6012",
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2021-09-09T15:07:26.260397+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "4c168997-eb78-4796-b530-f563d54530d7",
"authorizationMovementId": "54c65cde-38c2-46f0-b7d2-dac91a7daba9",
"cancelMovementId": null,
"paymentRequestBreakdownId": "faa3c0c0-bb8c-459d-8b79-b920dd421836",
"paymentRequestId": "ae19a56b-74f3-4f13-ac30-05d643eb7f42",
"customAcceptanceData": [],
"additionalData": []
}PAYMENTREQUEST_WIRE_TRANSFER_SUCCEEDED
{
"wireTransferId": "686a73b4-bbaf-489a-b8b9-4413279550d6",
"creationDate": "2021-05-27T14:39:41.009383+02:00",
"receiptDate": "2021-08-02T15:45:56.923139+02:00",
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "test cci",
"status": "RECEIVED",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "TEPQFDISB1MYNFV",
"description": "test virement",
"currency": "EUR",
"amount": 500000,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 500000,
"commission": 0,
"fee": 0,
"processed": true,
"processedDate": "2021-08-02T15:45:56.923139+02:00",
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "26ebb904-acb0-435d-9d8e-d1a53b2536b5",
"cancelMovementId": null,
"paymentRequestBreakdownId": "1abe16e7-ac36-4647-b38b-8cd2cb7b6350",
"paymentRequestId": "35efdb38-30ff-4879-be64-c1ad2cfce63e",
"additionalData": []
}The PAYMENT REQUEST object
PAYMENTREQUEST_CREATED
Happen when a payment request is created
Happen when a payment request is created
PAYMENTREQUEST_CANCELED
Happen when a payment request is cancelled
Happen when a payment request is cancelled
PAYMENTREQUEST_CLOSED
Happen when a payment request is closed
Happen when a payment request is closed
PAYMENTREQUEST_PAID
Happen when a payment request is paid
Happen when a payment request is paid
PAYMENTREQUEST_INSTALLMENT_FAILED
Happen when the installment of the payment request failed
Happen when the installment of the payment request failed
PAYMENTREQUEST_INSTALLMENT_SUCCEEDED
Happen when the installment of the payment request succeeded
Happen when the installment of the payment request succeeded
PAYMENTREQUEST_SUBSCRIPTION_FAILED
Happen when the subscription of the payment request failed
Happen when the subscription of the payment request failed
PAYMENTREQUEST_SUBSCRIPTION_SUCCEEDED
Happen when the subscription of the payment request succeeded
Happen when the subscription of the payment request succeeded
PAYMENTREQUEST_TRANSACTION_FAILED
Happen when the transaction of the payment request failed
Happen when the transaction of the payment request failed
PAYMENTREQUEST_TRANSACTION_SUCCEEDED
Happen when the transaction of the payment request succeeded
Happen when the transaction of the payment request succeeded
PAYMENTREQUEST_WIRE_TRANSFER_SUCCEEDED
Happen when the wire transfer of the payment request succeeded
Happen when the wire transfer of the payment request succeeded
PAYMENTREQUEST_CREATED
{
"paymentRequestId": "76aa4749-ba80-426b-96a0-0d9c65130043",
"creationDate": "2021-09-15T11:55:30.659900+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": null,
"linkExpirationDate": null,
"endingDate": null,
"scenarioId": null,
"scenarioStartingDate": null,
"scenarios": [],
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "ACTIVE",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"TRANSACTION"
],
"transaction": {
"paymentRequestTransactionId": "66707a47-6ba7-4bfb-ae29-d4b419d48904",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"receiptEmail": null,
"source": "EC",
"capture": true,
"customAcceptanceData": []
},
"installment": null,
"subscription": null,
"sdd": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "5d1cf887-dff0-4182-81a0-b1cc99313c04",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 100000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/a9f7c854-f65b-4238-9c21-af65550eec9b",
"email": "jonh@gmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": false,
"paymentAttempted": false,
"paid": false,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": null,
"amount": 100000,
"fee": 0,
"merchantTransferId": null
}
],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": []
}PAYMENTREQUEST_CANCELED
{
"paymentRequestId": "b575ee42-3cc6-4353-9275-99ae38b6b70d",
"creationDate": "2021-09-10T09:25:43.021954+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": null,
"linkExpirationDate": null,
"endingDate": "2021-09-10T09:26:12.226586+02:00",
"scenarioId": null,
"scenarioStartingDate": null,
"scenarios": [],
"paymentFormTemplateId": null,
"merchantPaymentRequestId": "test",
"description": null,
"currency": "EUR",
"totalAmount": 95000,
"paymentRequestStatus": "CANCELED",
"paymentStatus": "UNPAID",
"createCustomer": true,
"paymentMethods": [
"INSTALLMENT"
],
"transaction": null,
"installment": {
"paymentRequestInstallmentId": "90e3fd45-808d-4936-af9c-fb6136d5d2c2",
"depositStartingDate": null,
"startingDate": null,
"creditorBankAccountId": null,
"ultimateCreditorIdentityId": null,
"depositAmount": 0,
"feeAmount": null,
"intervalUnit": "MONTH",
"intervalCount": 91,
"iterationCount": 12,
"source": "CARD",
"rum": null,
"endToEndIdentification": null,
"remittanceInformation": null,
"requestedCollectionDate": null
},
"subscription": null,
"sdd": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "7f41d2ff-33ba-4957-8e5c-d69ac2b67b1e",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 95000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/610f2c25-b076-4c2e-9a17-4813521255dc",
"email": "abonnet@centralpay.eu",
"phone": null,
"firstName": "",
"lastName": "",
"entered": true,
"paymentAttempted": false,
"paid": false,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "fre",
"redirectUrl": null,
"closeComment": null,
"additionalData": []
}PAYMENTREQUEST_CLOSED
{
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"creationDate": "2021-09-13T14:32:11.649077+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"cardId": null,
"paymentRequestBreakdownId": "cae61277-18fa-4847-bf6a-ad2b8f54e7d9",
"paymentRequestId": "8703d6a2-3c05-4340-9227-fe962ffd2620",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"depositStartingDate": null,
"startingDate": "2021-09-13",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": null,
"endUserIp": "91.229.230.41",
"endUserLanguage": null,
"amount": 1235835,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 2,
"iterationCount": 2,
"status": "ACTIVE",
"endToEndIdentification": null,
"remittanceInformation": "49C8A75C41DE",
"installments": [
{
"installmentId": "ed9db4e8-f55c-4de2-9c24-be268402cd5b",
"creationDate": "2021-09-13T14:32:11.648281+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617918,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"af37becb-ea9e-49dc-9759-bf923d2825a1"
]
},
{
"installmentId": "95a48d1a-6117-4898-9c35-92d027b6127c",
"creationDate": "2021-09-13T14:32:11.649033+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617917,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-27T08:00+02:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}PAYMENTREQUEST_PAID
{
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"creationDate": "2021-09-13T14:32:11.649077+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"cardId": null,
"paymentRequestBreakdownId": "cae61277-18fa-4847-bf6a-ad2b8f54e7d9",
"paymentRequestId": "8703d6a2-3c05-4340-9227-fe962ffd2620",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"depositStartingDate": null,
"startingDate": "2021-09-13",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": null,
"endUserIp": "91.229.230.41",
"endUserLanguage": null,
"amount": 1235835,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 2,
"iterationCount": 2,
"status": "ACTIVE",
"endToEndIdentification": null,
"remittanceInformation": "49C8A75C41DE",
"installments": [
{
"installmentId": "ed9db4e8-f55c-4de2-9c24-be268402cd5b",
"creationDate": "2021-09-13T14:32:11.648281+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617918,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"af37becb-ea9e-49dc-9759-bf923d2825a1"
]
},
{
"installmentId": "95a48d1a-6117-4898-9c35-92d027b6127c",
"creationDate": "2021-09-13T14:32:11.649033+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617917,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-27T08:00+02:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}PAYMENTREQUEST_INSTALLMENT_FAILED
{
"installmentPaymentId": "23717917-f981-46f1-91fe-51fddf012dc1",
"creationDate": "2021-09-08T09:40:38.410270+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"cardId": "63afa65e-5674-49bf-9ac3-a98b82d16e92",
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"mandateId": null,
"depositStartingDate": null,
"startingDate": "2021-09-08",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": "MIP_001",
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"amount": 1000,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 2,
"status": "ACTIVE",
"endToEndIdentification": null,
"remittanceInformation": null,
"installments": [
{
"installmentId": "48e602fc-4698-4c88-bcdf-37354a4ee809",
"creationDate": "2021-09-08T09:40:38.410203+02:00",
"installmentPaymentId": "23717917-f981-46f1-91fe-51fddf012dc1",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"mandateId": null,
"amount": 500,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [
"d93c6657-e449-4cb6-8da9-b3610b6c93ca"
],
"sddTransactions": []
},
{
"installmentId": "794e76d0-26b5-4cab-a624-9ef1401fe1dd",
"creationDate": "2021-09-08T09:40:38.410238+02:00",
"installmentPaymentId": "23717917-f981-46f1-91fe-51fddf012dc1",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"mandateId": null,
"amount": 500,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-10-08T08:00+02:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": {
"Key1": "val1"
}
}PAYMENTREQUEST_INSTALLMENT_SUCCEEDED
{
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"creationDate": "2021-09-13T14:32:11.649077+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"cardId": null,
"paymentRequestBreakdownId": "cae61277-18fa-4847-bf6a-ad2b8f54e7d9",
"paymentRequestId": "8703d6a2-3c05-4340-9227-fe962ffd2620",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"depositStartingDate": null,
"startingDate": "2021-09-13",
"requestedCollectionDate": null,
"merchantInstallmentPaymentId": null,
"endUserIp": "91.229.230.41",
"endUserLanguage": null,
"amount": 1235835,
"depositAmount": 0,
"feeAmount": 0,
"currency": "EUR",
"description": null,
"intervalUnit": "WEEK",
"intervalCount": 2,
"iterationCount": 2,
"status": "ACTIVE",
"endToEndIdentification": null,
"remittanceInformation": "49C8A75C41DE",
"installments": [
{
"installmentId": "ed9db4e8-f55c-4de2-9c24-be268402cd5b",
"creationDate": "2021-09-13T14:32:11.648281+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617918,
"currency": "EUR",
"attemptCount": 1,
"paid": true,
"type": "INSTALLMENT",
"nextTransactionAttempt": null,
"transactions": [],
"sddTransactions": [
"af37becb-ea9e-49dc-9759-bf923d2825a1"
]
},
{
"installmentId": "95a48d1a-6117-4898-9c35-92d027b6127c",
"creationDate": "2021-09-13T14:32:11.649033+02:00",
"installmentPaymentId": "d2e64b9e-f06c-42ec-a726-2e88fe81b310",
"customerId": "630b1c85-d390-481a-84b5-7be97cfac416",
"mandateId": "67fcec5e-c97b-44f8-8255-5d4a00f65543",
"amount": 617917,
"currency": "EUR",
"attemptCount": 0,
"paid": false,
"type": "INSTALLMENT",
"nextTransactionAttempt": "2021-09-27T08:00+02:00",
"transactions": [],
"sddTransactions": []
}
],
"additionalData": []
}PAYMENTREQUEST_SUBSCRIPTION_FAILED
{
"subscriptionId": "26815c6a-19fe-49bd-b619-f14719f3e4ba",
"creationDate": "2021-09-08T09:39:06.212604+02:00",
"walletId": null,
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"cardId": "63afa65e-5674-49bf-9ac3-a98b82d16e92",
"mandateId": null,
"startingDate": "2021-09-08",
"endingDate": null,
"expectedEndingDate": "2022-09-07",
"currentPeriodStart": "2021-09-08",
"currentPeriodEnd": "2021-10-07",
"requestedCollectionDate": null,
"cancellationDate": null,
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"merchantSubscriptionId": null,
"subscriptionModel": {
"subscriptionModelId": "01c3f578-a589-4ef7-9bb6-d855ff0fa121",
"creationDate": "2021-09-08T09:39:06.137368+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": null,
"amount": 10000,
"currency": "EUR",
"name": "Test Abo",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 12,
"additionalData": []
},
"quantity": 1,
"status": "ACTIVE",
"cancelAtPeriodEnd": null,
"lastInvoice": {
"invoiceId": "da0622d1-723b-4567-ad40-917a92a84e05",
"creationDate": "2021-09-08T09:39:06.562016+02:00",
"subscriptionId": "26815c6a-19fe-49bd-b619-f14719f3e4ba",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceId": null,
"amount": 10000,
"currency": "EUR",
"closed": true,
"invoiceItems": [
{
"invoiceItemId": "e8b03ea3-85ca-4e85-ab3d-6b1c83122508",
"creationDate": "2021-09-08T09:39:06.469080+02:00",
"invoiceId": "da0622d1-723b-4567-ad40-917a92a84e05",
"subscriptionId": "26815c6a-19fe-49bd-b619-f14719f3e4ba",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 10000,
"totalAmount": 10000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 1,
"paid": true,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": null,
"transactions": [
"d0bcd686-1b6b-45aa-bf8a-c4cedab81127"
],
"transfers": [],
"sddTransactions": [],
"eventReceivedDate": null,
"additionalData": []
},
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"endToEndIdentification": null,
"remittanceInformation": null,
"redirect": null,
"additionalData": []
}PAYMENTREQUEST_SUBSCRIPTION_SUCCEEDED
{
"subscriptionId": "da6a4622-4e5d-4da5-8d29-6c49d4052b69",
"creationDate": "2021-09-09T10:32:15.675280+02:00",
"walletId": null,
"customerId": "2f2e6ce9-e0bb-4377-8eb9-6a8506c0baa4",
"cardId": null,
"mandateId": "b08bb9e0-72e4-426a-9998-585f083338fc",
"startingDate": "2021-09-09",
"endingDate": null,
"expectedEndingDate": null,
"currentPeriodStart": "2021-09-09",
"currentPeriodEnd": "2021-10-08",
"requestedCollectionDate": "2021-09-15",
"cancellationDate": null,
"paymentRequestBreakdownId": "825c03a4-fa3e-4df0-812d-f3d094f88ca3",
"paymentRequestId": "ef4bf0e4-c77c-42a3-910e-b85e84b3c92b",
"merchantSubscriptionId": null,
"subscriptionModel": {
"subscriptionModelId": "b1561842-46c1-422c-84a6-69ea8e1c8051",
"creationDate": "2017-05-10T09:20:14.268+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": "a00e2d1b-87a1-4fb2-8e15-5d6132006d5b",
"amount": 2000,
"currency": "EUR",
"name": "premium",
"description": "abbonnement premium",
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": null,
"additionalData": []
},
"quantity": 1,
"status": "ACTIVE",
"cancelAtPeriodEnd": null,
"lastInvoice": {
"invoiceId": "e257896b-86a1-41cf-865b-ac0531e2ea4a",
"creationDate": "2021-09-09T10:32:16.072897+02:00",
"subscriptionId": "da6a4622-4e5d-4da5-8d29-6c49d4052b69",
"customerId": "2f2e6ce9-e0bb-4377-8eb9-6a8506c0baa4",
"walletId": null,
"mandateId": "b08bb9e0-72e4-426a-9998-585f083338fc",
"merchantInvoiceId": null,
"amount": 2000,
"currency": "EUR",
"closed": true,
"invoiceItems": [
{
"invoiceItemId": "0dabd4f2-6e36-4731-989a-d00bdf93e748",
"creationDate": "2021-09-09T10:32:15.860404+02:00",
"invoiceId": "e257896b-86a1-41cf-865b-ac0531e2ea4a",
"subscriptionId": "da6a4622-4e5d-4da5-8d29-6c49d4052b69",
"customerId": "2f2e6ce9-e0bb-4377-8eb9-6a8506c0baa4",
"walletId": null,
"mandateId": "b08bb9e0-72e4-426a-9998-585f083338fc",
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 2000,
"totalAmount": 2000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 1,
"paid": true,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": null,
"transactions": [],
"transfers": [],
"sddTransactions": [
"0fd0d6cb-076a-4df5-9e89-7a62b74791e8"
],
"eventReceivedDate": null,
"additionalData": []
},
"endUserIp": "92.154.127.221",
"endUserLanguage": null,
"endToEndIdentification": null,
"remittanceInformation": "PREMIUM",
"redirect": null,
"additionalData": []
}PAYMENTREQUEST_TRANSACTION_FAILED
{
"transactionId": "1d5650f1-8ec5-4280-8b4a-12038ebbc30d",
"creationDate": "2021-09-08T09:39:45.432609+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "FAILURE",
"authorizationStatus": "FAILURE",
"bankCode": "5",
"bankMessage": "Simulation : Do Not Honour",
"authorizationCode": null,
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": null,
"commission": null,
"fee": 500,
"amount": 10,
"partialAuthorization": false,
"partialAuthorized": false,
"partialAuthorizedAmount": null,
"totalAmount": 10,
"card": {
"cardId": "5e7cebc9-af26-4f87-b853-8c9eefad5ec4",
"creationDate": "2021-09-08T09:39:45.657797+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0085",
"expirationMonth": 1,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "3d4059579d3fc46f0ecc16c4fb3c6dfc11c4d2e4",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": []
},
"captureStatus": "UNCAPTURED",
"amountCaptured": 0,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"transactiontransfers": [
{
"destinationWalletId": "654b389f-e14f-46bd-a46d-23c2ed583f72",
"escrowDate": "2021-09-10",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": "MANDATORY",
"lastName": "MANDATORY",
"phone": null,
"postalCode": null
},
"dispute": null,
"cardPresent": [],
"clearingNumber": null,
"merchantCategoryCode": "6012",
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": null,
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": null,
"authorizationMovementId": "e496789a-1b0c-4b5e-ad6b-74fff88a68a6",
"cancelMovementId": null,
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"customAcceptanceData": [],
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}PAYMENTREQUEST_TRANSACTION_SUCCEEDED
{
"transactionId": "9b9cc883-08cb-454a-9efc-188731512e6d",
"creationDate": "2021-09-09T15:07:25.773036+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": "test",
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulation : Transaction Approved",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": "test",
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 18000,
"commission": 2700,
"fee": 1000,
"amount": 18000,
"partialAuthorization": false,
"partialAuthorized": false,
"partialAuthorizedAmount": null,
"totalAmount": 18000,
"card": {
"cardId": "b274fc0e-0113-4d86-bb7b-3721151e1d4a",
"creationDate": "2021-09-09T15:07:25.046180+02:00",
"customerId": null,
"cardTokenId": "2f4d57eb-d748-45df-b233-1e81f148aa30",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2021,
"country": null,
"cardholderName": null,
"cardholderEmail": "vderrier@centralpay.eu",
"description": null,
"fingerprint": "1c65b5dd653bee788c5e8e049dfccd4b9e9ca6bc",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": []
},
"captureStatus": "CAPTURED",
"amountCaptured": 18000,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "81.185.165.107",
"endUserLanguage": "fre",
"browserUserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/93.0.4577.63 Safari/537.36",
"browserAcceptLanguage": "fr_FR",
"country": null,
"receiptEmail": "vderrier@centralpay.eu",
"transactiontransfers": [],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": "vderrier@centralpay.eu",
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"cardPresent": [],
"clearingNumber": null,
"merchantCategoryCode": "6012",
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2021-09-09T15:07:26.260397+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "4c168997-eb78-4796-b530-f563d54530d7",
"authorizationMovementId": "54c65cde-38c2-46f0-b7d2-dac91a7daba9",
"cancelMovementId": null,
"paymentRequestBreakdownId": "faa3c0c0-bb8c-459d-8b79-b920dd421836",
"paymentRequestId": "ae19a56b-74f3-4f13-ac30-05d643eb7f42",
"customAcceptanceData": [],
"additionalData": []
}PAYMENTREQUEST_WIRE_TRANSFER_SUCCEEDED
{
"wireTransferId": "686a73b4-bbaf-489a-b8b9-4413279550d6",
"creationDate": "2021-05-27T14:39:41.009383+02:00",
"receiptDate": "2021-08-02T15:45:56.923139+02:00",
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "test cci",
"status": "RECEIVED",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "TEPQFDISB1MYNFV",
"description": "test virement",
"currency": "EUR",
"amount": 500000,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 500000,
"commission": 0,
"fee": 0,
"processed": true,
"processedDate": "2021-08-02T15:45:56.923139+02:00",
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "26ebb904-acb0-435d-9d8e-d1a53b2536b5",
"cancelMovementId": null,
"paymentRequestBreakdownId": "1abe16e7-ac36-4647-b38b-8cd2cb7b6350",
"paymentRequestId": "35efdb38-30ff-4879-be64-c1ad2cfce63e",
"additionalData": []
}PAYOUT_CREATED, 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
{
"payoutId": "73c4e995-a234-40ff-befb-be0b1873592c",
"creationDate": "2021-09-08T09:41:04.846132+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": null,
"expectedArrivalDate": "2021-09-10",
"arrivalDate": null,
"merchantPayoutId": "Up_Test_Doc",
"currency": "EUR",
"amount": 1,
"fee": 1200,
"net": 1201,
"description": "ma description",
"status": "PENDING",
"automatic": false,
"payoutReference": "PAYOUT-20210908094104",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "50371552-3911-47f4-92ed-067b021d8410",
"cancelMovementId": null,
"additionalData": []
}PAYOUT_CANCELED
{
"payoutId": "73c4e995-a234-40ff-befb-be0b1873592c",
"creationDate": "2021-09-08T09:41:04.846132+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": "2021-09-08T09:41:05.346348+02:00",
"expectedArrivalDate": "2021-09-10",
"arrivalDate": null,
"merchantPayoutId": "Up_Test_Doc",
"currency": "EUR",
"amount": 1,
"fee": 1200,
"net": 1201,
"description": "ma description",
"status": "CANCEL",
"automatic": false,
"payoutReference": "PAYOUT-20210908094104",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "50371552-3911-47f4-92ed-067b021d8410",
"cancelMovementId": "f8b3dbce-14ab-420e-94c4-73ee9790763f",
"additionalData": []
}PAYOUT_PAID, 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": []
}The PAYOUT object
PAYOUT_CREATED
When a payout will be asked.
When a payout will be asked.
PAYOUT_UPDATED
When an ongoing payout has been updated.
When an ongoing payout has been updated.
PAYOUT_CANCELED
When an ongoing payout has been canceled.
When an ongoing payout has been canceled.
PAYOUT_PAID
When an ongoing payout has been properly executed.
When an ongoing payout has been properly executed.
PAYOUT_CREATED, 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
{
"payoutId": "73c4e995-a234-40ff-befb-be0b1873592c",
"creationDate": "2021-09-08T09:41:04.846132+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": null,
"expectedArrivalDate": "2021-09-10",
"arrivalDate": null,
"merchantPayoutId": "Up_Test_Doc",
"currency": "EUR",
"amount": 1,
"fee": 1200,
"net": 1201,
"description": "ma description",
"status": "PENDING",
"automatic": false,
"payoutReference": "PAYOUT-20210908094104",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "50371552-3911-47f4-92ed-067b021d8410",
"cancelMovementId": null,
"additionalData": []
}PAYOUT_CANCELED
{
"payoutId": "73c4e995-a234-40ff-befb-be0b1873592c",
"creationDate": "2021-09-08T09:41:04.846132+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": "2021-09-08T09:41:05.346348+02:00",
"expectedArrivalDate": "2021-09-10",
"arrivalDate": null,
"merchantPayoutId": "Up_Test_Doc",
"currency": "EUR",
"amount": 1,
"fee": 1200,
"net": 1201,
"description": "ma description",
"status": "CANCEL",
"automatic": false,
"payoutReference": "PAYOUT-20210908094104",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "50371552-3911-47f4-92ed-067b021d8410",
"cancelMovementId": "f8b3dbce-14ab-420e-94c4-73ee9790763f",
"additionalData": []
}PAYOUT_PAID, 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": []
}REFUND_CREATED
{
"refundId": "3c349da5-c144-424b-bbdd-6f756b43c4ee",
"creationDate": "2021-09-08T09:40:42.140717+02:00",
"transactionId": "9c6ffb50-11cf-418c-9c9f-57a3fba20c20",
"clearingDate": null,
"cancellationDate": null,
"merchantRefundId": null,
"currency": "EUR",
"amount": 1,
"payoutCurrency": "EUR",
"payoutAmount": 1,
"commission": 0,
"fee": 0,
"description": "ma description",
"status": "UNCLEARED",
"movementId": "8981c46d-1e9e-4501-b78c-2d3e6e313fda",
"cancelMovementId": null,
"additionalData": []
}REFUND_CANCELED
{
"refundId": "3c349da5-c144-424b-bbdd-6f756b43c4ee",
"creationDate": "2021-09-08T09:40:42.140717+02:00",
"transactionId": "9c6ffb50-11cf-418c-9c9f-57a3fba20c20",
"clearingDate": null,
"cancellationDate": "2021-09-08T09:40:42.646025+02:00",
"merchantRefundId": null,
"currency": "EUR",
"amount": 1,
"payoutCurrency": "EUR",
"payoutAmount": 1,
"commission": 0,
"fee": 0,
"description": "ma description",
"status": "CANCELED",
"movementId": "8981c46d-1e9e-4501-b78c-2d3e6e313fda",
"cancelMovementId": "b315d96f-8dc0-437d-af5f-729a8c0bb502",
"additionalData": []
}The REFUND object
REFUND_CREATED
When a refund is created
When a refund is created
REFUND_CANCELED
When a refund is cancelled
When a refund is cancelled
REFUND_CREATED
{
"refundId": "3c349da5-c144-424b-bbdd-6f756b43c4ee",
"creationDate": "2021-09-08T09:40:42.140717+02:00",
"transactionId": "9c6ffb50-11cf-418c-9c9f-57a3fba20c20",
"clearingDate": null,
"cancellationDate": null,
"merchantRefundId": null,
"currency": "EUR",
"amount": 1,
"payoutCurrency": "EUR",
"payoutAmount": 1,
"commission": 0,
"fee": 0,
"description": "ma description",
"status": "UNCLEARED",
"movementId": "8981c46d-1e9e-4501-b78c-2d3e6e313fda",
"cancelMovementId": null,
"additionalData": []
}REFUND_CANCELED
{
"refundId": "3c349da5-c144-424b-bbdd-6f756b43c4ee",
"creationDate": "2021-09-08T09:40:42.140717+02:00",
"transactionId": "9c6ffb50-11cf-418c-9c9f-57a3fba20c20",
"clearingDate": null,
"cancellationDate": "2021-09-08T09:40:42.646025+02:00",
"merchantRefundId": null,
"currency": "EUR",
"amount": 1,
"payoutCurrency": "EUR",
"payoutAmount": 1,
"commission": 0,
"fee": 0,
"description": "ma description",
"status": "CANCELED",
"movementId": "8981c46d-1e9e-4501-b78c-2d3e6e313fda",
"cancelMovementId": "b315d96f-8dc0-437d-af5f-729a8c0bb502",
"additionalData": []
}MANDATE_CREATED
{
"mandateId": "b226fcc8-2b00-4ce3-b37b-c5d131cc9130",
"pdfFileId": null,
"debtorBankAccountId": "d5235b6e-5bda-47ea-b03d-40010e8ded81",
"creditorBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"ultimateCreditorIdentityId": "a6bf0982-0ecf-4c75-8d00-6cc0ed08f63a",
"ultimateDebtorIdentityId": null,
"customerId": "8e528393-9664-43f0-836b-df66c2c05811",
"obsolescenceDate": null,
"signatureDate": null,
"otpExpirationDate": "2021-09-13T16:43:04.561524+02:00",
"creationDate": "2021-09-13T16:28:04.559768+02:00",
"merchantMandateId": null,
"status": "PENDING",
"rum": "QKWPG4ANM",
"description": "ma description",
"otpExpired": false,
"signatureCity": null,
"signatureIpAddress": null,
"paymentType": "PUCT",
"debtorPhone": "+33625079245",
"debtorEmail": "crichard@centralpay.eu",
"additionalData": [],
"sddTransactions": []
}MANDATE_SIGNED
{
"mandateId": "b226fcc8-2b00-4ce3-b37b-c5d131cc9130",
"pdfFileId": "6f18fee9-eb29-4d6b-b108-96c1df67b4da",
"debtorBankAccountId": "d5235b6e-5bda-47ea-b03d-40010e8ded81",
"creditorBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"ultimateCreditorIdentityId": "a6bf0982-0ecf-4c75-8d00-6cc0ed08f63a",
"ultimateDebtorIdentityId": null,
"customerId": "8e528393-9664-43f0-836b-df66c2c05811",
"obsolescenceDate": null,
"signatureDate": "2021-09-13T16:28:07.876188+02:00",
"otpExpirationDate": "2021-09-13T16:43:04.561524+02:00",
"creationDate": "2021-09-13T16:28:04.559768+02:00",
"merchantMandateId": null,
"status": "ACTIVE",
"rum": "QKWPG4ANM",
"description": "ma description",
"otpExpired": false,
"signatureCity": "TOURS",
"signatureIpAddress": "245.100.1.15",
"paymentType": "PUCT",
"debtorPhone": "+33625079245",
"debtorEmail": "crichard@centralpay.eu",
"additionalData": [],
"sddTransactions": []
}MANDATE_OBSOLETED
{
"mandateId": "9620eabb-c7bb-4e6a-b379-4246f9473f11",
"pdfFileId": "9f7f74b9-599d-472f-ab74-6d04e3fccc68",
"debtorBankAccountId": "2b91e9e4-b88a-4200-a183-32dd6d3a900e",
"creditorBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"ultimateCreditorIdentityId": "a6bf0982-0ecf-4c75-8d00-6cc0ed08f63a",
"ultimateDebtorIdentityId": null,
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"obsolescenceDate": "2021-09-08T09:41:01.884022+02:00",
"signatureDate": "2021-09-08T09:41:01.404436+02:00",
"otpExpirationDate": "2021-09-08T09:56:00.920946+02:00",
"creationDate": "2021-09-08T09:40:44.453698+02:00",
"merchantMandateId": null,
"status": "OBSOLETE",
"rum": "XMNYK7UFW",
"description": "ma description",
"otpExpired": false,
"signatureCity": "ST-JEAN-LE-BLANC",
"signatureIpAddress": "245.100.1.15",
"paymentType": "PUCT",
"debtorPhone": "+33625079245",
"debtorEmail": "abonnet@centralpay.eu",
"additionalData": [],
"sddTransactions": []
}SDDTRANSACTION_CREATED
{
"sddTransactionId": "d448d4a7-2873-4c0e-8f6e-7c475a425581",
"creationDate": "2021-09-08T09:41:03.716332+02:00",
"notificationDate": null,
"validationDate": null,
"requestedCollectionDate": "2021-09-10",
"cancellationDate": null,
"otpExpirationDate": "2021-09-08T09:56:03.718482+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"mandateId": "8fd694b4-874c-4229-811e-7e13cd1ae918",
"sddPaymentId": null,
"movementId": "122c481d-ea23-42eb-9821-b72abec55bec",
"cancelMovementId": null,
"paymentRequestBreakdownId": null,
"merchantSddTransactionId": null,
"description": null,
"endToEndIdentification": "+NBKX33LV",
"instructionIdentification": null,
"remittanceInformation": "TEST",
"amount": 1,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 1,
"commission": 0,
"fee": 0,
"sequenceType": "RCUR",
"automaticValidation": false,
"endUserIp": "245.100.1.15",
"status": "PENDING",
"otpExpired": false,
"transferGroup": null,
"transactionTransfers": [],
"additionalData": []
}SDDTRANSACTION_VALIDATED
{
"sddTransactionId": "3af0aca0-a112-4f2e-a688-6cc54957d0af",
"creationDate": "2021-09-16T08:01:38.646515+02:00",
"notificationDate": null,
"validationDate": "2021-09-16T08:01:38.648044+02:00",
"requestedCollectionDate": "2021-09-30",
"cancellationDate": null,
"otpExpirationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"mandateId": "e03124c5-69e4-4f0e-86c5-df4b0ce79df9",
"sddPaymentId": null,
"movementId": "76ce2a82-bd3f-458a-bbc1-3c0b522fca81",
"cancelMovementId": null,
"paymentRequestBreakdownId": null,
"merchantSddTransactionId": null,
"description": null,
"endToEndIdentification": "SDD-677BD7D0-7DFA-4B1F-B4E8",
"instructionIdentification": null,
"remittanceInformation": "67E0223B52BB",
"amount": 2500,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 2500,
"commission": 58,
"fee": 530,
"sequenceType": "RCUR",
"automaticValidation": true,
"endUserIp": "92.154.127.221",
"status": "ACTIVE",
"otpExpired": false,
"transferGroup": null,
"transactionTransfers": [],
"additionalData": []
}SDDTRANSACTION_CANCELED
{
"sddTransactionId": "b18fdb6d-d157-48d1-8ae0-895f2eb6386f",
"creationDate": "2021-09-08T09:41:03.138643+02:00",
"notificationDate": null,
"validationDate": null,
"requestedCollectionDate": "2021-09-10",
"cancellationDate": "2021-09-08T09:41:03.445942+02:00",
"otpExpirationDate": "2021-09-08T09:56:03.139784+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"mandateId": "8fd694b4-874c-4229-811e-7e13cd1ae918",
"sddPaymentId": null,
"movementId": "1957268f-2716-4240-948b-ea1659434ad7",
"cancelMovementId": "920fc9f9-0896-4825-a585-6b0c8438b61a",
"paymentRequestBreakdownId": null,
"merchantSddTransactionId": null,
"description": null,
"endToEndIdentification": "MJQKNVNCL",
"instructionIdentification": null,
"remittanceInformation": "TEST",
"amount": 1,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 1,
"commission": 0,
"fee": 0,
"sequenceType": "RCUR",
"automaticValidation": false,
"endUserIp": "245.100.1.15",
"status": "CANCELED",
"otpExpired": false,
"transferGroup": null,
"transactionTransfers": [],
"additionalData": []
}
BANKACCOUNT_ACCEPTED
{
"name": "AXA-TEST",
"description": "ma description",
"ownerName": "DOCTEST",
"ownerAddress": "16 RUE DES LAVANDES 45650 ST JEAN LE BLANC",
"ownerDescription": null,
"ownerPostalCode": "37000",
"ownerCity": "TOURS",
"ownerCountry": "FRA",
"iban": "FR7612548029980000000150086",
"bic": "AXABFRPP",
"currency": "EUR",
"type": "CUSTOMER_ACCOUNT",
"bankAccountId": "d5235b6e-5bda-47ea-b03d-40010e8ded81",
"customerId": "8e528393-9664-43f0-836b-df66c2c05811",
"creationDate": "2021-09-13T16:27:56.969060+02:00"
}The SDD TRANSACTION object
MANDATE_CREATED
When a mandate is created
When a mandate is created
MANDATE_SIGNED
When a mandate is signed
When a mandate is signed
MANDATE_OBSOLETED
When a mandate is obsolete
When a mandate is obsolete
SDDTRANSACTION_CREATED
When a SDD Transaction is created
When a SDD Transaction is created
SDDTRANSACTION_VALIDATED
When a SDD Transaction is validated
When a SDD Transaction is validated
SDDTRANSACTION_CANCELED
When a SDD Transaction is cancelled
When a SDD Transaction is cancelled
BANKACCOUNT_ACCEPTED
When a Bank Account is accepted
When a Bank Account is accepted
MANDATE_CREATED
{
"mandateId": "b226fcc8-2b00-4ce3-b37b-c5d131cc9130",
"pdfFileId": null,
"debtorBankAccountId": "d5235b6e-5bda-47ea-b03d-40010e8ded81",
"creditorBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"ultimateCreditorIdentityId": "a6bf0982-0ecf-4c75-8d00-6cc0ed08f63a",
"ultimateDebtorIdentityId": null,
"customerId": "8e528393-9664-43f0-836b-df66c2c05811",
"obsolescenceDate": null,
"signatureDate": null,
"otpExpirationDate": "2021-09-13T16:43:04.561524+02:00",
"creationDate": "2021-09-13T16:28:04.559768+02:00",
"merchantMandateId": null,
"status": "PENDING",
"rum": "QKWPG4ANM",
"description": "ma description",
"otpExpired": false,
"signatureCity": null,
"signatureIpAddress": null,
"paymentType": "PUCT",
"debtorPhone": "+33625079245",
"debtorEmail": "crichard@centralpay.eu",
"additionalData": [],
"sddTransactions": []
}MANDATE_SIGNED
{
"mandateId": "b226fcc8-2b00-4ce3-b37b-c5d131cc9130",
"pdfFileId": "6f18fee9-eb29-4d6b-b108-96c1df67b4da",
"debtorBankAccountId": "d5235b6e-5bda-47ea-b03d-40010e8ded81",
"creditorBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"ultimateCreditorIdentityId": "a6bf0982-0ecf-4c75-8d00-6cc0ed08f63a",
"ultimateDebtorIdentityId": null,
"customerId": "8e528393-9664-43f0-836b-df66c2c05811",
"obsolescenceDate": null,
"signatureDate": "2021-09-13T16:28:07.876188+02:00",
"otpExpirationDate": "2021-09-13T16:43:04.561524+02:00",
"creationDate": "2021-09-13T16:28:04.559768+02:00",
"merchantMandateId": null,
"status": "ACTIVE",
"rum": "QKWPG4ANM",
"description": "ma description",
"otpExpired": false,
"signatureCity": "TOURS",
"signatureIpAddress": "245.100.1.15",
"paymentType": "PUCT",
"debtorPhone": "+33625079245",
"debtorEmail": "crichard@centralpay.eu",
"additionalData": [],
"sddTransactions": []
}MANDATE_OBSOLETED
{
"mandateId": "9620eabb-c7bb-4e6a-b379-4246f9473f11",
"pdfFileId": "9f7f74b9-599d-472f-ab74-6d04e3fccc68",
"debtorBankAccountId": "2b91e9e4-b88a-4200-a183-32dd6d3a900e",
"creditorBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"ultimateCreditorIdentityId": "a6bf0982-0ecf-4c75-8d00-6cc0ed08f63a",
"ultimateDebtorIdentityId": null,
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"obsolescenceDate": "2021-09-08T09:41:01.884022+02:00",
"signatureDate": "2021-09-08T09:41:01.404436+02:00",
"otpExpirationDate": "2021-09-08T09:56:00.920946+02:00",
"creationDate": "2021-09-08T09:40:44.453698+02:00",
"merchantMandateId": null,
"status": "OBSOLETE",
"rum": "XMNYK7UFW",
"description": "ma description",
"otpExpired": false,
"signatureCity": "ST-JEAN-LE-BLANC",
"signatureIpAddress": "245.100.1.15",
"paymentType": "PUCT",
"debtorPhone": "+33625079245",
"debtorEmail": "abonnet@centralpay.eu",
"additionalData": [],
"sddTransactions": []
}SDDTRANSACTION_CREATED
{
"sddTransactionId": "d448d4a7-2873-4c0e-8f6e-7c475a425581",
"creationDate": "2021-09-08T09:41:03.716332+02:00",
"notificationDate": null,
"validationDate": null,
"requestedCollectionDate": "2021-09-10",
"cancellationDate": null,
"otpExpirationDate": "2021-09-08T09:56:03.718482+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"mandateId": "8fd694b4-874c-4229-811e-7e13cd1ae918",
"sddPaymentId": null,
"movementId": "122c481d-ea23-42eb-9821-b72abec55bec",
"cancelMovementId": null,
"paymentRequestBreakdownId": null,
"merchantSddTransactionId": null,
"description": null,
"endToEndIdentification": "+NBKX33LV",
"instructionIdentification": null,
"remittanceInformation": "TEST",
"amount": 1,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 1,
"commission": 0,
"fee": 0,
"sequenceType": "RCUR",
"automaticValidation": false,
"endUserIp": "245.100.1.15",
"status": "PENDING",
"otpExpired": false,
"transferGroup": null,
"transactionTransfers": [],
"additionalData": []
}SDDTRANSACTION_VALIDATED
{
"sddTransactionId": "3af0aca0-a112-4f2e-a688-6cc54957d0af",
"creationDate": "2021-09-16T08:01:38.646515+02:00",
"notificationDate": null,
"validationDate": "2021-09-16T08:01:38.648044+02:00",
"requestedCollectionDate": "2021-09-30",
"cancellationDate": null,
"otpExpirationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"mandateId": "e03124c5-69e4-4f0e-86c5-df4b0ce79df9",
"sddPaymentId": null,
"movementId": "76ce2a82-bd3f-458a-bbc1-3c0b522fca81",
"cancelMovementId": null,
"paymentRequestBreakdownId": null,
"merchantSddTransactionId": null,
"description": null,
"endToEndIdentification": "SDD-677BD7D0-7DFA-4B1F-B4E8",
"instructionIdentification": null,
"remittanceInformation": "67E0223B52BB",
"amount": 2500,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 2500,
"commission": 58,
"fee": 530,
"sequenceType": "RCUR",
"automaticValidation": true,
"endUserIp": "92.154.127.221",
"status": "ACTIVE",
"otpExpired": false,
"transferGroup": null,
"transactionTransfers": [],
"additionalData": []
}SDDTRANSACTION_CANCELED
{
"sddTransactionId": "b18fdb6d-d157-48d1-8ae0-895f2eb6386f",
"creationDate": "2021-09-08T09:41:03.138643+02:00",
"notificationDate": null,
"validationDate": null,
"requestedCollectionDate": "2021-09-10",
"cancellationDate": "2021-09-08T09:41:03.445942+02:00",
"otpExpirationDate": "2021-09-08T09:56:03.139784+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"mandateId": "8fd694b4-874c-4229-811e-7e13cd1ae918",
"sddPaymentId": null,
"movementId": "1957268f-2716-4240-948b-ea1659434ad7",
"cancelMovementId": "920fc9f9-0896-4825-a585-6b0c8438b61a",
"paymentRequestBreakdownId": null,
"merchantSddTransactionId": null,
"description": null,
"endToEndIdentification": "MJQKNVNCL",
"instructionIdentification": null,
"remittanceInformation": "TEST",
"amount": 1,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 1,
"commission": 0,
"fee": 0,
"sequenceType": "RCUR",
"automaticValidation": false,
"endUserIp": "245.100.1.15",
"status": "CANCELED",
"otpExpired": false,
"transferGroup": null,
"transactionTransfers": [],
"additionalData": []
}
BANKACCOUNT_ACCEPTED
{
"name": "AXA-TEST",
"description": "ma description",
"ownerName": "DOCTEST",
"ownerAddress": "16 RUE DES LAVANDES 45650 ST JEAN LE BLANC",
"ownerDescription": null,
"ownerPostalCode": "37000",
"ownerCity": "TOURS",
"ownerCountry": "FRA",
"iban": "FR7612548029980000000150086",
"bic": "AXABFRPP",
"currency": "EUR",
"type": "CUSTOMER_ACCOUNT",
"bankAccountId": "d5235b6e-5bda-47ea-b03d-40010e8ded81",
"customerId": "8e528393-9664-43f0-836b-df66c2c05811",
"creationDate": "2021-09-13T16:27:56.969060+02:00"
}SUBSCRIPTIONMODEL_CREATED
{
"subscriptionModelId": "01c3f578-a589-4ef7-9bb6-d855ff0fa121",
"creationDate": "2021-09-08T09:39:06.137368+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": null,
"amount": 10000,
"currency": "EUR",
"name": "Test Abo",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 12,
"additionalData": []
}SUBSCRIPTIONMODEL_UPDATED
{
"subscriptionModelId": "37cf003b-0bd7-4d70-b0b8-94a43d9c3654",
"creationDate": "2021-09-08T09:38:59.447893+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": null,
"amount": 10000,
"currency": "EUR",
"name": "CPMI",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 12,
"additionalData": []
}SUBSCRIPTION_CREATED
{
"subscriptionId": "da6a4622-4e5d-4da5-8d29-6c49d4052b69",
"creationDate": "2021-09-09T10:32:15.675280+02:00",
"walletId": null,
"customerId": "2f2e6ce9-e0bb-4377-8eb9-6a8506c0baa4",
"cardId": null,
"mandateId": "b08bb9e0-72e4-426a-9998-585f083338fc",
"startingDate": "2021-09-09",
"endingDate": null,
"expectedEndingDate": null,
"currentPeriodStart": "2021-09-09",
"currentPeriodEnd": "2021-10-08",
"requestedCollectionDate": "2021-09-15",
"cancellationDate": null,
"paymentRequestBreakdownId": "825c03a4-fa3e-4df0-812d-f3d094f88ca3",
"paymentRequestId": "ef4bf0e4-c77c-42a3-910e-b85e84b3c92b",
"merchantSubscriptionId": null,
"subscriptionModel": {
"subscriptionModelId": "b1561842-46c1-422c-84a6-69ea8e1c8051",
"creationDate": "2017-05-10T09:20:14.268+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": "a00e2d1b-87a1-4fb2-8e15-5d6132006d5b",
"amount": 2000,
"currency": "EUR",
"name": "premium",
"description": "abbonnement premium",
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": null,
"additionalData": []
},
"quantity": 1,
"status": "ACTIVE",
"cancelAtPeriodEnd": null,
"lastInvoice": {
"invoiceId": "e257896b-86a1-41cf-865b-ac0531e2ea4a",
"creationDate": "2021-09-09T10:32:16.072897+02:00",
"subscriptionId": "da6a4622-4e5d-4da5-8d29-6c49d4052b69",
"customerId": "2f2e6ce9-e0bb-4377-8eb9-6a8506c0baa4",
"walletId": null,
"mandateId": "b08bb9e0-72e4-426a-9998-585f083338fc",
"merchantInvoiceId": null,
"amount": 2000,
"currency": "EUR",
"closed": true,
"invoiceItems": [
{
"invoiceItemId": "0dabd4f2-6e36-4731-989a-d00bdf93e748",
"creationDate": "2021-09-09T10:32:15.860404+02:00",
"invoiceId": "e257896b-86a1-41cf-865b-ac0531e2ea4a",
"subscriptionId": "da6a4622-4e5d-4da5-8d29-6c49d4052b69",
"customerId": "2f2e6ce9-e0bb-4377-8eb9-6a8506c0baa4",
"walletId": null,
"mandateId": "b08bb9e0-72e4-426a-9998-585f083338fc",
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 2000,
"totalAmount": 2000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 1,
"paid": true,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": null,
"transactions": [],
"transfers": [],
"sddTransactions": [
"0fd0d6cb-076a-4df5-9e89-7a62b74791e8"
],
"eventReceivedDate": null,
"additionalData": []
},
"endUserIp": "92.154.127.221",
"endUserLanguage": null,
"endToEndIdentification": null,
"remittanceInformation": "PREMIUM",
"redirect": null,
"additionalData": []
}SUBSCRIPTION_UPDATED
{
"subscriptionId": "815f1349-a998-40c8-8858-c69ca2ce657d",
"creationDate": "2021-09-08T09:39:00.107078+02:00",
"walletId": null,
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"cardId": "63afa65e-5674-49bf-9ac3-a98b82d16e92",
"mandateId": null,
"startingDate": "2021-09-08",
"endingDate": null,
"expectedEndingDate": "2022-09-07",
"currentPeriodStart": "2021-09-08",
"currentPeriodEnd": "2021-10-07",
"requestedCollectionDate": null,
"cancellationDate": null,
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"merchantSubscriptionId": "TEST001",
"subscriptionModel": {
"subscriptionModelId": "37cf003b-0bd7-4d70-b0b8-94a43d9c3654",
"creationDate": "2021-09-08T09:38:59.447893+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": null,
"amount": 10000,
"currency": "EUR",
"name": "CPMI",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 12,
"additionalData": []
},
"quantity": 1,
"status": "ACTIVE",
"cancelAtPeriodEnd": null,
"lastInvoice": {
"invoiceId": "a70a2bca-b471-410e-93e6-9c64c5c1a647",
"creationDate": "2021-09-08T09:39:00.446631+02:00",
"subscriptionId": "815f1349-a998-40c8-8858-c69ca2ce657d",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceId": null,
"amount": 10000,
"currency": "EUR",
"closed": true,
"invoiceItems": [
{
"invoiceItemId": "5c1a58bb-7b44-44b9-ad23-a02e988b2225",
"creationDate": "2021-09-08T09:39:00.210007+02:00",
"invoiceId": "a70a2bca-b471-410e-93e6-9c64c5c1a647",
"subscriptionId": "815f1349-a998-40c8-8858-c69ca2ce657d",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 10000,
"totalAmount": 10000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 1,
"paid": true,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": null,
"transactions": [
"f2600752-e92d-4da8-be19-0e1d64dad076"
],
"transfers": [],
"sddTransactions": [],
"eventReceivedDate": null,
"additionalData": []
},
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"endToEndIdentification": null,
"remittanceInformation": null,
"redirect": null,
"additionalData": []
}SUBSCRIPTION_CANCELED
{
"subscriptionId": "f80b984e-0d99-4ec4-b3a2-8874f61909cb",
"creationDate": "2020-10-10T15:06:25.558834+02:00",
"walletId": null,
"customerId": "2853cc98-cbed-4224-8859-b2c453bf69f7",
"cardId": "1e66eadd-d659-4496-a838-4434f1d534c9",
"mandateId": null,
"startingDate": "2020-10-10",
"endingDate": "2021-10-09",
"expectedEndingDate": "2021-10-09",
"currentPeriodStart": "2021-09-10",
"currentPeriodEnd": "2021-10-09",
"requestedCollectionDate": null,
"cancellationDate": "2021-09-11T02:00:52.307831+02:00",
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"merchantSubscriptionId": null,
"subscriptionModel": {
"subscriptionModelId": "33b83f38-bf5a-4f3d-b92c-b86faeaa1f95",
"creationDate": "2020-10-10T13:16:09.581492+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": null,
"amount": 2990,
"currency": "EUR",
"name": "Abonnement_Test",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 12,
"additionalData": []
},
"quantity": 1,
"status": "ACTIVE",
"cancelAtPeriodEnd": true,
"lastInvoice": {
"invoiceId": "f97b6124-a722-49bb-b877-e1290c2d1bf5",
"creationDate": "2021-09-10T02:01:06.199983+02:00",
"subscriptionId": "f80b984e-0d99-4ec4-b3a2-8874f61909cb",
"customerId": "2853cc98-cbed-4224-8859-b2c453bf69f7",
"walletId": null,
"mandateId": null,
"merchantInvoiceId": null,
"amount": 2990,
"currency": "EUR",
"closed": false,
"invoiceItems": [
{
"invoiceItemId": "433996b6-b40a-479d-aebb-e0b3d4fbac76",
"creationDate": "2021-09-10T02:01:05.711573+02:00",
"invoiceId": "f97b6124-a722-49bb-b877-e1290c2d1bf5",
"subscriptionId": "f80b984e-0d99-4ec4-b3a2-8874f61909cb",
"customerId": "2853cc98-cbed-4224-8859-b2c453bf69f7",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 2990,
"totalAmount": 2990,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 0,
"paid": false,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": "2021-09-10T07:00+02:00",
"transactions": [],
"transfers": [],
"sddTransactions": [],
"eventReceivedDate": null,
"additionalData": []
},
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"endToEndIdentification": null,
"remittanceInformation": null,
"redirect": null,
"additionalData": []
}SUBSCRIPTION_REACTIVATED
{
"subscriptionId": "815f1349-a998-40c8-8858-c69ca2ce657d",
"creationDate": "2021-09-08T09:39:00.107078+02:00",
"walletId": null,
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"cardId": "63afa65e-5674-49bf-9ac3-a98b82d16e92",
"mandateId": null,
"startingDate": "2021-09-08",
"endingDate": null,
"expectedEndingDate": null,
"currentPeriodStart": "2021-09-08",
"currentPeriodEnd": "2021-10-07",
"requestedCollectionDate": null,
"cancellationDate": null,
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"merchantSubscriptionId": "TEST001",
"subscriptionModel": {
"subscriptionModelId": "37cf003b-0bd7-4d70-b0b8-94a43d9c3654",
"creationDate": "2021-09-08T09:38:59.447893+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": null,
"amount": 10000,
"currency": "EUR",
"name": "CPMI",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 12,
"additionalData": []
},
"quantity": 1,
"status": "ACTIVE",
"cancelAtPeriodEnd": null,
"lastInvoice": {
"invoiceId": "a70a2bca-b471-410e-93e6-9c64c5c1a647",
"creationDate": "2021-09-08T09:39:00.446631+02:00",
"subscriptionId": "815f1349-a998-40c8-8858-c69ca2ce657d",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceId": null,
"amount": 10000,
"currency": "EUR",
"closed": true,
"invoiceItems": [
{
"invoiceItemId": "5c1a58bb-7b44-44b9-ad23-a02e988b2225",
"creationDate": "2021-09-08T09:39:00.210007+02:00",
"invoiceId": "a70a2bca-b471-410e-93e6-9c64c5c1a647",
"subscriptionId": "815f1349-a998-40c8-8858-c69ca2ce657d",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 10000,
"totalAmount": 10000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 1,
"paid": true,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": null,
"transactions": [
"f2600752-e92d-4da8-be19-0e1d64dad076"
],
"transfers": [],
"sddTransactions": [],
"eventReceivedDate": null,
"additionalData": []
},
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"endToEndIdentification": null,
"remittanceInformation": null,
"redirect": null,
"additionalData": []
}INVOICEITEM_CREATED
{
"invoiceItemId": "3af37818-645a-4f58-a125-414268e2a325",
"creationDate": "2021-09-17T02:00:57.974485+02:00",
"invoiceId": null,
"subscriptionId": "d344b183-0253-4be9-ba81-a34a562532ce",
"customerId": "1e64cc7f-76da-4bbd-b759-ecaf4b36a6d5",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 2000,
"totalAmount": 2000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}INVOICEITEM_UPDATED
{
"invoiceItemId": "fde32bbc-79c4-4583-a1ca-8ec9fca21199",
"creationDate": "2021-09-08T09:39:04.881132+02:00",
"invoiceId": null,
"subscriptionId": "e3e3c9f1-454d-4883-95b0-3e72de4b41a0",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 2,
"amount": 10000,
"totalAmount": 20000,
"currency": "EUR",
"description": null,
"type": "MANUAL",
"additionalData": []
}INVOICEITEM_DELETED
{
"invoiceItemId": "fde32bbc-79c4-4583-a1ca-8ec9fca21199",
"creationDate": "2021-09-08T09:39:04.881132+02:00",
"invoiceId": null,
"subscriptionId": "e3e3c9f1-454d-4883-95b0-3e72de4b41a0",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 2,
"amount": 10000,
"totalAmount": 20000,
"currency": "EUR",
"description": null,
"type": "MANUAL",
"additionalData": []
}INVOICE_CREATED
{
"invoiceId": "703dea08-671c-4402-b597-aabbc7cf3221",
"creationDate": "2021-09-17T02:00:58.117187+02:00",
"subscriptionId": "d344b183-0253-4be9-ba81-a34a562532ce",
"customerId": "1e64cc7f-76da-4bbd-b759-ecaf4b36a6d5",
"walletId": null,
"mandateId": null,
"merchantInvoiceId": null,
"amount": 2000,
"currency": "EUR",
"closed": false,
"invoiceItems": [
{
"invoiceItemId": "3af37818-645a-4f58-a125-414268e2a325",
"creationDate": "2021-09-17T02:00:57.974485+02:00",
"invoiceId": "703dea08-671c-4402-b597-aabbc7cf3221",
"subscriptionId": "d344b183-0253-4be9-ba81-a34a562532ce",
"customerId": "1e64cc7f-76da-4bbd-b759-ecaf4b36a6d5",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 2000,
"totalAmount": 2000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 0,
"paid": false,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": "2021-09-17T07:00+02:00",
"transactions": [],
"transfers": [],
"sddTransactions": [],
"eventReceivedDate": null,
"additionalData": []
}The SUBSCRIPTION object
SUBSCRIPTIONMODEL_CREATED
When a Subscription model is created
When a Subscription model is created
SUBSCRIPTIONMODEL_UPDATED
When a Subscription model is updated
When a Subscription model is updated
SUBSCRIPTION_CREATED
When a Subscription is created
When a Subscription is created
SUBSCRIPTION_FAILED
When a Subscription failed
When a Subscription failed
SUBSCRIPTION_UPDATED
When a Subscription is updated
When a Subscription is updated
SUBSCRIPTION_CANCELED
When a Subscription is cancelled
When a Subscription is cancelled
SUBSCRIPTION_ACTIVE
When a Subscription is active
When a Subscription is active
SUBSCRIPTION_FAILURE
When a Subscription failed to be paid
When a Subscription failed to be paid
SUBSCRIPTION_UNPAID
When a Subscription is unpaid
When a Subscription is unpaid
SUBSCRIPTION_REACTIVATED
When a Subscription is reactivated
When a Subscription is reactivated
INVOICEITEM_CREATED
When an invoice item is created
When an invoice item is created
INVOICEITEM_UPDATED
When an invoice item is updated
When an invoice item is updated
INVOICEITEM_DELETED
When an invoice item is deleted
When an invoice item is deleted
INVOICE_CREATED
When an invoice is created
When an invoice is created
INVOICE_UPDATED
When an invoice is updated
When an invoice is updated
INVOICE_CLOSED
When an invoice is closed
When an invoice is closed
INVOICE_REOPEN
When an invoice is reopen
When an invoice is reopen
INVOICE_TRANSACTION_SUCCEEDED
When an invoice transaction succeeded
When an invoice transaction succeeded
INVOICE_TRANSACTION_FAILED
When an invoice transaction failed
When an invoice transaction failed
SUBSCRIPTIONMODEL_CREATED
{
"subscriptionModelId": "01c3f578-a589-4ef7-9bb6-d855ff0fa121",
"creationDate": "2021-09-08T09:39:06.137368+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": null,
"amount": 10000,
"currency": "EUR",
"name": "Test Abo",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 12,
"additionalData": []
}SUBSCRIPTIONMODEL_UPDATED
{
"subscriptionModelId": "37cf003b-0bd7-4d70-b0b8-94a43d9c3654",
"creationDate": "2021-09-08T09:38:59.447893+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": null,
"amount": 10000,
"currency": "EUR",
"name": "CPMI",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 12,
"additionalData": []
}SUBSCRIPTION_CREATED
{
"subscriptionId": "da6a4622-4e5d-4da5-8d29-6c49d4052b69",
"creationDate": "2021-09-09T10:32:15.675280+02:00",
"walletId": null,
"customerId": "2f2e6ce9-e0bb-4377-8eb9-6a8506c0baa4",
"cardId": null,
"mandateId": "b08bb9e0-72e4-426a-9998-585f083338fc",
"startingDate": "2021-09-09",
"endingDate": null,
"expectedEndingDate": null,
"currentPeriodStart": "2021-09-09",
"currentPeriodEnd": "2021-10-08",
"requestedCollectionDate": "2021-09-15",
"cancellationDate": null,
"paymentRequestBreakdownId": "825c03a4-fa3e-4df0-812d-f3d094f88ca3",
"paymentRequestId": "ef4bf0e4-c77c-42a3-910e-b85e84b3c92b",
"merchantSubscriptionId": null,
"subscriptionModel": {
"subscriptionModelId": "b1561842-46c1-422c-84a6-69ea8e1c8051",
"creationDate": "2017-05-10T09:20:14.268+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": "a00e2d1b-87a1-4fb2-8e15-5d6132006d5b",
"amount": 2000,
"currency": "EUR",
"name": "premium",
"description": "abbonnement premium",
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": null,
"additionalData": []
},
"quantity": 1,
"status": "ACTIVE",
"cancelAtPeriodEnd": null,
"lastInvoice": {
"invoiceId": "e257896b-86a1-41cf-865b-ac0531e2ea4a",
"creationDate": "2021-09-09T10:32:16.072897+02:00",
"subscriptionId": "da6a4622-4e5d-4da5-8d29-6c49d4052b69",
"customerId": "2f2e6ce9-e0bb-4377-8eb9-6a8506c0baa4",
"walletId": null,
"mandateId": "b08bb9e0-72e4-426a-9998-585f083338fc",
"merchantInvoiceId": null,
"amount": 2000,
"currency": "EUR",
"closed": true,
"invoiceItems": [
{
"invoiceItemId": "0dabd4f2-6e36-4731-989a-d00bdf93e748",
"creationDate": "2021-09-09T10:32:15.860404+02:00",
"invoiceId": "e257896b-86a1-41cf-865b-ac0531e2ea4a",
"subscriptionId": "da6a4622-4e5d-4da5-8d29-6c49d4052b69",
"customerId": "2f2e6ce9-e0bb-4377-8eb9-6a8506c0baa4",
"walletId": null,
"mandateId": "b08bb9e0-72e4-426a-9998-585f083338fc",
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 2000,
"totalAmount": 2000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 1,
"paid": true,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": null,
"transactions": [],
"transfers": [],
"sddTransactions": [
"0fd0d6cb-076a-4df5-9e89-7a62b74791e8"
],
"eventReceivedDate": null,
"additionalData": []
},
"endUserIp": "92.154.127.221",
"endUserLanguage": null,
"endToEndIdentification": null,
"remittanceInformation": "PREMIUM",
"redirect": null,
"additionalData": []
}SUBSCRIPTION_UPDATED
{
"subscriptionId": "815f1349-a998-40c8-8858-c69ca2ce657d",
"creationDate": "2021-09-08T09:39:00.107078+02:00",
"walletId": null,
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"cardId": "63afa65e-5674-49bf-9ac3-a98b82d16e92",
"mandateId": null,
"startingDate": "2021-09-08",
"endingDate": null,
"expectedEndingDate": "2022-09-07",
"currentPeriodStart": "2021-09-08",
"currentPeriodEnd": "2021-10-07",
"requestedCollectionDate": null,
"cancellationDate": null,
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"merchantSubscriptionId": "TEST001",
"subscriptionModel": {
"subscriptionModelId": "37cf003b-0bd7-4d70-b0b8-94a43d9c3654",
"creationDate": "2021-09-08T09:38:59.447893+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": null,
"amount": 10000,
"currency": "EUR",
"name": "CPMI",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 12,
"additionalData": []
},
"quantity": 1,
"status": "ACTIVE",
"cancelAtPeriodEnd": null,
"lastInvoice": {
"invoiceId": "a70a2bca-b471-410e-93e6-9c64c5c1a647",
"creationDate": "2021-09-08T09:39:00.446631+02:00",
"subscriptionId": "815f1349-a998-40c8-8858-c69ca2ce657d",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceId": null,
"amount": 10000,
"currency": "EUR",
"closed": true,
"invoiceItems": [
{
"invoiceItemId": "5c1a58bb-7b44-44b9-ad23-a02e988b2225",
"creationDate": "2021-09-08T09:39:00.210007+02:00",
"invoiceId": "a70a2bca-b471-410e-93e6-9c64c5c1a647",
"subscriptionId": "815f1349-a998-40c8-8858-c69ca2ce657d",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 10000,
"totalAmount": 10000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 1,
"paid": true,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": null,
"transactions": [
"f2600752-e92d-4da8-be19-0e1d64dad076"
],
"transfers": [],
"sddTransactions": [],
"eventReceivedDate": null,
"additionalData": []
},
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"endToEndIdentification": null,
"remittanceInformation": null,
"redirect": null,
"additionalData": []
}SUBSCRIPTION_CANCELED
{
"subscriptionId": "f80b984e-0d99-4ec4-b3a2-8874f61909cb",
"creationDate": "2020-10-10T15:06:25.558834+02:00",
"walletId": null,
"customerId": "2853cc98-cbed-4224-8859-b2c453bf69f7",
"cardId": "1e66eadd-d659-4496-a838-4434f1d534c9",
"mandateId": null,
"startingDate": "2020-10-10",
"endingDate": "2021-10-09",
"expectedEndingDate": "2021-10-09",
"currentPeriodStart": "2021-09-10",
"currentPeriodEnd": "2021-10-09",
"requestedCollectionDate": null,
"cancellationDate": "2021-09-11T02:00:52.307831+02:00",
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"merchantSubscriptionId": null,
"subscriptionModel": {
"subscriptionModelId": "33b83f38-bf5a-4f3d-b92c-b86faeaa1f95",
"creationDate": "2020-10-10T13:16:09.581492+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": null,
"amount": 2990,
"currency": "EUR",
"name": "Abonnement_Test",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 12,
"additionalData": []
},
"quantity": 1,
"status": "ACTIVE",
"cancelAtPeriodEnd": true,
"lastInvoice": {
"invoiceId": "f97b6124-a722-49bb-b877-e1290c2d1bf5",
"creationDate": "2021-09-10T02:01:06.199983+02:00",
"subscriptionId": "f80b984e-0d99-4ec4-b3a2-8874f61909cb",
"customerId": "2853cc98-cbed-4224-8859-b2c453bf69f7",
"walletId": null,
"mandateId": null,
"merchantInvoiceId": null,
"amount": 2990,
"currency": "EUR",
"closed": false,
"invoiceItems": [
{
"invoiceItemId": "433996b6-b40a-479d-aebb-e0b3d4fbac76",
"creationDate": "2021-09-10T02:01:05.711573+02:00",
"invoiceId": "f97b6124-a722-49bb-b877-e1290c2d1bf5",
"subscriptionId": "f80b984e-0d99-4ec4-b3a2-8874f61909cb",
"customerId": "2853cc98-cbed-4224-8859-b2c453bf69f7",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 2990,
"totalAmount": 2990,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 0,
"paid": false,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": "2021-09-10T07:00+02:00",
"transactions": [],
"transfers": [],
"sddTransactions": [],
"eventReceivedDate": null,
"additionalData": []
},
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"endToEndIdentification": null,
"remittanceInformation": null,
"redirect": null,
"additionalData": []
}SUBSCRIPTION_REACTIVATED
{
"subscriptionId": "815f1349-a998-40c8-8858-c69ca2ce657d",
"creationDate": "2021-09-08T09:39:00.107078+02:00",
"walletId": null,
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"cardId": "63afa65e-5674-49bf-9ac3-a98b82d16e92",
"mandateId": null,
"startingDate": "2021-09-08",
"endingDate": null,
"expectedEndingDate": null,
"currentPeriodStart": "2021-09-08",
"currentPeriodEnd": "2021-10-07",
"requestedCollectionDate": null,
"cancellationDate": null,
"paymentRequestBreakdownId": null,
"paymentRequestId": null,
"merchantSubscriptionId": "TEST001",
"subscriptionModel": {
"subscriptionModelId": "37cf003b-0bd7-4d70-b0b8-94a43d9c3654",
"creationDate": "2021-09-08T09:38:59.447893+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantSubscriptionModelId": null,
"amount": 10000,
"currency": "EUR",
"name": "CPMI",
"description": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 12,
"additionalData": []
},
"quantity": 1,
"status": "ACTIVE",
"cancelAtPeriodEnd": null,
"lastInvoice": {
"invoiceId": "a70a2bca-b471-410e-93e6-9c64c5c1a647",
"creationDate": "2021-09-08T09:39:00.446631+02:00",
"subscriptionId": "815f1349-a998-40c8-8858-c69ca2ce657d",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceId": null,
"amount": 10000,
"currency": "EUR",
"closed": true,
"invoiceItems": [
{
"invoiceItemId": "5c1a58bb-7b44-44b9-ad23-a02e988b2225",
"creationDate": "2021-09-08T09:39:00.210007+02:00",
"invoiceId": "a70a2bca-b471-410e-93e6-9c64c5c1a647",
"subscriptionId": "815f1349-a998-40c8-8858-c69ca2ce657d",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 10000,
"totalAmount": 10000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 1,
"paid": true,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": null,
"transactions": [
"f2600752-e92d-4da8-be19-0e1d64dad076"
],
"transfers": [],
"sddTransactions": [],
"eventReceivedDate": null,
"additionalData": []
},
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"endToEndIdentification": null,
"remittanceInformation": null,
"redirect": null,
"additionalData": []
}INVOICEITEM_CREATED
{
"invoiceItemId": "3af37818-645a-4f58-a125-414268e2a325",
"creationDate": "2021-09-17T02:00:57.974485+02:00",
"invoiceId": null,
"subscriptionId": "d344b183-0253-4be9-ba81-a34a562532ce",
"customerId": "1e64cc7f-76da-4bbd-b759-ecaf4b36a6d5",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 2000,
"totalAmount": 2000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}INVOICEITEM_UPDATED
{
"invoiceItemId": "fde32bbc-79c4-4583-a1ca-8ec9fca21199",
"creationDate": "2021-09-08T09:39:04.881132+02:00",
"invoiceId": null,
"subscriptionId": "e3e3c9f1-454d-4883-95b0-3e72de4b41a0",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 2,
"amount": 10000,
"totalAmount": 20000,
"currency": "EUR",
"description": null,
"type": "MANUAL",
"additionalData": []
}INVOICEITEM_DELETED
{
"invoiceItemId": "fde32bbc-79c4-4583-a1ca-8ec9fca21199",
"creationDate": "2021-09-08T09:39:04.881132+02:00",
"invoiceId": null,
"subscriptionId": "e3e3c9f1-454d-4883-95b0-3e72de4b41a0",
"customerId": "4e06b1e7-c24c-4927-a2da-f9c2dd3d4660",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 2,
"amount": 10000,
"totalAmount": 20000,
"currency": "EUR",
"description": null,
"type": "MANUAL",
"additionalData": []
}INVOICE_CREATED
{
"invoiceId": "703dea08-671c-4402-b597-aabbc7cf3221",
"creationDate": "2021-09-17T02:00:58.117187+02:00",
"subscriptionId": "d344b183-0253-4be9-ba81-a34a562532ce",
"customerId": "1e64cc7f-76da-4bbd-b759-ecaf4b36a6d5",
"walletId": null,
"mandateId": null,
"merchantInvoiceId": null,
"amount": 2000,
"currency": "EUR",
"closed": false,
"invoiceItems": [
{
"invoiceItemId": "3af37818-645a-4f58-a125-414268e2a325",
"creationDate": "2021-09-17T02:00:57.974485+02:00",
"invoiceId": "703dea08-671c-4402-b597-aabbc7cf3221",
"subscriptionId": "d344b183-0253-4be9-ba81-a34a562532ce",
"customerId": "1e64cc7f-76da-4bbd-b759-ecaf4b36a6d5",
"walletId": null,
"mandateId": null,
"merchantInvoiceItemId": null,
"quantity": 1,
"amount": 2000,
"totalAmount": 2000,
"currency": "EUR",
"description": null,
"type": "SUBSCRIPTION",
"additionalData": []
}
],
"description": null,
"attemptCount": 0,
"paid": false,
"type": "SUBSCRIPTION",
"nextTransactionAttempt": "2021-09-17T07:00+02:00",
"transactions": [],
"transfers": [],
"sddTransactions": [],
"eventReceivedDate": null,
"additionalData": []
}The TRANSACTION object
TRANSACTION_SUCCESS
When a transaction has been approved by the issuing bank
When a transaction has been approved by the issuing bank
TRANSACTION_CANCELED
When a transaction is cancelled
When a transaction is cancelled
TRANSACTION_CAPTURED
When a transaction is sent to the clearing and will be debited
When a transaction is sent to the clearing and will be debited
TRANSACTION_DISPUTED
When a transaction is turned to a chargeback
When a transaction is turned to a chargeback
TRANSACTION_FAILED
When a transaction has been declined by the issuing bank
When a transaction has been declined by the issuing bank
TRANSACTION_FRAUDULENT
When a transaction is refused because it has meet a blacklist element (Email, IP, Card, …)
When a transaction is refused because it has meet a blacklist element (Email, IP, Card, …)
TRANSACTION_NOT_ACCEPTED
When a transaction is refused because entering an acceptance rule
When a transaction is refused because entering an acceptance rule
TRANSACTION_REFUNDED
When a transaction has been refunded to the card holder
When a transaction has been refunded to the card holder
TRANSACTION_RISK
When a transaction is refused because of its risk score exceed the limit
When a transaction is refused because of its risk score exceed the limit
TRANSACTION_THREEDS_AUTH_FAILED
When a transaction is declined because the card holder failed to authenticate himself during the 3DS process
When a transaction is declined because the card holder failed to authenticate himself during the 3DS process
The TRANSFER REVERSAL object
TRANSFERREVERSAL_SUCCEEDED
When a transfer reversal succeeded
When a transfer reversal succeeded
TRANSFERREVERSAL_UPDATED
When a transfer reversal is updated
When a transfer reversal is updated
The TRANSFER object
TRANSFER_SUCCEEDED
When a transfer succeeded
When a transfer succeeded
TRANSFER_UPDATED
When a transfer is updated
When a transfer is updated
TRANSFER_CANCELED
When a transfer is cancelled
When a transfer is cancelled
The WIRETRANSFER object
WIRETRANSFER_CREATED
When a wire transfer is created
When a wire transfer is created
WIRETRANSFER_UPDATED
When a wire transfer is updated
When a wire transfer is updated
WIRETRANSFER_RECEIVED
When a wire transfer is received
When a wire transfer is received
WIRETRANSFER_CANCELED
When a wire transfer is cancelled
When a wire transfer is cancelled
Wallet
Wallet is an account with many currencies
HTTP Request
GET https://test-api.centralpay.net/v2/rest/wallet
HTTP Response
OBJ Json wallet type
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/wallet \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"available": [
{
"amount": 5178293,
"minimumAmount": 3000000,
"currency": "EUR"
}
],
"pending": [
{
"amount": 164751,
"minimumAmount": null,
"currency": "EUR"
}
]
}
Retrieve a wallet
This service allows you to retrieve a wallet with the wallet ID. All the paramers used to search must be passed in the form of queries parameters.
| walletId UUID (36) |
CentralPay ID of the wallet Required: no Validation: UUID Wallet of the connected merchant or wallet of one of his sub-merchants By default, the wallet of the connected merchant |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/wallet
HTTP Response
OBJ Json wallet type
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/wallet \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"available": [
{
"amount": 5178293,
"minimumAmount": 3000000,
"currency": "EUR"
}
],
"pending": [
{
"amount": 164751,
"minimumAmount": null,
"currency": "EUR"
}
]
}
Wallet Object
The Json "Wallet" Object
The "Wallet" object response represents a wallet situation at the moment
|
available List<WalletItem> |
Wallet available amounts |
| currency String |
Currency Note: Favourite format |
| amount Integer |
Amount Note: in cents |
| pending List<WalletItem> |
Wallet pending amounts Note: |
| currency String |
Currency Note: Favourite format |
| amount Integer |
Amount Note: in cents |
Movement
The movement are all the bank operation that happen in your wallet, with amount, fee and source associated.
HTTP Request
GET https://test-api.centralpay.net/v2/rest/movement/{{movementId}}
HTTP Response
OBJ Json wallet type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/movement/2cec85cc-5501-4516-9bdc-a31bdd47d79b \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"movementId": "2cec85cc-5501-4516-9bdc-a31bdd47d79b",
"creationDate": "2020-10-06T12:45:50.756330+02:00",
"expectedAvailabilityDate": "2020-10-08",
"availableDate": "2020-10-08",
"sourceId": "e0a3e218-4f13-4d85-9510-744ae8f0a0d6",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 1000,
"fee": 0,
"net": 1000,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": null,
"customDescription": null
}
Retrieve Movement
This service allows you to retrieve the movement in your account with the movement ID. All the paramers used to search must be passed in the form of queries parameters.
| movementId UUID (36) |
CentralPay ID of the movement Required: yes Validation: UUID |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/movement/{{movementId}}
HTTP Response
OBJ Json wallet type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/movement/2cec85cc-5501-4516-9bdc-a31bdd47d79b \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"movementId": "2cec85cc-5501-4516-9bdc-a31bdd47d79b",
"creationDate": "2020-10-06T12:45:50.756330+02:00",
"expectedAvailabilityDate": "2020-10-08",
"availableDate": "2020-10-08",
"sourceId": "e0a3e218-4f13-4d85-9510-744ae8f0a0d6",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 1000,
"fee": 0,
"net": 1000,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": null,
"customDescription": null
}
HTTP Request
GET https://test-api.centralpay.net/v2/rest/movement
HTTP Response
List OBJ Json movement type
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/movement \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"list": [
{
"movementId": "0905743b-fa72-4c02-9eb6-1a2a4ccddadb",
"creationDate": "2021-06-22T10:46:11.477123+02:00",
"expectedAvailabilityDate": "2021-06-24",
"availableDate": "2021-06-24",
"sourceId": "e226e3af-9f69-4123-816f-f2be44ed7858",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 1056,
"fee": 0,
"net": 1056,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": null,
"customDescription": null
},
{
"movementId": "657a6852-5f06-4f3c-88c7-47180e645730",
"creationDate": "2021-06-22T10:46:11.297052+02:00",
"expectedAvailabilityDate": "2021-06-24",
"availableDate": "2021-06-24",
"sourceId": "e226e3af-9f69-4123-816f-f2be44ed7858",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 0,
"fee": 0,
"net": 0,
"currency": "EUR",
"status": "AVAILABLE",
"type": "AUTHORIZATION",
"description": null,
"customDescription": null
},
{
"movementId": "84c3d709-854d-4571-b191-9f6b2e8d8826",
"creationDate": "2021-06-22T10:45:55.570129+02:00",
"expectedAvailabilityDate": "2021-06-22",
"availableDate": "2021-06-22",
"sourceId": "a6e39da7-e5f2-43dd-8b11-641f7fa573ff",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 0,
"fee": -500,
"net": -500,
"currency": "EUR",
"status": "AVAILABLE",
"type": "CUSTOMER_CREATION",
"description": null,
"customDescription": null
},
{
"movementId": "874bf780-0394-40bd-89e5-ca4e40b50327",
"creationDate": "2021-06-22T10:01:37.555356+02:00",
"expectedAvailabilityDate": "2021-06-24",
"availableDate": "2021-06-24",
"sourceId": "d331a66a-f10d-4a15-b860-d39ed56ef26e",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 35000,
"fee": -5750,
"net": 29250,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": null,
"customDescription": null
},
{
"movementId": "9e60c76c-9fa0-46ab-85e6-5e77f18f520e",
"creationDate": "2021-06-22T10:01:37.346286+02:00",
"expectedAvailabilityDate": "2021-06-24",
"availableDate": "2021-06-24",
"sourceId": "d331a66a-f10d-4a15-b860-d39ed56ef26e",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 0,
"fee": -500,
"net": -500,
"currency": "EUR",
"status": "AVAILABLE",
"type": "AUTHORIZATION",
"description": null,
"customDescription": null
},
{
"movementId": "8a69c6f3-3f46-41ab-812d-19e5b69dad17",
"creationDate": "2021-06-22T08:01:38.546367+02:00",
"expectedAvailabilityDate": "2021-06-24",
"availableDate": "2021-06-24",
"sourceId": "52e0f8a5-3373-4b66-b0e4-5c0d29421db8",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 1700,
"fee": -1000,
"net": 700,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": null,
"customDescription": null
},
{
"movementId": "81d1eae7-6a7a-4bbb-98c3-5fb041eb5185",
"creationDate": "2021-06-22T08:01:38.296436+02:00",
"expectedAvailabilityDate": "2021-06-24",
"availableDate": "2021-06-24",
"sourceId": "52e0f8a5-3373-4b66-b0e4-5c0d29421db8",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 0,
"fee": -500,
"net": -500,
"currency": "EUR",
"status": "AVAILABLE",
"type": "AUTHORIZATION",
"description": null,
"customDescription": null
},
{
"movementId": "fb1031ac-4b56-4918-a7c9-7dd8c46ba1ae",
"creationDate": "2021-06-19T10:01:52.274770+02:00",
"expectedAvailabilityDate": "2021-06-21",
"availableDate": "2021-06-21",
"sourceId": "2f8ffed0-8fce-4867-bf54-e4d4acad3196",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 35000,
"fee": -5750,
"net": 29250,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": null,
"customDescription": null
},
{
"movementId": "85f57a3f-04c6-4d53-8d31-6e4f68183100",
"creationDate": "2021-06-19T10:01:52.115145+02:00",
"expectedAvailabilityDate": "2021-06-21",
"availableDate": "2021-06-21",
"sourceId": "2f8ffed0-8fce-4867-bf54-e4d4acad3196",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 0,
"fee": -500,
"net": -500,
"currency": "EUR",
"status": "AVAILABLE",
"type": "AUTHORIZATION",
"description": null,
"customDescription": null
},
{
"movementId": "f36370f4-a9dc-4421-bffd-9024c65db2a7",
"creationDate": "2021-06-18T14:00:07.383521+02:00",
"expectedAvailabilityDate": "2021-06-20",
"availableDate": "2021-06-20",
"sourceId": "c6d4950d-f6e3-4887-88a8-55a1000f5d42",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 5000,
"fee": -1250,
"net": 3750,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": null,
"customDescription": null
}
],
"totalCount": 56857
}List Movement
This function allows you to retrieve all the movements registerered in your account.
| currency String (3) |
currency of the movement Required: no |
|
expectedAvailabilityDateBefore localDate |
Before the expectedAvailabilityDate, this date included.Required: no |
|
expectedAvailabilityDateAfter localeDate |
After the expectedAvailabilityDate, this date included.Required: no |
|
availableDateBefore localeDate |
Before the availableDate, this date included.Required: no |
| availableDateAfter LocalDate |
After the availableDate, this date included. Required: no |
| status Enum MovementStatus |
Arrival date
Required: no Validation: PENDING | PAID | CANCEL
|
| type Enum MovementType |
Payout status Required: no Validation: see the different type in the object. |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/movement
HTTP Response
List OBJ Json movement type
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/movement \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"list": [
{
"movementId": "0905743b-fa72-4c02-9eb6-1a2a4ccddadb",
"creationDate": "2021-06-22T10:46:11.477123+02:00",
"expectedAvailabilityDate": "2021-06-24",
"availableDate": "2021-06-24",
"sourceId": "e226e3af-9f69-4123-816f-f2be44ed7858",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 1056,
"fee": 0,
"net": 1056,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": null,
"customDescription": null
},
{
"movementId": "657a6852-5f06-4f3c-88c7-47180e645730",
"creationDate": "2021-06-22T10:46:11.297052+02:00",
"expectedAvailabilityDate": "2021-06-24",
"availableDate": "2021-06-24",
"sourceId": "e226e3af-9f69-4123-816f-f2be44ed7858",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 0,
"fee": 0,
"net": 0,
"currency": "EUR",
"status": "AVAILABLE",
"type": "AUTHORIZATION",
"description": null,
"customDescription": null
},
{
"movementId": "84c3d709-854d-4571-b191-9f6b2e8d8826",
"creationDate": "2021-06-22T10:45:55.570129+02:00",
"expectedAvailabilityDate": "2021-06-22",
"availableDate": "2021-06-22",
"sourceId": "a6e39da7-e5f2-43dd-8b11-641f7fa573ff",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 0,
"fee": -500,
"net": -500,
"currency": "EUR",
"status": "AVAILABLE",
"type": "CUSTOMER_CREATION",
"description": null,
"customDescription": null
},
{
"movementId": "874bf780-0394-40bd-89e5-ca4e40b50327",
"creationDate": "2021-06-22T10:01:37.555356+02:00",
"expectedAvailabilityDate": "2021-06-24",
"availableDate": "2021-06-24",
"sourceId": "d331a66a-f10d-4a15-b860-d39ed56ef26e",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 35000,
"fee": -5750,
"net": 29250,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": null,
"customDescription": null
},
{
"movementId": "9e60c76c-9fa0-46ab-85e6-5e77f18f520e",
"creationDate": "2021-06-22T10:01:37.346286+02:00",
"expectedAvailabilityDate": "2021-06-24",
"availableDate": "2021-06-24",
"sourceId": "d331a66a-f10d-4a15-b860-d39ed56ef26e",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 0,
"fee": -500,
"net": -500,
"currency": "EUR",
"status": "AVAILABLE",
"type": "AUTHORIZATION",
"description": null,
"customDescription": null
},
{
"movementId": "8a69c6f3-3f46-41ab-812d-19e5b69dad17",
"creationDate": "2021-06-22T08:01:38.546367+02:00",
"expectedAvailabilityDate": "2021-06-24",
"availableDate": "2021-06-24",
"sourceId": "52e0f8a5-3373-4b66-b0e4-5c0d29421db8",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 1700,
"fee": -1000,
"net": 700,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": null,
"customDescription": null
},
{
"movementId": "81d1eae7-6a7a-4bbb-98c3-5fb041eb5185",
"creationDate": "2021-06-22T08:01:38.296436+02:00",
"expectedAvailabilityDate": "2021-06-24",
"availableDate": "2021-06-24",
"sourceId": "52e0f8a5-3373-4b66-b0e4-5c0d29421db8",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 0,
"fee": -500,
"net": -500,
"currency": "EUR",
"status": "AVAILABLE",
"type": "AUTHORIZATION",
"description": null,
"customDescription": null
},
{
"movementId": "fb1031ac-4b56-4918-a7c9-7dd8c46ba1ae",
"creationDate": "2021-06-19T10:01:52.274770+02:00",
"expectedAvailabilityDate": "2021-06-21",
"availableDate": "2021-06-21",
"sourceId": "2f8ffed0-8fce-4867-bf54-e4d4acad3196",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 35000,
"fee": -5750,
"net": 29250,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": null,
"customDescription": null
},
{
"movementId": "85f57a3f-04c6-4d53-8d31-6e4f68183100",
"creationDate": "2021-06-19T10:01:52.115145+02:00",
"expectedAvailabilityDate": "2021-06-21",
"availableDate": "2021-06-21",
"sourceId": "2f8ffed0-8fce-4867-bf54-e4d4acad3196",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 0,
"fee": -500,
"net": -500,
"currency": "EUR",
"status": "AVAILABLE",
"type": "AUTHORIZATION",
"description": null,
"customDescription": null
},
{
"movementId": "f36370f4-a9dc-4421-bffd-9024c65db2a7",
"creationDate": "2021-06-18T14:00:07.383521+02:00",
"expectedAvailabilityDate": "2021-06-20",
"availableDate": "2021-06-20",
"sourceId": "c6d4950d-f6e3-4887-88a8-55a1000f5d42",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"emissionWalletId": null,
"amount": 5000,
"fee": -1250,
"net": 3750,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": null,
"customDescription": null
}
],
"totalCount": 56857
}Movement Object
| movementId UUID |
Movement's id |
| creationDate LocalDate |
The date of creation of the movement |
| currency String (3) |
Currency of movement |
| amount Integer |
Gross amount |
| fee Integer |
fee |
| net Integer |
Net amount |
| description String |
Description |
| expectedAvailabilityDate LocalDate |
planned date of avaibility |
| availableDate LocalDate |
real date of availibility |
| status Enum MovementStatus |
Status of the movement Note: PENDING | PAID | CANCEL |
| sourceId UUID |
UUID of the original object |
| type Enum MovementType |
type of the movement
Note: TRANSACTION | TRANSACTION_CANCEL | REFUND | REFUND_CANCEL | DISPUTE | DISPUTE_WON | TRANSFER | TRANSFER_CANCEL | TRANSFER_REVERSAL | PAYOUT | PAYOUT_CANCEL | PAYOUT_FAILURE | DEPOSIT | WIRE_TRANSFER | WIRE_TRANSFER_CANCEL | CREDIT | CREDIT_CANCEL| CUSTOMER_CREATION | AUTHORIZATION
|
| emissionWalletId UUID |
Wallet of emission of the movement Note : used in the actions with a double movement (transfer and transferReversal) |