Plateform
Onboarding
API Endpoint
The following link is the core link used to test this part of the API : https://test-onboarding-api.centralpay.net
HEADERS
Functions use the « MIME » type: "application/x-www-form-urlencoded" or "multipart/form-data" if you have to send a file.
You can select your language with "Accept-Language" header.
It's recommanded to sent "Browser-User-Agent" and "Browser-IP" headers with user data.
AUTHENTICATION
CentralPay API uses "HTTP Basic authentication" for authentication. Most of 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.
SIREN
A simplification of the process is now available for the French merchant with a SIREN identification number. If the merchant have a SIREN you can begin your enrolment process with the request siren and can verify the informations in the JSON return. If the informations are correct, you can create an enrollment with the field identityBadge completed. It will triggers the simplified workflow.
The simplfied workflow will complete some activities relative to officials documents of the enteprise automatically, and will reduce the frictions with the merchant, and the number of activities to manage.
POST https://test-onboarding-api.centralpay.net/api/legal-entity/siren
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/legal-entity/siren \
-u 'login:password' \
-F siren="123456789"
{
"uuid": "92ca98a0-aac7-4fe9-87cd-6fc6018b4731",
"siren": "123456789",
"denomination": "SOCIETE TEST",
"radiation_states": false,
"company_creation_date": "2014-11-15T12:13:20+01:00"
}
SIREN
Note: This request and all the services linked are only available for the enrollment of french merchants.
siren String (9) |
Siren number of the merchant Required : yes |
POST https://test-onboarding-api.centralpay.net/api/legal-entity/siren
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/legal-entity/siren \
-u 'login:password' \
-F siren="123456789"
{
"uuid": "92ca98a0-aac7-4fe9-87cd-6fc6018b4731",
"siren": "123456789",
"denomination": "SOCIETE TEST",
"radiation_states": false,
"company_creation_date": "2014-11-15T12:13:20+01:00"
}
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/ \
-u 'login:password' \
-F profile[firstname][value]=John \
-F profile[lastname][value]=Doe \
-F profile[email][value]=j.doe@gmail.com \
-F language=fr \
-F accountType=STANDARD \
-F feeSchedule=b52ae174-4830-4615-bdc4-a96ed9f05eeb \
-F activitySector=2ddb3e87-b3a4-4dc2-a535-cf73637b4cd6 \
-F contract=6c6f0529-76bf-43ed-9f5e-c2d4ea6ff4d9
{
"code": 400,
"message": "Validation Failed",
"errors": {
"errors": [
"Claim is already ongoing"
],
"children": {
"firstname": {},
"lastname": {},
"email": {},
"language": {},
"isMale": {},
"phone": {},
"customReference": {},
"turnoverIsFixed": {},
"activitySector": {},
"isCompany": {},
"sendClaimEmail": {},
"sendProfileCreationEmail": {},
"sendAccountCreationEmail": {},
"workflowDefinition": {},
"accountType": {},
"contract": {},
"feeSchedule": {
"errors": [
"This value is not valid."
]
}
}
}
}
{
"workflow": null,
"identity_badge": null,
"representatives_list": null,
"infogreffe_identity": null,
"uuid": "607a9213-a986-435e-8705-aff2c66ec594",
"risk_points": null,
"created_at": "2021-11-15T11:19:43",
"last_updated_at": null,
"turnover_is_fixed": false,
"workflow_mode": "CONTINUAL",
"risk_level": null,
"type": null,
"enrollment_account": null,
"profile": {
"uuid": "1a493cd3-9525-44e8-adcd-b706c2c0365e",
"workflow": {
"uuid": "4ba3ad44-acbe-430d-8bd1-98432d9899be",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "47161ea1-94fa-455e-9bb1-a3a95423a4b6",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "7ff83652-888f-4fa9-8572-2449fe38f686",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "710221dd-4c63-46d0-a73f-63bb88df30c9",
"value": "jdoe-test4@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "47ea8321-71c2-4ec0-a12b-45ff055473ee",
"value": "+33635847598",
"element-type": "phone"
}
],
"uuid": "91a4ca07-3945-418c-9b90-2fc0e333a7ef",
"name": "identityInfos",
"state": "TODO",
"category": "identity",
"created_at": "2021-11-15T11:19:43"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "47161ea1-94fa-455e-9bb1-a3a95423a4b6",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "7ff83652-888f-4fa9-8572-2449fe38f686",
"value": "Doe",
"element-type": "lastname"
},
"email": {
"status": "COMPLETED",
"uuid": "710221dd-4c63-46d0-a73f-63bb88df30c9",
"value": "jdoe-test4@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "cc979904-d5dc-427d-b095-425b365c7df8",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "47ea8321-71c2-4ec0-a12b-45ff055473ee",
"value": "+33635847598",
"element-type": "phone"
},
"birthday": null,
"login": null,
"bo_user_uuid": null
},
"activity_sector": {
"name": "Appareils électroniques et ordinateurs"
},
"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,
"next_step": 0
}
Create an Enrollment
This function allows you to create a new merchant enrollment.
profile[firstname][value]* string (255) |
Merchant firstname Since 1.15.0 Required : yes |
profile[lastname][value]* string (255) |
Merchant lastname Since 1.15.0 Required : yes |
profile[email][value]* String (255) |
Merchant email Since 1.15.0 Required : yes |
profile[phone][value]* String |
Merchant Internationnal phone number Since 1.15.0 Required : yes |
identityBadge uuid |
The uuid of the siren Required : conditional |
language* String |
Merchant mail language Required : yesNote: GET /api/locale |
accountType* ENUM |
Merchant account typeRequired : yes Note: GET /api/merchant-enrollment/account-type |
activitySector* UUID (36) |
Merchant activity sector Required : yes |
activityAge* UUID (36) |
Company activity age Required if type is LEGAL_ENTITY or INDIVIDUAL_WITH_STATUS Note: GET api/nauth/enrollment-claim/activity-age |
feeSchedule* UUID (36) |
Fee schedule to applyRequired : yesNote: POST /api/merchant-enrollment/fee-schedule |
cgu UUID (36) |
Cgu to apply Required : noNote: POST /api/merchant-enrollment/cgu Since 1.18.0 |
workflowMode ENUM
|
Workflow mode Required : no Note: CONTINUAL|SEQUENTIAL, default CONTINUAL |
profile[nationality][country]
|
Merchant nationality Required : no Since 1.15.0 NOTE: Constraint: ISO 3166-1 alpha-3 |
profile[birthday][value] date |
Merchant date of birth Required : no Validation : - More than 18 years ago - Less than 110 years ago Since 1.15.0 |
profile[place_of_birth][value] string (255) |
Merchant Place of birth Required : no Since 1.15.0 |
profile[country_of_birth][country] string (3) |
Merchant Country of birth Required : no Since 1.15.0 NOTE: Constraint: ISO 3166-1 alpha-3 |
profile[address][nameLine1] string (255) |
Address name line 1 Required : no Since 1.15.0 |
profile[address][locality] string (255) |
Address locality Required : no Since 1.15.0 |
profile[address][postalCode] string (20) |
Address postal code Required : no Since 1.15.0 |
profile[address][country] string (3) |
Country Required : no Since 1.15.0 NOTE: Constraint: ISO 3166-1 alpha-3 |
contract UUID (36) |
Contract to apply Required if accountType is STANDARD Note: GET/api/merchant-enrollment/contract |
type Enum (string) |
Type of legal status Required : no Note: INDIVIDUAL|INDIVIDUAL_WITH_STATUS|LEGAL_ENTITY |
turnoverIsFixed bool |
Force to fix turnover Required : no Note: Default false |
subType ENUM |
a advised subtype of the merchant category of work's field Required : advised Note: if the type is 'INDIVIDUAL_WITH_STATUS' the subtypes available are : 'SOLE_TRADER', 'MERCHANT', 'ARTISAN' . if the type is 'LEGAL_ENTITY' the subtype available are : 'ASSOCIATION', 'PUBLIC', 'COMMERCIAL', 'EIG', 'CIVIL' . |
sendClaimEmail bool |
Send initial mail to merchant Required : no Note: |
allowedEmailCommunication bool |
Allow mails communication. When value is false, no email is sent from the onboarding plateform Required : no Note: |
sendProfileCreationEmail bool |
Send mail after profile is completed Required : no Note: Default false |
sendAccountCreationEmail bool |
Send mail when merchant can use his Centralpay account Required : no Note: Default true |
customReference string (100) |
Your custom reference Required : no |
administrativeContact string (255) |
Administrative contact Required : no Since 1.18.0 |
technicalContact string (255) |
Technical contact Required : no Since 1.18.0 |
financialContact string (255) |
Financial contact Required : no Since 1.18.0 |
addSecurityReference bool |
During contract validation, security reference will be display Required : no Note: Field only avaibale if accountType is STANDARD | PARTNER | RESELLER Default false Since 1.18.0 |
hook uuid |
The uuid of the hook you are interested in Required : no Notes : to obtain the hook uuid please see the Full API reference Tab |
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/ \
-u 'login:password' \
-F profile[firstname][value]=John \
-F profile[lastname][value]=Doe \
-F profile[email][value]=j.doe@gmail.com \
-F language=fr \
-F accountType=STANDARD \
-F feeSchedule=b52ae174-4830-4615-bdc4-a96ed9f05eeb \
-F activitySector=2ddb3e87-b3a4-4dc2-a535-cf73637b4cd6 \
-F contract=6c6f0529-76bf-43ed-9f5e-c2d4ea6ff4d9
{
"code": 400,
"message": "Validation Failed",
"errors": {
"errors": [
"Claim is already ongoing"
],
"children": {
"firstname": {},
"lastname": {},
"email": {},
"language": {},
"isMale": {},
"phone": {},
"customReference": {},
"turnoverIsFixed": {},
"activitySector": {},
"isCompany": {},
"sendClaimEmail": {},
"sendProfileCreationEmail": {},
"sendAccountCreationEmail": {},
"workflowDefinition": {},
"accountType": {},
"contract": {},
"feeSchedule": {
"errors": [
"This value is not valid."
]
}
}
}
}
{
"workflow": null,
"identity_badge": null,
"representatives_list": null,
"infogreffe_identity": null,
"uuid": "607a9213-a986-435e-8705-aff2c66ec594",
"risk_points": null,
"created_at": "2021-11-15T11:19:43",
"last_updated_at": null,
"turnover_is_fixed": false,
"workflow_mode": "CONTINUAL",
"risk_level": null,
"type": null,
"enrollment_account": null,
"profile": {
"uuid": "1a493cd3-9525-44e8-adcd-b706c2c0365e",
"workflow": {
"uuid": "4ba3ad44-acbe-430d-8bd1-98432d9899be",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "47161ea1-94fa-455e-9bb1-a3a95423a4b6",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "7ff83652-888f-4fa9-8572-2449fe38f686",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "710221dd-4c63-46d0-a73f-63bb88df30c9",
"value": "jdoe-test4@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "47ea8321-71c2-4ec0-a12b-45ff055473ee",
"value": "+33635847598",
"element-type": "phone"
}
],
"uuid": "91a4ca07-3945-418c-9b90-2fc0e333a7ef",
"name": "identityInfos",
"state": "TODO",
"category": "identity",
"created_at": "2021-11-15T11:19:43"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "47161ea1-94fa-455e-9bb1-a3a95423a4b6",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "7ff83652-888f-4fa9-8572-2449fe38f686",
"value": "Doe",
"element-type": "lastname"
},
"email": {
"status": "COMPLETED",
"uuid": "710221dd-4c63-46d0-a73f-63bb88df30c9",
"value": "jdoe-test4@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "cc979904-d5dc-427d-b095-425b365c7df8",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "47ea8321-71c2-4ec0-a12b-45ff055473ee",
"value": "+33635847598",
"element-type": "phone"
},
"birthday": null,
"login": null,
"bo_user_uuid": null
},
"activity_sector": {
"name": "Appareils électroniques et ordinateurs"
},
"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,
"next_step": 0
}
Create full enrollment
CentralPay platform delivers through its API, functionalities that allow to manage all onboarding process requests without dealing with our Back Office. To do so, you’ve got to set up the onboarding platform URL within CentralPay Back Office.
The enrollment request creation is identical to an enrollment managed by CentralPay.
In order to complete the Prospect registration, the following steps have to be completed:
- Step 1: Complete your profile
- Step 2: Define a password
- Step 3: Complete the information to determine the workflow
- Step 4: Complete the workflow
GET 'https://test-onboarding-api.centralpay.net/api/nauth/merchant-enrollment/{{enrollmentId}}'
curl --location --request GET 'https://test-onboarding-api.centralpay.net/api/nauth/merchant-enrollment/607a9213-a986-435e-8705-aff2c66ec594 \
--header 'Authorization: Basic ZG9jdGVzdDo0STlISlJUZA=='
{
"workflow": null,
"identity_badge": null,
"representatives_list": null,
"infogreffe_identity": null,
"uuid": "607a9213-a986-435e-8705-aff2c66ec594",
"risk_points": null,
"created_at": "2021-11-15T11:19:43",
"last_updated_at": null,
"turnover_is_fixed": false,
"workflow_mode": "CONTINUAL",
"risk_level": null,
"type": null,
"enrollment_account": null,
"profile": {
"uuid": "1a493cd3-9525-44e8-adcd-b706c2c0365e",
"workflow": {
"uuid": "4ba3ad44-acbe-430d-8bd1-98432d9899be",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "47ea8321-71c2-4ec0-a12b-45ff055473ee",
"created_at": "2021-11-15T11:19:43",
"value": "+33635847598",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "710221dd-4c63-46d0-a73f-63bb88df30c9",
"created_at": "2021-11-15T11:19:43",
"value": "jdoe-test4@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "7ff83652-888f-4fa9-8572-2449fe38f686",
"created_at": "2021-11-15T11:19:43",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "47161ea1-94fa-455e-9bb1-a3a95423a4b6",
"created_at": "2021-11-15T11:19:43",
"value": "John",
"element-type": "firstname"
}
],
"uuid": "91a4ca07-3945-418c-9b90-2fc0e333a7ef",
"name": "identityInfos",
"state": "TODO",
"category": "identity",
"created_at": "2021-11-15T11:19:43"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "47161ea1-94fa-455e-9bb1-a3a95423a4b6",
"created_at": "2021-11-15T11:19:43",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "7ff83652-888f-4fa9-8572-2449fe38f686",
"created_at": "2021-11-15T11:19:43",
"value": "Doe",
"element-type": "lastname"
},
"email": {
"status": "COMPLETED",
"uuid": "710221dd-4c63-46d0-a73f-63bb88df30c9",
"created_at": "2021-11-15T11:19:43",
"value": "jdoe-test4@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "cc979904-d5dc-427d-b095-425b365c7df8",
"created_at": "2021-11-15T11:19:43",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "47ea8321-71c2-4ec0-a12b-45ff055473ee",
"created_at": "2021-11-15T11:19:43",
"value": "+33635847598",
"element-type": "phone"
},
"birthday": null,
"login": null,
"bo_user_uuid": null
},
"activity_sector": {
"uuid": "6fcffdab-4ae8-4036-a363-f4c919dd3a69",
"name": "Electronic devices and computers"
},
"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,
"next_step": 0
}
Complete the profile
The profile is completed when the profile[workflow][status] value is "ACCEPTED", for now the status is : "ON_GOING".
A profile is completed when the workflow is accepted. As long as it is not done, steps to fill out will be submitted to unlock the next step.
Note: In sequential mode, profile workflow can go from ACCEPTED to ON_GOING when unlocking question. You have to check workflow status at each completed activity
GET 'https://test-onboarding-api.centralpay.net/api/nauth/merchant-enrollment/{{enrollmentId}}'
curl --location --request GET 'https://test-onboarding-api.centralpay.net/api/nauth/merchant-enrollment/607a9213-a986-435e-8705-aff2c66ec594 \
--header 'Authorization: Basic ZG9jdGVzdDo0STlISlJUZA=='
{
"workflow": null,
"identity_badge": null,
"representatives_list": null,
"infogreffe_identity": null,
"uuid": "607a9213-a986-435e-8705-aff2c66ec594",
"risk_points": null,
"created_at": "2021-11-15T11:19:43",
"last_updated_at": null,
"turnover_is_fixed": false,
"workflow_mode": "CONTINUAL",
"risk_level": null,
"type": null,
"enrollment_account": null,
"profile": {
"uuid": "1a493cd3-9525-44e8-adcd-b706c2c0365e",
"workflow": {
"uuid": "4ba3ad44-acbe-430d-8bd1-98432d9899be",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "47ea8321-71c2-4ec0-a12b-45ff055473ee",
"created_at": "2021-11-15T11:19:43",
"value": "+33635847598",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "710221dd-4c63-46d0-a73f-63bb88df30c9",
"created_at": "2021-11-15T11:19:43",
"value": "jdoe-test4@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "7ff83652-888f-4fa9-8572-2449fe38f686",
"created_at": "2021-11-15T11:19:43",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "47161ea1-94fa-455e-9bb1-a3a95423a4b6",
"created_at": "2021-11-15T11:19:43",
"value": "John",
"element-type": "firstname"
}
],
"uuid": "91a4ca07-3945-418c-9b90-2fc0e333a7ef",
"name": "identityInfos",
"state": "TODO",
"category": "identity",
"created_at": "2021-11-15T11:19:43"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "47161ea1-94fa-455e-9bb1-a3a95423a4b6",
"created_at": "2021-11-15T11:19:43",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "7ff83652-888f-4fa9-8572-2449fe38f686",
"created_at": "2021-11-15T11:19:43",
"value": "Doe",
"element-type": "lastname"
},
"email": {
"status": "COMPLETED",
"uuid": "710221dd-4c63-46d0-a73f-63bb88df30c9",
"created_at": "2021-11-15T11:19:43",
"value": "jdoe-test4@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "cc979904-d5dc-427d-b095-425b365c7df8",
"created_at": "2021-11-15T11:19:43",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "47ea8321-71c2-4ec0-a12b-45ff055473ee",
"created_at": "2021-11-15T11:19:43",
"value": "+33635847598",
"element-type": "phone"
},
"birthday": null,
"login": null,
"bo_user_uuid": null
},
"activity_sector": {
"uuid": "6fcffdab-4ae8-4036-a363-f4c919dd3a69",
"name": "Electronic devices and computers"
},
"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,
"next_step": 0
}
{
"type": "FORM",
"form": {
"children": {
"firstname": {
"extra_data_to_pass": {
"default": "John"
},
"children": {
"value": {}
}
}
}
},
"category": "contact"
}
Complete profile fields
In order to know the fields you will need to complete for the first step of the profile, you must to create a request GET /api/nauth/profile/{{ activityUuid }}/activity containing the activity. The uuid is contained in the following file tree : profile[workflow][ activities][0][uuid].
In this case, you’ve got to make a request `GET /api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity.
To complete this first step, you have to send a form with "John" (by default) as a "firstname". To make this step successful you have to send valid information.
You can find the list of the fields you can have to complete here.
{
"type": "FORM",
"form": {
"children": {
"firstname": {
"extra_data_to_pass": {
"default": "John"
},
"children": {
"value": {}
}
}
}
},
"category": "contact"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity \
-u 'login:password' \
-F firstname[value]=Jean
"workflow": {
"status": "ON_GOING",
"activities": [
{
"uuid": "97d6d67d-bcac-4396-82dd-1d3aa3361df9",
"name": "firstname",
"state": "OK",
"category": "contact",
"created_at": "2018-10-18T10:23:35+00:00",
"step_elements": [
{
"uuid": "3f4ac101-f5da-4003-87ac-45739ce1d7c2",
"value": "Jean",
"element-type": "firstname"
}
]
},
{
"uuid": "f32b0605-54f2-4123-b999-010e56981b4d",
"name": "lastname",
"state": "ON_GOING",
"category": "contact",
"created_at": "2018-10-18T13:19:24+00:00",
"step_elements": [
{
"uuid": "5dc872a0-b365-4773-93c6-e13cdfc0e787",
"value": "Doe",
"element-type": "lastname"
}
]
}
]
},
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/c4821000-0942-42f1-a3a3-85e6d28112e5/activity \
-u 'login:password' \
-H 'content-type: multipart/form-data' \
-F 'identity_document[type]=PASSPORT' \
-F 'identity_document[documents][0]=@/home/user/document.png'
Retrieve the activities
If you make the request GET /api/nauth/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868 once more, the workflow status that was previously in the state "TODO" is now "OK". The next step is now displayed, with a status in "TODO".
As long as an activity in the profil part is in "TODO", you need to complete those steps and repeat the procedure.
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity \
-u 'login:password' \
-F firstname[value]=Jean
"workflow": {
"status": "ON_GOING",
"activities": [
{
"uuid": "97d6d67d-bcac-4396-82dd-1d3aa3361df9",
"name": "firstname",
"state": "OK",
"category": "contact",
"created_at": "2018-10-18T10:23:35+00:00",
"step_elements": [
{
"uuid": "3f4ac101-f5da-4003-87ac-45739ce1d7c2",
"value": "Jean",
"element-type": "firstname"
}
]
},
{
"uuid": "f32b0605-54f2-4123-b999-010e56981b4d",
"name": "lastname",
"state": "ON_GOING",
"category": "contact",
"created_at": "2018-10-18T13:19:24+00:00",
"step_elements": [
{
"uuid": "5dc872a0-b365-4773-93c6-e13cdfc0e787",
"value": "Doe",
"element-type": "lastname"
}
]
}
]
},
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/c4821000-0942-42f1-a3a3-85e6d28112e5/activity \
-u 'login:password' \
-H 'content-type: multipart/form-data' \
-F 'identity_document[type]=PASSPORT' \
-F 'identity_document[documents][0]=@/home/user/document.png'
GET https://test-onboarding-api.centralpay.net/api/nauth/merchant-enrollment/{{enrollmentId}}
{
"uuid": "db6fdfb7-b8b4-4a12-87ac-83fcc2b0b238",
"name": "identityInfos",
"state": "TODO",
"category": "identity",
"created_at": "2021-11-16T09:08:54"
}
GET https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityId}}/activity
{
"type": "FORM",
"form": {
"children": {
"firstname": {
"extra_data_to_pass": {
"default": "John"
},
"children": {
"value": []
}
},
"lastname": {
"extra_data_to_pass": {
"default": "Doe"
},
"children": {
"value": []
}
},
"mail": {
"extra_data_to_pass": {
"default": "jdoe-test4@gmail.com"
},
"children": {
"value": []
}
},
"phone": {
"extra_data_to_pass": {
"default": "+33635847598"
},
"children": {
"value": []
}
},
"birthday": {
"extra_data_to_pass": {
"default": null
},
"children": {
"value": []
}
},
"place_of_birth": {
"extra_data_to_pass": {
"default": null
},
"children": {
"value": []
}
},
"country_of_birth": {
"extra_data_to_pass": {
"default": null
},
"children": {
"country": []
}
}
}
},
"category": "identity"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity \
-u 'login:password' \
-F firstname[value]=Jean \
-F lastname[value]:Valjean
-F mail[value]:jean.valjean@gmail.com
-F phone[value]:+33606060606
-F birthday[value]:1991-05-12
-F place_of_birth[value]:Tours
-F country_of_birth[country]:FRA
{
"type": "FORM",
"form": {
"children": {
"firstname": {
"extra_data_to_pass": {
"default": "John"
},
"children": {
"value": []
}
},
"lastname": {
"extra_data_to_pass": {
"default": "Doe"
},
"children": {
"value": []
}
},
"mail": {
"extra_data_to_pass": {
"default": "jdoe-test4@gmail.com"
},
"children": {
"value": []
}
},
"phone": {
"extra_data_to_pass": {
"default": "+33635847598"
},
"children": {
"value": []
}
},
"birthday": {
"extra_data_to_pass": {
"default": null
},
"children": {
"value": []
}
},
"place_of_birth": {
"extra_data_to_pass": {
"default": null
},
"children": {
"value": []
}
},
"country_of_birth": {
"extra_data_to_pass": {
"default": null
},
"children": {
"country": []
}
}
}
},
"category": "identity"
}
Example for activity profil
Example for activity you need to do for complete a profil.
You need to alternate call to the API to discover the next activity and the fields you need to complete.
GET https://test-onboarding-api.centralpay.net/api/nauth/merchant-enrollment/{{enrollmentId}}
{
"uuid": "db6fdfb7-b8b4-4a12-87ac-83fcc2b0b238",
"name": "identityInfos",
"state": "TODO",
"category": "identity",
"created_at": "2021-11-16T09:08:54"
}
GET https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityId}}/activity
{
"type": "FORM",
"form": {
"children": {
"firstname": {
"extra_data_to_pass": {
"default": "John"
},
"children": {
"value": []
}
},
"lastname": {
"extra_data_to_pass": {
"default": "Doe"
},
"children": {
"value": []
}
},
"mail": {
"extra_data_to_pass": {
"default": "jdoe-test4@gmail.com"
},
"children": {
"value": []
}
},
"phone": {
"extra_data_to_pass": {
"default": "+33635847598"
},
"children": {
"value": []
}
},
"birthday": {
"extra_data_to_pass": {
"default": null
},
"children": {
"value": []
}
},
"place_of_birth": {
"extra_data_to_pass": {
"default": null
},
"children": {
"value": []
}
},
"country_of_birth": {
"extra_data_to_pass": {
"default": null
},
"children": {
"country": []
}
}
}
},
"category": "identity"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity \
-u 'login:password' \
-F firstname[value]=Jean \
-F lastname[value]:Valjean
-F mail[value]:jean.valjean@gmail.com
-F phone[value]:+33606060606
-F birthday[value]:1991-05-12
-F place_of_birth[value]:Tours
-F country_of_birth[country]:FRA
{
"type": "FORM",
"form": {
"children": {
"firstname": {
"extra_data_to_pass": {
"default": "John"
},
"children": {
"value": []
}
},
"lastname": {
"extra_data_to_pass": {
"default": "Doe"
},
"children": {
"value": []
}
},
"mail": {
"extra_data_to_pass": {
"default": "jdoe-test4@gmail.com"
},
"children": {
"value": []
}
},
"phone": {
"extra_data_to_pass": {
"default": "+33635847598"
},
"children": {
"value": []
}
},
"birthday": {
"extra_data_to_pass": {
"default": null
},
"children": {
"value": []
}
},
"place_of_birth": {
"extra_data_to_pass": {
"default": null
},
"children": {
"value": []
}
},
"country_of_birth": {
"extra_data_to_pass": {
"default": null
},
"children": {
"country": []
}
}
}
},
"category": "identity"
}
List of activities profile workflow
List of the activities needed to complete the profil.
{
"type": "FORM",
"form": {
"children": {
"firstname": {
"extra_data_to_pass": {
"default": "Comp Cont. NS LOW"
},
"children": {
"value": []
}
},
"lastname": {
"extra_data_to_pass": {
"default": "Comp Cont. NS LOW"
},
"children": {
"value": []
}
},
"mail": {
"extra_data_to_pass": {
"default": "2qoiifh61@gmail.com"
},
"children": {
"value": []
}
},
"phone": {
"extra_data_to_pass": {
"default": "+33637468743"
},
"children": {
"value": []
}
},
"birthday": {
"extra_data_to_pass": {
"default": null
},
"children": {
"value": []
}
},
"place_of_birth": {
"extra_data_to_pass": {
"default": null
},
"children": {
"value": []
}
},
"country_of_birth": {
"extra_data_to_pass": {
"default": null
},
"children": {
"country": []
}
}
}
},
"category": "identity"
}
Activity Identity Informations
[firstname][value] string (255) |
Firstname |
[lastname][value] string (255) |
Lastname |
[mail][value] String (255) |
|
[phone][value] String |
Internationnal phone number NOTE Min length: 10 |
birthday[value] string |
Birthday Format : aaaa-mm-jj Constraint: - More than 18 years ago - Less than 110 years ago |
place_of_birth[value] String |
Place of birth |
country_of_birth[country] string |
Country of birth
Constraint: ISO 3166-1 alpha-3 |
{
"type": "FORM",
"form": {
"children": {
"firstname": {
"extra_data_to_pass": {
"default": "Comp Cont. NS LOW"
},
"children": {
"value": []
}
},
"lastname": {
"extra_data_to_pass": {
"default": "Comp Cont. NS LOW"
},
"children": {
"value": []
}
},
"mail": {
"extra_data_to_pass": {
"default": "2qoiifh61@gmail.com"
},
"children": {
"value": []
}
},
"phone": {
"extra_data_to_pass": {
"default": "+33637468743"
},
"children": {
"value": []
}
},
"birthday": {
"extra_data_to_pass": {
"default": null
},
"children": {
"value": []
}
},
"place_of_birth": {
"extra_data_to_pass": {
"default": null
},
"children": {
"value": []
}
},
"country_of_birth": {
"extra_data_to_pass": {
"default": null
},
"children": {
"country": []
}
}
}
},
"category": "identity"
}
Activity Domiciliations
address[nameLine1] string (255) |
Address |
address[locality] string (255) |
Address' locality |
address[postalCode] String (255) |
Address' postal code |
address[country] String |
Address' country |
Activity Identity
identity_document[type] ENUM |
Identity document type NOTE: PASSPORT/IDENTITY_CARD Valid and in color |
identity_document[documents] File[] |
a copy of the identity document NOTE: - IDENTITY_CARD: 2 files - PASSPORT: 1 file |
GET https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/37a6c5c5-7ddf-4707-bc71-ce16272d38a4
curl -v\
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/37a6c5c5-7ddf-4707-bc71-ce16272d38a4 \
-u 'login:password'
{
"type": "FORM",
"form": {
"children": {
"company_legal_status": {
"children": {
"value": {}
}
},
"company_registration_number": {
"children": {
"value": {}
}
}
}
},
"category": "company"
}
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/37a6c5c5-7ddf-4707-bc71-ce16272d38a4
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/37a6c5c5-7ddf-4707-bc71-ce16272d38a4 \
-u 'login:password' \
-F company_legal_status[value]=04ddc116-4cde-43c8-b29b-95af62e47907 \
-F company_registration_number[value]=123456789
Complete workflow
You’ve got to complete this workflow like the profile workflow. Depending on the information entered, future steps will be unlocked.
A step can be one of the following types:
- FORM: needs to send information (name, first name…)
- API_CALL: the onboarding makes an external call
- VALIDATION: needs a manual approval in the CentralPay Back office
- ENDED: the worfklow is completed.
The selection of the fields to be sent during a FORM type step, is based on the "children" form name. E.g.: for the field company_legal_status, you have to send the following key company_legal_status[value] with its value.
You can find the possible fields to complete here.
GET https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/37a6c5c5-7ddf-4707-bc71-ce16272d38a4
curl -v\
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/37a6c5c5-7ddf-4707-bc71-ce16272d38a4 \
-u 'login:password'
{
"type": "FORM",
"form": {
"children": {
"company_legal_status": {
"children": {
"value": {}
}
},
"company_registration_number": {
"children": {
"value": {}
}
}
}
},
"category": "company"
}
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/37a6c5c5-7ddf-4707-bc71-ce16272d38a4
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/37a6c5c5-7ddf-4707-bc71-ce16272d38a4 \
-u 'login:password' \
-F company_legal_status[value]=04ddc116-4cde-43c8-b29b-95af62e47907 \
-F company_registration_number[value]=123456789
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/complete
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/complete \
-u 'login:password' \
-F bankAccountInEEACountry=1 \
-F turnover=3b71724f-a267-42b5-a52e-2af091f93d12 \
-F companyName=MyCompanyName \
-F activityAge=9396b5b3-b9bc-491b-9dc7-b941c21f6ff7
{
"code":400,
"message":"Validation Failed",
"errors":{
"errors":[
"No available suite with the entereded data"
],
"children":{
"isCompany":{
},
"type":{
},
"bankAccountInEEACountry":{
},
"companyName":{
},
"activityAge":{
},
"turnover":{
}
}
}
}
{
"workflow":{
"uuid":"d5b49f19-e2a9-4f22-9639-39245a108c8f",
"status":"ON_GOING",
"activities":[
{
"step_elements":[
],
"uuid":"ab512759-fa31-4f49-81df-b764f80d93e3",
"name":"companyInfos",
"state":"TODO",
"category":"company",
"created_at":"2019-03-13T09:00:42+00:00"
}
],
"additional_documents":[
]
},
"uuid": "2aff09ff-1a55-4fff-aa5d-0430d26a3868",
"risk_points": 6,
"type":"COMPANY",
"turnover_is_fixed": false,
"enrollment_account": null,
"profile": "COMPLETED_HIDDEN_HERE",
"activity_sector": {
"name": "Electronic devices and computers"
},
"data":{
"company_name":"MyCompanyName",
"turnover":{
"name":"Less than 200k EUR"
},
"type":"COMPANY"
},
}
Determine workflow
This function allows you to complete merchant enrollment data in order to determine and unlock workflow to apply. It will unlock a new chain of steps to complete, following the same pattern as the profile.
When response code is 400 with message code "No available suite with the entereded data", it's meaning that score risk calculated is too high to match with an accepted workflow.
If a SIREN was created and passed earlier, this step in not required as the workflow was determined earlier.
type* Enum |
Enrollment type INDIVIDUAL | INDIVIDUAL_WITH_STATUS | LEGAL_ENTITY |
bankAccountInEEACountry* bool |
If bank account is in EEA country |
turnover* UUID(36) |
Expected annual turnover POST /api/nauth/enrollment-claim/turnover with type INDIVIDUAL | INDIVIDUAL_WITH_STATUS | LEGAL_ENTITY |
companyName string(255) |
Company name |
activityAge UUID (36) |
Company activity age Required if type is LEGAL_ENTITY or INDIVIDUAL_WITH_STATUS Note: GET /api/nauth/enrollment-claim/activity-age |
subType ENUM |
a advised subtype of the merchant category of work's field Required : advised Note: if the type is 'INDIVIDUAL_WITH_STATUS' the subtypes available are : 'SOLE_TRADER', 'MERCHANT', 'ARTISAN' . if the type is 'LEGAL_ENTITY' the subtype available are : 'ASSOCIATION', 'PUBLIC', 'COMMERCIAL', 'EIG', 'CIVIL' . if the type is 'INDIVIDUAL' the subtype available is : 'INDIVIDUAL' . |
isCompany Bool |
If you are a company Required if type is LEGAL_ENTITY |
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/complete
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/complete \
-u 'login:password' \
-F bankAccountInEEACountry=1 \
-F turnover=3b71724f-a267-42b5-a52e-2af091f93d12 \
-F companyName=MyCompanyName \
-F activityAge=9396b5b3-b9bc-491b-9dc7-b941c21f6ff7
{
"code":400,
"message":"Validation Failed",
"errors":{
"errors":[
"No available suite with the entereded data"
],
"children":{
"isCompany":{
},
"type":{
},
"bankAccountInEEACountry":{
},
"companyName":{
},
"activityAge":{
},
"turnover":{
}
}
}
}
{
"workflow":{
"uuid":"d5b49f19-e2a9-4f22-9639-39245a108c8f",
"status":"ON_GOING",
"activities":[
{
"step_elements":[
],
"uuid":"ab512759-fa31-4f49-81df-b764f80d93e3",
"name":"companyInfos",
"state":"TODO",
"category":"company",
"created_at":"2019-03-13T09:00:42+00:00"
}
],
"additional_documents":[
]
},
"uuid": "2aff09ff-1a55-4fff-aa5d-0430d26a3868",
"risk_points": 6,
"type":"COMPANY",
"turnover_is_fixed": false,
"enrollment_account": null,
"profile": "COMPLETED_HIDDEN_HERE",
"activity_sector": {
"name": "Electronic devices and computers"
},
"data":{
"company_name":"MyCompanyName",
"turnover":{
"name":"Less than 200k EUR"
},
"type":"COMPANY"
},
}
List of activities
List of activities for completed workflow
Activity Article signed
Available Soon
article_signed[document] File |
Article signed Validity : less than 3 months old Up-to-date and signed Articles of Incorporation. |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'iban[value]=iban' \
-F 'bic[value]=bic' \
-F 'iban_document[document]=@/home/user/iban.png' \
{
"type": "FORM",
"form": {
"children": {
"iban": {
"children": {
"value": []
}
},
"bic": {
"children": {
"value": []
}
},
"iban_document": {
"children": {
"document": []
}
}
}
},
"category": "bank"
}
Activity BankA
iban[value] string |
IBAN number Constraint: ISO 13616 |
bic[value] string |
BIC or SWIFT number Constraint: ISO 9362 |
iban_document[document] File |
Iban document |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'iban[value]=iban' \
-F 'bic[value]=bic' \
-F 'iban_document[document]=@/home/user/iban.png' \
{
"type": "FORM",
"form": {
"children": {
"iban": {
"children": {
"value": []
}
},
"bic": {
"children": {
"value": []
}
},
"iban_document": {
"children": {
"document": []
}
}
}
},
"category": "bank"
}
Activity Billing descriptor
Available Soon
billing_descriptor[value] string(16) |
Billing descriptor |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'complementary_identity_document[documents][0]=@/home/user/complementary_identity_document.png' \
{
"type": "FORM",
"form": {
"children": {
"complementary_identity_document": {
"children": {
"documents": {
"children": [
[]
]
}
}
}
}
},
"category": "validation"
}
Activity CompIdentityA
complementary_identity_document[documents] File |
Complementary identity documents Identity document, passport, driving licence, |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'complementary_identity_document[documents][0]=@/home/user/complementary_identity_document.png' \
{
"type": "FORM",
"form": {
"children": {
"complementary_identity_document": {
"children": {
"documents": {
"children": [
[]
]
}
}
}
}
},
"category": "validation"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWkId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'address[locality]=Tours' \
-F 'address[postalCode]=37000' \
-F 'address[country]=FRA' \
-F 'address[nameLine1]=10 Boulevard Beranger'
{
"type": "FORM",
"form": {
"children": {
"address": {
"extra_data_to_pass": {
"default": {
"nameLine1": null,
"nameLine2": null,
"nameLine3": null,
"nameLine4": null,
"locality": null,
"postalCode": null,
"country": null
}
},
"children": {
"nameLine1": [],
"nameLine2": [],
"nameLine3": [],
"nameLine4": [],
"locality": [],
"postalCode": [],
"country": []
}
}
}
},
"category": "company"
}
Activity CompanyAddressA
address[nameLine1] string (255) |
Address name line 1 |
address[locality] string (255) |
Address locality |
address[postalCode] string (255) |
Address postal code |
address[country] string (255) |
Address country |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWkId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'address[locality]=Tours' \
-F 'address[postalCode]=37000' \
-F 'address[country]=FRA' \
-F 'address[nameLine1]=10 Boulevard Beranger'
{
"type": "FORM",
"form": {
"children": {
"address": {
"extra_data_to_pass": {
"default": {
"nameLine1": null,
"nameLine2": null,
"nameLine3": null,
"nameLine4": null,
"locality": null,
"postalCode": null,
"country": null
}
},
"children": {
"nameLine1": [],
"nameLine2": [],
"nameLine3": [],
"nameLine4": [],
"locality": [],
"postalCode": [],
"country": []
}
}
}
},
"category": "company"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'company_validation[company_validation_response]=YES'
{
"type": "FORM",
"form": {
"children": {
"company_validation": {
"extra_data_to_pass": {
"company_name": "CENTRALPAY",
"commercial_name": "CENTRALPAY-SETRAFI-FIDELYPAY",
"sign": null,
"acronym": "",
"legal_form_wording": "Soci\u00e9t\u00e9 par actions simplifi\u00e9e",
"activity_code": "6202A",
"activity_label": "Conseil en syst\u00e8mes et logiciels informatiques",
"registration_date": "2002-06-21",
"is_delisted_company": false,
"delisted_date": null,
"adress_postal_code": "37000",
"adress_street_number": "19",
"adress_street_type": null,
"adress_street_name": "RUE EDOUARD VAILLANT",
"adress_town": "TOURS",
"adress_country_code": null,
"siren": "442441630"
},
"children": {
"company_validation_response": []
}
}
}
},
"category": "company"
}
Activity CompanyInfosA with SIREN
company_validation[company_validation_response] Bool |
Company Informations Validation |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'company_validation[company_validation_response]=YES'
{
"type": "FORM",
"form": {
"children": {
"company_validation": {
"extra_data_to_pass": {
"company_name": "CENTRALPAY",
"commercial_name": "CENTRALPAY-SETRAFI-FIDELYPAY",
"sign": null,
"acronym": "",
"legal_form_wording": "Soci\u00e9t\u00e9 par actions simplifi\u00e9e",
"activity_code": "6202A",
"activity_label": "Conseil en syst\u00e8mes et logiciels informatiques",
"registration_date": "2002-06-21",
"is_delisted_company": false,
"delisted_date": null,
"adress_postal_code": "37000",
"adress_street_number": "19",
"adress_street_type": null,
"adress_street_name": "RUE EDOUARD VAILLANT",
"adress_town": "TOURS",
"adress_country_code": null,
"siren": "442441630"
},
"children": {
"company_validation_response": []
}
}
}
},
"category": "company"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'company_registration_number[value]=123456' \
-F 'company_registration_number_document[document]=@/home/user/registration_number_document.png'
{
"type": "FORM",
"form": {
"children": {
"company_registration_number": {
"children": {
"value": []
}
},
"company_registration_number_document": {
"children": {
"document": []
}
}
}
},
"category": "company"
}
Activity CompanyInfosA without SIREN
company_registration_number[value] string (20) |
Company registration number |
company_registration_number_document[document] file |
Company registration document Validity : less than 3 months old DEPRECATED |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'company_registration_number[value]=123456' \
-F 'company_registration_number_document[document]=@/home/user/registration_number_document.png'
{
"type": "FORM",
"form": {
"children": {
"company_registration_number": {
"children": {
"value": []
}
},
"company_registration_number_document": {
"children": {
"document": []
}
}
}
},
"category": "company"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'company_legal_status_document[document]=@/home/user/legal_status_document.png' \
{
"type": "FORM",
"form": {
"children": {
"company_legal_status_document": {
"children": {
"document": []
}
}
}
},
"category": "validation"
}
Activity CompanyStatusA
company_legal_status_document[document] File |
Company legal status document |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'company_legal_status_document[document]=@/home/user/legal_status_document.png' \
{
"type": "FORM",
"form": {
"children": {
"company_legal_status_document": {
"children": {
"document": []
}
}
}
},
"category": "validation"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'company_registration_number_document[document]=@/home/user/company_registration_number_document.png' \
{
"type": "FORM",
"form": {
"children": {
"company_registration_number_document": {
"children": {
"document": []
}
}
}
},
"category": "validation"
}
Activity CompanyDocA
company_registration_number_document[document] File |
Company registration document Validity : less than 3 months old DEPRECATED |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'company_registration_number_document[document]=@/home/user/company_registration_number_document.png' \
{
"type": "FORM",
"form": {
"children": {
"company_registration_number_document": {
"children": {
"document": []
}
}
}
},
"category": "validation"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'contract_validation[centralpayProspection]=true' \
-F 'contract_validation[partnersProspection]=false' \
-F 'contract_validation[otp]=806068' \
{
"type": "FORM",
"form": {
"children": {
"contract_validation": {
"extra_data_to_pass": {
"type": "COMPANY",
"account_type": "STANDARD",
"contact_firstname": "Comp Seq. NS",
"contact_lastname": "Comp Seq. NS",
"cgu": "<p>sdf</p>",
"fee_schedule": "<p>grille CPAY RESELER</p>",
"company_name": "MyCompanyName",
"company_registration_number": "123456789"
},
"children": {
"centralpayProspection": [],
"partnersProspection": [],
"otp": []
}
}
}
},
"category": "validation"
}
Activity ContractValiA
contract_validation[centralpayProspection] Bool |
Authorize centralpay prospection |
contract_validation[partnersProspection] bool |
Authorize partners prospection |
contract_validation[otp] string |
OTP value NOTE: POST /{merchantUuid}/activity/{uuid}/otp |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'contract_validation[centralpayProspection]=true' \
-F 'contract_validation[partnersProspection]=false' \
-F 'contract_validation[otp]=806068' \
{
"type": "FORM",
"form": {
"children": {
"contract_validation": {
"extra_data_to_pass": {
"type": "COMPANY",
"account_type": "STANDARD",
"contact_firstname": "Comp Seq. NS",
"contact_lastname": "Comp Seq. NS",
"cgu": "<p>sdf</p>",
"fee_schedule": "<p>grille CPAY RESELER</p>",
"company_name": "MyCompanyName",
"company_registration_number": "123456789"
},
"children": {
"centralpayProspection": [],
"partnersProspection": [],
"otp": []
}
}
}
},
"category": "validation"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'director_list[items][0][firstname][value]=Caroline' \
-F 'director_list[items][0][lastname][value]=Richard' \
-F 'director_list[items][0][email][value]=test@gmail.com' \
-F 'director_list[profileIsItem]=1' \
-F 'director_list[items][0][identity_document][type]=IDENTITY_CARD' \
-F 'director_list[items][0][identity_document][documents][0]=@/home/user/identity_document.png' \
-F 'director_list[items][0][identity_document][documents][1]=@/home/user/identity_document2.png'
{
"type": "FORM",
"form": {
"children": {
"director_list": {
"extra_data_to_pass": {
"atLeast": 0
},
"children": {
"profileIsItem": [],
"items": {
"children": [
{
"children": {
"firstname": {
"children": {
"value": []
}
},
"lastname": {
"children": {
"value": []
}
},
"email": {
"children": {
"value": []
}
},
"identity_document": {
"children": {
"type": [],
"documents": {
"children": [
[],
[]
]
}
}
}
}
}
]
}
}
}
}
},
"category": "company"
}
Activity DirectorsInfosA
director_list[items][0][firstname][value] string (255) |
Director firstname |
director_list[items][0][lastname][value] string (255) |
Director lastname |
director_list[items][0][email][value] String (255) |
Director email |
director_list[items][0][identity_document][documents][0] File |
Director identity document 1 |
director_list[items][0][identity_document][documents][1] File |
Director identity document 2 |
director_list[profileIsItem] bool |
Is the onboarded person a director |
director_list[items][0][identity_document][type] ENUM |
IDENTITY_CARD / PASSPORT |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'director_list[items][0][firstname][value]=Caroline' \
-F 'director_list[items][0][lastname][value]=Richard' \
-F 'director_list[items][0][email][value]=test@gmail.com' \
-F 'director_list[profileIsItem]=1' \
-F 'director_list[items][0][identity_document][type]=IDENTITY_CARD' \
-F 'director_list[items][0][identity_document][documents][0]=@/home/user/identity_document.png' \
-F 'director_list[items][0][identity_document][documents][1]=@/home/user/identity_document2.png'
{
"type": "FORM",
"form": {
"children": {
"director_list": {
"extra_data_to_pass": {
"atLeast": 0
},
"children": {
"profileIsItem": [],
"items": {
"children": [
{
"children": {
"firstname": {
"children": {
"value": []
}
},
"lastname": {
"children": {
"value": []
}
},
"email": {
"children": {
"value": []
}
},
"identity_document": {
"children": {
"type": [],
"documents": {
"children": [
[],
[]
]
}
}
}
}
}
]
}
}
}
}
},
"category": "company"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'representative_list[representatives_list][0][identity_document][type]=PASSPORT' \
-F 'representative_list[representatives_list][0][identity_document][documents][0]=@/home/user/identity_document.png' \
-F 'representative_list[representatives_list][0][uuid]=d7ebeb08-3cbf-4737-b124-d0029ca378c9' \
{
"type": "FORM",
"form": {
"children": {
"representative_list": {
"extra_data_to_pass": [{
"uuid": "d7ebeb08-3cbf-4737-b124-d0029ca378c9",
"firstname": "GUILLAUME MAXIMILIEN JACQUES MAR",
"lastname": "PONSARD",
"usual_name": null,
"birthday": "1974-01-08",
"is_natural_person": true,
"role": "PRESIDENT"
}, {
"uuid": "ff418f3d-41c3-42f8-9649-1df51a6f9726",
"firstname": "ANTHONY",
"lastname": "MABILLEAU",
"usual_name": null,
"birthday": "1979-01-05",
"is_natural_person": true,
"role": "DIRECTEUR GENERAL"
}],
"children": {
"representatives_list": {
"children": [{
"children": {
"uuid": [],
"identity_document": {
"children": {
"type": [],
"documents": {
"children": [
[]
]
}
}
}
}
}, {
"children": {
"uuid": [],
"identity_document": {
"children": {
"type": [],
"documents": {
"children": [
[]
]
}
}
}
}
}]
}
}
}
}
},
"category": "director"
}
Activity DirectorsInfosA with SIREN
representative_list[representatives_list][*][uuid] string (255) |
Uuid of the representative |
representative_list[representatives_list][*][identity_document][type] ENUM |
Identity document type NOTE: PASSPORT/IDENTITY_CARD Valid and in color |
representative_list[representatives_list][*][identity_document][documents][*] File |
List of identity document - IDENTITY_CARD: 2 files - PASSPORT: 1 file |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'representative_list[representatives_list][0][identity_document][type]=PASSPORT' \
-F 'representative_list[representatives_list][0][identity_document][documents][0]=@/home/user/identity_document.png' \
-F 'representative_list[representatives_list][0][uuid]=d7ebeb08-3cbf-4737-b124-d0029ca378c9' \
{
"type": "FORM",
"form": {
"children": {
"representative_list": {
"extra_data_to_pass": [{
"uuid": "d7ebeb08-3cbf-4737-b124-d0029ca378c9",
"firstname": "GUILLAUME MAXIMILIEN JACQUES MAR",
"lastname": "PONSARD",
"usual_name": null,
"birthday": "1974-01-08",
"is_natural_person": true,
"role": "PRESIDENT"
}, {
"uuid": "ff418f3d-41c3-42f8-9649-1df51a6f9726",
"firstname": "ANTHONY",
"lastname": "MABILLEAU",
"usual_name": null,
"birthday": "1979-01-05",
"is_natural_person": true,
"role": "DIRECTEUR GENERAL"
}],
"children": {
"representatives_list": {
"children": [{
"children": {
"uuid": [],
"identity_document": {
"children": {
"type": [],
"documents": {
"children": [
[]
]
}
}
}
}
}, {
"children": {
"uuid": [],
"identity_document": {
"children": {
"type": [],
"documents": {
"children": [
[]
]
}
}
}
}
}]
}
}
}
}
},
"category": "director"
}
Activity DirectorsInfosA with SIREN - Add a new list
If you want to add a new list of representatives or update an existing list
representative_list[representatives_list][*][firstname] string (255) |
Director firstname |
representative_list[representatives_list][*][lastname] string (255) |
Director lastname |
representative_list[representatives_list][*][birthday] string (255) |
Birthday Format : aaaa-mm-jj |
representatives_list[*][identity_document][type] ENUM |
Identity document type - IDENTITY_CARD: 2 files - PASSPORT: 1 file |
representative_list[representatives_list][*][role] ENUM |
Role of director PRESIDENT,PRESIDENT_DU_DIRECTOIRE,VICE_PRESIDENT DIRECTEUR_GENERAL,DIRECTEUR_GENERAL_DELEGUE DIRECTEUR,GERANT,GERANT_NON_ASSOCIE |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityId}}/activity \
-u 'login:password' \
-F 'identity_document[type]=PASSPORT' \
-F 'identity_document[documents][0]=@/home/user/identity_document.png' \
{
"type": "FORM",
"form": {
"children": {
"identity_document": {
"children": {
"type": [],
"documents": {
"children": [
[]
]
}
}
}
}
},
"category": "proof"
}
Activity Identity - Company Sequential
identity_document[type] ENUM |
List of identity document IDENTITY_CARD / PASSPORT |
identity_document[documents][0] file |
Identity document |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityId}}/activity \
-u 'login:password' \
-F 'identity_document[type]=PASSPORT' \
-F 'identity_document[documents][0]=@/home/user/identity_document.png' \
{
"type": "FORM",
"form": {
"children": {
"identity_document": {
"children": {
"type": [],
"documents": {
"children": [
[]
]
}
}
}
}
},
"category": "proof"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'income_document[document]=@/home/user/income_document.png' \
{
"type": "FORM",
"form": {
"children": {
"income_document": {
"children": {
"document": []
}
}
}
},
"category": "company"
}
Activity IncomeA
income_document[document] file |
Document proof on income |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'income_document[document]=@/home/user/income_document.png' \
{
"type": "FORM",
"form": {
"children": {
"income_document": {
"children": {
"document": []
}
}
}
},
"category": "company"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'point_of_sale_url[value]=https://www.test-onboarding.com'
{
"type": "FORM",
"form": {
"children": {
"point_of_sale_url": {
"children": {
"value": []
}
}
}
},
"category": "company"
}
Activity StandardA
point_of_sale_url[value] string (255) |
Point of sale url Constraints: URL |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'point_of_sale_url[value]=https://www.test-onboarding.com'
{
"type": "FORM",
"form": {
"children": {
"point_of_sale_url": {
"children": {
"value": []
}
}
}
},
"category": "company"
}
Activity Proof Registration Artisan
Available Soon
proof_registration_artisant[document] File |
Proof registration artisan Validity : less than 3 months old Recent extract from the Registry /Tax Office. |
Activity Proof Registration Association
Available Soon
proof_registration_association[document] File |
Proof registration association Validity : less than 3 months old Association registration proofs. |
Activity Proof registration company
Available Soon
proof_registration_company[document] File |
Proof registration company Validity : less than 3 months old Recent extract from the Registry or Commerce. |
Activity Proof registration public
Available Soon
proof_registration_public[document] File |
Proof registration public Validity : less than 3 months old Public Entity registration proofs. |
Activity Proof registration sole-trader
Available Soon
proof_registration_sole_trader_first[document] File |
Proof registration sole-trader first Validity : less than 3 months old Recent extract from the Registry/Tax Office. (Avis de situation SIRENE) |
proof_registration_sole_trader_second[document] File |
Proof registration sole-trader second Validity : less than 3 months old Recent extract from the Registry/Tax Office. (Attestation de vigilance URSSAF) |
Activity ProofAddressA
proof_of_address_document[document] file |
Document proof of address |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'question[response]=YES' \
{
"type": "FORM",
"form": {
"children": {
"question": {
"extra_data_to_pass": {
"type": "UNLOCK_PAYOUT_LIMITS",
"current_payin_min": 0,
"current_payin_max": 2500,
"next_payin_min": 2500,
"next_payin_max": 200000,
"current_payout_max": 250,
"can_unlock_limit": true,
"choices": [
"YES",
"NO"
]
},
"children": {
"response": []
}
}
}
},
"category": "validation"
}
Activity Question lvl1
question[response] string (255) |
Increase acquiring and payout limits Choices : YES / NO |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'question[response]=YES' \
{
"type": "FORM",
"form": {
"children": {
"question": {
"extra_data_to_pass": {
"type": "UNLOCK_PAYOUT_LIMITS",
"current_payin_min": 0,
"current_payin_max": 2500,
"next_payin_min": 2500,
"next_payin_max": 200000,
"current_payout_max": 250,
"can_unlock_limit": true,
"choices": [
"YES",
"NO"
]
},
"children": {
"response": []
}
}
}
},
"category": "validation"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'question[response]=YES' \
{
"type": "FORM",
"form": {
"children": {
"question": {
"extra_data_to_pass": {
"type": "UNLOCK_PAYOUT_LIMITS",
"current_payin_min": 2500,
"current_payin_max": 200000,
"next_payin_min": 200000,
"next_payin_max": 500000,
"current_payout_max": null,
"can_unlock_limit": true,
"choices": [
"YES",
"NO"
]
},
"children": {
"response": []
}
}
}
},
"category": "validation"
}
Activity Question lvl2
question[response] string (255) |
Increase acquiring and payout limits Choices : YES / NO |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'question[response]=YES' \
{
"type": "FORM",
"form": {
"children": {
"question": {
"extra_data_to_pass": {
"type": "UNLOCK_PAYOUT_LIMITS",
"current_payin_min": 2500,
"current_payin_max": 200000,
"next_payin_min": 200000,
"next_payin_max": 500000,
"current_payout_max": null,
"can_unlock_limit": true,
"choices": [
"YES",
"NO"
]
},
"children": {
"response": []
}
}
}
},
"category": "validation"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'question[response]=YES' \
{
"type": "FORM",
"form": {
"children": {
"question": {
"extra_data_to_pass": {
"type": "UNLOCK_PAYOUT_LIMITS",
"current_payin_min": 200000,
"current_payin_max": 500000,
"next_payin_min": 500000,
"next_payin_max": null,
"current_payout_max": null,
"can_unlock_limit": true,
"choices": [
"YES",
"NO"
]
},
"children": {
"response": []
}
}
}
},
"category": "validation"
}
Activity Question lvl3
question[reponse] Bool |
Increase acquiring and payout limits Choices : YES / NO |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'question[response]=YES' \
{
"type": "FORM",
"form": {
"children": {
"question": {
"extra_data_to_pass": {
"type": "UNLOCK_PAYOUT_LIMITS",
"current_payin_min": 200000,
"current_payin_max": 500000,
"next_payin_min": 500000,
"next_payin_max": null,
"current_payout_max": null,
"can_unlock_limit": true,
"choices": [
"YES",
"NO"
]
},
"children": {
"response": []
}
}
}
},
"category": "validation"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'ubo_list[items][0][firstname][value]=Caroline' \
-F 'ubo_list[items][0][lastname][value]=Richard' \
-F 'ubo_list[profileIsItem]=true' \
-F 'ubo_list[items][0][identity_document][type]=IDENTITY_CARD' \
-F 'ubo_list[items][0][identity_document][documents][0]=@/home/user/identity_document.png' \
-F 'ubo_list[items][0][identity_document][documents][1]=@/home/user/identity_document2.png' \
-F 'ubo_list[items][0][birthday][value]=1997-09-22' \
-F 'ubo_list[items][0][place_of_birth][value]=Orléans' \
-F 'ubo_list[items][0][country_of_birth][country]=FRA' \
{
"type": "FORM",
"form": {
"children": {
"ubo_list": {
"extra_data_to_pass": {
"atLeast": 1,
"percent": 25
},
"children": {
"profileIsItem": [],
"items": {
"children": [
{
"children": {
"firstname": {
"children": {
"value": []
}
},
"lastname": {
"children": {
"value": []
}
},
"birthday": {
"children": {
"value": []
}
},
"place_of_birth": {
"children": {
"value": []
}
},
"country_of_birth": {
"children": {
"country": []
}
},
"identity_document": {
"children": {
"type": [],
"documents": {
"children": [
[],
[]
]
}
}
}
}
}
]
}
}
}
}
},
"category": "company"
}
Activity UBOInfosA
ubo_list[items][0][firstname][value] string (255) |
Ubo firstname |
ubo_list[items][0][lastname][value] string (255) |
Ubo lastname |
ubo_list[items][0][identity_document][documents][0] File |
Ubo identity document 1 |
ubo_list[items][0][identity_document][documents][1] File |
Ubo identity document 2 |
ubo_list[profileIsItem] Bool |
Ubo list item |
ubo_list[items][0][identity_document][type] ENUM |
Ubo identity document - IDENTITY_CARD: 2 files - PASSPORT: 1 file |
ubo_list[items][0][birthday][value] String |
Ubo birthday Format : aaaa-mm-jj Constraint: - More than 18 years ago - Less than 110 years ago |
ubo_list[items][0][place_of_birth][value] String |
Ubo place of birth |
ubo_list[items][0][country_of_birth][country] String |
Ubo country of birth Constraint: ISO 3166-1 alpha-3 |
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/{{activityWorkflowId}}/activity \
-u 'login:password' \
-F 'ubo_list[items][0][firstname][value]=Caroline' \
-F 'ubo_list[items][0][lastname][value]=Richard' \
-F 'ubo_list[profileIsItem]=true' \
-F 'ubo_list[items][0][identity_document][type]=IDENTITY_CARD' \
-F 'ubo_list[items][0][identity_document][documents][0]=@/home/user/identity_document.png' \
-F 'ubo_list[items][0][identity_document][documents][1]=@/home/user/identity_document2.png' \
-F 'ubo_list[items][0][birthday][value]=1997-09-22' \
-F 'ubo_list[items][0][place_of_birth][value]=Orléans' \
-F 'ubo_list[items][0][country_of_birth][country]=FRA' \
{
"type": "FORM",
"form": {
"children": {
"ubo_list": {
"extra_data_to_pass": {
"atLeast": 1,
"percent": 25
},
"children": {
"profileIsItem": [],
"items": {
"children": [
{
"children": {
"firstname": {
"children": {
"value": []
}
},
"lastname": {
"children": {
"value": []
}
},
"birthday": {
"children": {
"value": []
}
},
"place_of_birth": {
"children": {
"value": []
}
},
"country_of_birth": {
"children": {
"country": []
}
},
"identity_document": {
"children": {
"type": [],
"documents": {
"children": [
[],
[]
]
}
}
}
}
}
]
}
}
}
}
},
"category": "company"
}
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollmentId}}/activity/{{activityId}}
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/da3e4d07-108f-491e-a538-d0dbc1e3824f/activity/7146d276-bb4b-4152-a217-16420f6c2be2 \
-u 'login:password' \
-F contract_validation[otp]:123456
{
"type": "FORM",
"form": {
"children": {
"contract_validation": {
"extra_data_to_pass": {
"type": "PARTICULAR",
"account_type": "STANDARD",
"contact_firstname": "Jean",
"contact_lastname": "Valjean",
"cgu": "<p>sdf</p>",
"fee_schedule": "<p>grille CPAY RESELER</p>"
},
"children": {
"centralpayProspection": [],
"partnersProspection": [],
"otp": []
}
}
}
},
"category": "validation"
}
Complete OTP
Complete OTP
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollmentId}}/activity/{{activityId}}
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/da3e4d07-108f-491e-a538-d0dbc1e3824f/activity/7146d276-bb4b-4152-a217-16420f6c2be2 \
-u 'login:password' \
-F contract_validation[otp]:123456
{
"type": "FORM",
"form": {
"children": {
"contract_validation": {
"extra_data_to_pass": {
"type": "PARTICULAR",
"account_type": "STANDARD",
"contact_firstname": "Jean",
"contact_lastname": "Valjean",
"cgu": "<p>sdf</p>",
"fee_schedule": "<p>grille CPAY RESELER</p>"
},
"children": {
"centralpayProspection": [],
"partnersProspection": [],
"otp": []
}
}
}
},
"category": "validation"
}
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollmentId}}/workflow/reset
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollmentId}}/workflow/reset \
-u 'login:password'
{
"workflow": {
"uuid": "c18be015-f97f-4ffb-bd6b-2e4a028f2d69",
"status": "ON_GOING",
"activities": [
{
"step_elements": [],
"uuid": "3fe8861d-cd6b-4f72-a3e2-18a1ee268d27",
"name": "BankA",
"state": "TODO",
"category": "bank",
"created_at": "2021-01-04T16:07:37+01:00"
},
{
"step_elements": [],
"uuid": "3fe8861d-cd6b-4f72-a3e2-18a1ee268d27",
"name": "BankA",
"state": "TODO",
"category": "bank",
"created_at": "2021-01-04T16:07:37+01:00"
}
],
"additional_documents": []
},
"uuid": "c6f8e3f4-d455-4715-a94c-5a991d58b1df",
"risk_points": 2,
"created_at": "2021-01-04T16:06:16+01:00",
"last_updated_at": "2021-01-04T16:07:31+01:00",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"type": "INDIVIDUAL",
"enrollment_account": {
"login": "q9yrqodq6@gmail.com"
},
"profile": {
"uuid": "5784381c-6968-4ea4-8ca4-68dac1f181a8",
"workflow": {
"uuid": "1b795690-c35f-439d-99a6-08178c2ce016",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "05533726-9c10-472c-be60-6cd3a0d09f7c",
"value": "Richard",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "78ca8254-da6d-4c18-834a-e5c4b080d6a0",
"value": "Caroline",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "33fa1c17-abed-45c3-8ecc-35fd6ce6f90b",
"country": "FRA",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "febd87ef-3736-4d6e-9adc-1bc18b4da716",
"value": "Orléans",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "f378be71-d021-462d-8a42-ea217972f49a",
"value": "+33682242649",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "b776bce2-c432-4bd3-ab6b-6fc1c5ae82ef",
"value": "q9yrqodq6@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "017dbe9a-eb58-4979-bd62-45027ec1a911",
"value": "1997-09-22T00:00:00+02:00",
"element-type": "birthday"
}
],
"uuid": "01e41cde-434c-4ad8-b0d8-a242c8f49e3b",
"name": "identityInfos",
"state": "OK",
"category": "identity",
"created_at": "2021-01-04T16:06:16+01:00"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "1c6e7237-01d0-4a06-b835-dcdb737673db",
"name_line1": "19 rue édouard vaillant",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Tours",
"postal_code": "37000",
"country": "FRA",
"element-type": "address"
}
],
"uuid": "1567400d-8234-4efd-b3b3-0fb402ebfc40",
"name": "domiciliation",
"state": "OK",
"category": "identity",
"created_at": "2021-01-04T16:06:29+01:00"
},
{
"step_elements": [],
"uuid": "675f9932-f292-439f-b825-d477ea314237",
"name": "finished",
"state": "OK",
"category": null,
"created_at": "2021-01-04T16:06:43+01:00"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "78ca8254-da6d-4c18-834a-e5c4b080d6a0",
"value": "Caroline",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "05533726-9c10-472c-be60-6cd3a0d09f7c",
"value": "Richard",
"element-type": "lastname"
},
"email": {
"status": "COMPLETED",
"uuid": "b776bce2-c432-4bd3-ab6b-6fc1c5ae82ef",
"value": "q9yrqodq6@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "fcfb60d4-2eaa-49d0-aca8-06e6ecde3bbe",
"locale": {
"identifier": "en"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "f378be71-d021-462d-8a42-ea217972f49a",
"value": "+33682242649",
"element-type": "phone"
},
"login": "q9yrqodq6@gmail.com",
"bo_user_uuid": null
},
"activity_sector": {
"name": "Events & ticketing"
},
"data": {
"type": "PARTICULAR",
"company_name": null,
"turnover": null,
"activity_age": 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
}
Reset a Workflow
This request can be used if a false information was set during the workflow. It will reset the workflow at it's beginning.
uuid* string (255) |
the uuid of your enrollment Required : yes |
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollmentId}}/workflow/reset
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollmentId}}/workflow/reset \
-u 'login:password'
{
"workflow": {
"uuid": "c18be015-f97f-4ffb-bd6b-2e4a028f2d69",
"status": "ON_GOING",
"activities": [
{
"step_elements": [],
"uuid": "3fe8861d-cd6b-4f72-a3e2-18a1ee268d27",
"name": "BankA",
"state": "TODO",
"category": "bank",
"created_at": "2021-01-04T16:07:37+01:00"
},
{
"step_elements": [],
"uuid": "3fe8861d-cd6b-4f72-a3e2-18a1ee268d27",
"name": "BankA",
"state": "TODO",
"category": "bank",
"created_at": "2021-01-04T16:07:37+01:00"
}
],
"additional_documents": []
},
"uuid": "c6f8e3f4-d455-4715-a94c-5a991d58b1df",
"risk_points": 2,
"created_at": "2021-01-04T16:06:16+01:00",
"last_updated_at": "2021-01-04T16:07:31+01:00",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"type": "INDIVIDUAL",
"enrollment_account": {
"login": "q9yrqodq6@gmail.com"
},
"profile": {
"uuid": "5784381c-6968-4ea4-8ca4-68dac1f181a8",
"workflow": {
"uuid": "1b795690-c35f-439d-99a6-08178c2ce016",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "05533726-9c10-472c-be60-6cd3a0d09f7c",
"value": "Richard",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "78ca8254-da6d-4c18-834a-e5c4b080d6a0",
"value": "Caroline",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "33fa1c17-abed-45c3-8ecc-35fd6ce6f90b",
"country": "FRA",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "febd87ef-3736-4d6e-9adc-1bc18b4da716",
"value": "Orléans",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "f378be71-d021-462d-8a42-ea217972f49a",
"value": "+33682242649",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "b776bce2-c432-4bd3-ab6b-6fc1c5ae82ef",
"value": "q9yrqodq6@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "017dbe9a-eb58-4979-bd62-45027ec1a911",
"value": "1997-09-22T00:00:00+02:00",
"element-type": "birthday"
}
],
"uuid": "01e41cde-434c-4ad8-b0d8-a242c8f49e3b",
"name": "identityInfos",
"state": "OK",
"category": "identity",
"created_at": "2021-01-04T16:06:16+01:00"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "1c6e7237-01d0-4a06-b835-dcdb737673db",
"name_line1": "19 rue édouard vaillant",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Tours",
"postal_code": "37000",
"country": "FRA",
"element-type": "address"
}
],
"uuid": "1567400d-8234-4efd-b3b3-0fb402ebfc40",
"name": "domiciliation",
"state": "OK",
"category": "identity",
"created_at": "2021-01-04T16:06:29+01:00"
},
{
"step_elements": [],
"uuid": "675f9932-f292-439f-b825-d477ea314237",
"name": "finished",
"state": "OK",
"category": null,
"created_at": "2021-01-04T16:06:43+01:00"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "78ca8254-da6d-4c18-834a-e5c4b080d6a0",
"value": "Caroline",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "05533726-9c10-472c-be60-6cd3a0d09f7c",
"value": "Richard",
"element-type": "lastname"
},
"email": {
"status": "COMPLETED",
"uuid": "b776bce2-c432-4bd3-ab6b-6fc1c5ae82ef",
"value": "q9yrqodq6@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "fcfb60d4-2eaa-49d0-aca8-06e6ecde3bbe",
"locale": {
"identifier": "en"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "f378be71-d021-462d-8a42-ea217972f49a",
"value": "+33682242649",
"element-type": "phone"
},
"login": "q9yrqodq6@gmail.com",
"bo_user_uuid": null
},
"activity_sector": {
"name": "Events & ticketing"
},
"data": {
"type": "PARTICULAR",
"company_name": null,
"turnover": null,
"activity_age": 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
}
Field reference
Below the list of fields and associated constraints:
language[locale] string |
Language NOTE: GET /api/locale |
subType ENUM |
a advised subtype of the merchant category of work's field Required : advised Note: if the type is 'INDIVIDUAL_WITH_STATUS' the subtypes available are : 'SOLE_TRADER', 'MERCHANT', 'ARTISAN' . if the type is 'LEGAL_ENTITY' the subtype available are : 'ASSOCIATION', 'PUBLIC', 'COMMERCIAL', 'EIG', 'CIVIL' . |
phone[value] string (15) |
Internationnal phone number NOTE: Min length: 10 |
mail[value] string (255) |
Merchant email |
iban[value] string |
IBAN number NOTE: Constraint: ISO 13616 |
bic[value] string |
BIC or SWIFT number
NOTE: Constraint: ISO 9362 |
firstname[value] string (255) |
Firstname |
lastname[value] string (255) |
Lastname |
company_name[value] string (255) |
Company name |
birthday[value] date |
Birthday NOTE: Constraint: - More than 18 years ago - Less than 110 years ago |
place_of_birth[value] string (255) |
Place of birth |
country_of_birth[country] string (3) |
Country of birth NOTE: Constraint: ISO 3166-1 alpha-3 |
nationality[value] string (3) |
Nationality
NOTE: Constraint: ISO 3166-1 alpha-3 |
company_creation_date[value] date |
Send mail after profile is completed
NOTE: Constraint: - Before today |
company_registration_number[value] string (20) |
Company registration number |
company_vat_number[value] string (14) |
Company VAT number NOTE: Constraints: - Min length: 2 |
company_legal_status[value] UUID (36) |
Company legal status UUID NOTE: GET /api/other/legal-status |
identity_document[type] ENUM |
Identity document type NOTE: PASSPORT/IDENTITY_CARD Valid and in color |
identity_document[documents] File[] |
List of identity document NOTE: - IDENTITY_CARD: 2 files - PASSPORT: 1 file |
company_legal_status_document[document] File |
Company legal status document Signed and certified compliant by the legal representative |
company_registration_number_document[document] File |
Company registration document Validity : less than 3 months old DEPRECATED |
iban_document[document] File |
Iban document |
address[nameLine1] string (255) |
Address name line 1 |
address[nameLine2] string (255) |
Address name line 2 |
address[nameLine3] string (255) |
Address name line 3 |
address[nameLine4] string (255) |
Address name line 4 |
address[locality] string (255) |
Address locality |
address[postalCode] string (20) |
Address postal code |
address[country] string (3) |
Country NOTE: Constraint: ISO 3166-1 alpha-3 |
contract_validation[centralpayProspection] bool |
Authorize centralpay prospection |
contract_validation[partnersProspection] bool |
Authorize partners prospection |
contract_validation[otp] string |
OTP value NOTE: POST /{merchantUuid}/activity/{uuid}/otp |
ubo_list[profileIsItem] bool |
If merchant is an item if UBO NOTE: Default false |
ubo_list[items] [] |
NOTE: the director list format to send is formated as '
ubo_list[items][*][place_of_birth][value] ' with * as the corresponding number of the ubo. It begin at 0. For the documents the correct format is : ubo_list[items][*][identity_document][documents][**][document] with * as the corresponding number of the ubo and ** as the corresponding number of the document. It begin at 0. |
representative_list[*][*uuid*][document][*] File |
Proof of identity (CNI or passport) Validity : less than 3 months old Recent extract from the Registry/Tax Office. (Avis de situation SIRENE) |
director_list[profileIsItem] bool |
If merchant is an item if directors NOTE: Default false |
director_list[items] [] |
List of identities of the directors NOTE: the director list format to send is formated as 'director_list[items][*][firstname][value]' with * as the corresponding number of the director. It begin at 0. |
point_of_sale_url[value] string (255) |
Point of sale url Constraints: URL |
complementary_identity_document[documents] [] |
Identity document, passport, driving licence, last notice of tax income, a wage slip, healthcare card |
question[response] | Type is given by extra_data_to_pass. Types: UNLOCK_PAYOUT_LIMITS. Choices are given also by extra_data_to_pass |
proof_of_address_document[document] File |
Proof of addess document Validity : less than 3 months old Utility bill (electricity, water or gas) ; Internet subscription invoice ; income tax notice ; insurance certificate. |
billing_descriptor[value] string (16) |
Billing descriptor |
article_signed[document] File |
Article signed Validity : less than 3 months old Up-to-date and signed Articles of Incorporation. |
proof_registration_artisant[document] File |
Proof registration artisan Validity : less than 3 months old Recent extract from the Registry /Tax Office. |
proof_registration_association[document] File |
Proof registration association Validity : less than 3 months old Association registration proofs. |
proof_registration_company[document] File |
Proof registration company Validity : less than 3 months old Recent extract from the Registry or Commerce. |
proof_registration_public[document] File |
Proof registration public Validity : less than 3 months old Public Entity registration proofs. |
proof_registration_sole_trader_first[document] File |
Proof registration sole-trader first Validity : less than 3 months old Recent extract from the Registry/Tax Office. (Avis de situation SIRENE) |
proof_registration_sole_trader_second[document] File |
Proof registration sole-trader second Validity : less than 3 months old Recent extract from the Registry/Tax Office. (Attestation de vigilance URSSAF) |
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollmentId}}/rollback
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollmentId}}/rollback/activity \
-u 'login:password' \
{
"workflow": null,
"identity_badge": null,
"representatives_list": null,
"uuid": "66152364-8d71-4ee5-b31f-d61da5e1d26c",
"risk_points": null,
"created_at": "2021-09-14T15:41:59+02:00",
"last_updated_at": "2021-09-14T15:42:15+02:00",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": null,
"type": "LEGAL_ENTITY",
"enrollment_account": null,
"profile": {
"uuid": "4e927a24-8204-4e54-825c-818654f448a2",
"workflow": {
"uuid": "af3c9763-0247-416c-9b9c-94741277e245",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "4455f8e3-74c1-4573-bed6-487a15b028b0",
"value": "Anon",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "badc8f8f-fc83-4985-b543-83b3068c7fd4",
"value": "test",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "70fe735b-af93-46b4-aed3-a0444b0a7e10",
"value": "gg605@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "f9383aab-e459-4c26-b028-d541c098b14d",
"value": "+33602287238",
"element-type": "phone"
}
],
"uuid": "54330e85-ea2e-4c16-bc78-3a3e88a30d16",
"name": "identityInfos",
"state": "ON_GOING",
"category": "identity",
"created_at": "2021-09-14T15:41:59+02:00"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "4455f8e3-74c1-4573-bed6-487a15b028b0",
"value": "theo yolo",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "badc8f8f-fc83-4985-b543-83b3068c7fd4",
"value": "test",
"element-type": "lastname"
},
"email": {
"status": "COMPLETED",
"uuid": "70fe735b-af93-46b4-aed3-a0444b0a7e10",
"value": "gg605@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "7fa71219-fbe0-479a-8908-7a7ddf6c00b6",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "f9383aab-e459-4c26-b028-d541c098b14d",
"value": "+336000000000",
"element-type": "phone"
},
"login": null,
"bo_user_uuid": null
},
"activity_sector": {
"name": "Spirituality & divination"
},
"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": "ASSOCIATION",
"api_infogreffe_attempt": 0
}
Rollback an enrollment
You can use this request to reset an enrollment. The enrollment will be reinitialized up to the profile, and th identity badge will be erased. You will need to re-join the identity badge after the rollback, or redo the request.
The only parameter available is the uuid of the enrollment to pass in the url.
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollmentId}}/rollback
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollmentId}}/rollback/activity \
-u 'login:password' \
{
"workflow": null,
"identity_badge": null,
"representatives_list": null,
"uuid": "66152364-8d71-4ee5-b31f-d61da5e1d26c",
"risk_points": null,
"created_at": "2021-09-14T15:41:59+02:00",
"last_updated_at": "2021-09-14T15:42:15+02:00",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": null,
"type": "LEGAL_ENTITY",
"enrollment_account": null,
"profile": {
"uuid": "4e927a24-8204-4e54-825c-818654f448a2",
"workflow": {
"uuid": "af3c9763-0247-416c-9b9c-94741277e245",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "4455f8e3-74c1-4573-bed6-487a15b028b0",
"value": "Anon",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "badc8f8f-fc83-4985-b543-83b3068c7fd4",
"value": "test",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "70fe735b-af93-46b4-aed3-a0444b0a7e10",
"value": "gg605@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "f9383aab-e459-4c26-b028-d541c098b14d",
"value": "+33602287238",
"element-type": "phone"
}
],
"uuid": "54330e85-ea2e-4c16-bc78-3a3e88a30d16",
"name": "identityInfos",
"state": "ON_GOING",
"category": "identity",
"created_at": "2021-09-14T15:41:59+02:00"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "4455f8e3-74c1-4573-bed6-487a15b028b0",
"value": "theo yolo",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "badc8f8f-fc83-4985-b543-83b3068c7fd4",
"value": "test",
"element-type": "lastname"
},
"email": {
"status": "COMPLETED",
"uuid": "70fe735b-af93-46b4-aed3-a0444b0a7e10",
"value": "gg605@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "7fa71219-fbe0-479a-8908-7a7ddf6c00b6",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "f9383aab-e459-4c26-b028-d541c098b14d",
"value": "+336000000000",
"element-type": "phone"
},
"login": null,
"bo_user_uuid": null
},
"activity_sector": {
"name": "Spirituality & divination"
},
"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": "ASSOCIATION",
"api_infogreffe_attempt": 0
}
Full API reference
Onboarding full API reference
GET https://test-onboarding-api.centralpay.net/api/merchant-enrollment/account-type
curl -vX GET \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/account-type \
-u 'login:password'
[
"STANDARD",
"BASIC"
]
Account type
This function allows you to get available account-type.
Depends of current account type
GET https://test-onboarding-api.centralpay.net/api/merchant-enrollment/account-type
curl -vX GET \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/account-type \
-u 'login:password'
[
"STANDARD",
"BASIC"
]
POST https://test-onboarding-api.centralpay.net/api/user/define/{uuid}
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/user/define/2aff09ff-1a55-4fff-aa5d-0430d26a3868 \
-u 'login:password' \
-F password=StrongPwd14$
Define password
This function allows you define enrollment user password.
uuid* UUID (36) |
Enrollment uuid |
POST https://test-onboarding-api.centralpay.net/api/user/define/{uuid}
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/user/define/2aff09ff-1a55-4fff-aa5d-0430d26a3868 \
-u 'login:password' \
-F password=StrongPwd14$
GET https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-age
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-age \
-u 'login:password'
[
{
"uuid": "6394b905-3851-45ef-97a7-42e0534a9127",
"name": "Less than a year"
},
{
"uuid": "7ed342d1-d187-4beb-80fe-bdf6158b83b9",
"name": "More than a year"
}
]
Get Activity Age
This function allows you to list activity age.
GET https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-age
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-age \
-u 'login:password'
[
{
"uuid": "6394b905-3851-45ef-97a7-42e0534a9127",
"name": "Less than a year"
},
{
"uuid": "7ed342d1-d187-4beb-80fe-bdf6158b83b9",
"name": "More than a year"
}
]
GET https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-sector
curl -v\
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-sector \
-u 'login:password'
[
{
"uuid": "5b0a52bd-9e24-4ce2-8522-1e0d32ed19ff",
"name": "Artisans (plumber, electricians, ...)"
},
{
"uuid": "29d2c962-5c7c-493a-bc0b-56c0b36697f7",
"name": "Bakery"
},
{
"uuid": "fa29d453-fd82-4aa0-8eb1-e4849626b14b",
"name": "Bar"
},
{
"uuid": "072c8fcb-67fb-4f30-bbfd-cd94426496be",
"name": "Car wash"
},
{
"uuid": "85ec7664-9b45-4311-a1f3-eda3f0814e77",
"name": "Clothing, shoes, jewelry"
},
{
"uuid": "95a55027-0dbd-444f-9224-186bbaeda5b9",
"name": "Computer & Telecomunication"
},
{
"uuid": "2bbc0ba4-f6b5-4f3e-93b5-b651ef8376d4",
"name": "Cultural and leisure activities"
},
{
"uuid": "6e5df10d-1963-492a-bc7a-61d50ba925e4",
"name": "Dating"
},
{
"uuid": "04ad39c0-b358-45d9-8170-c6786f01e93d",
"name": "Debt collection agencies"
},
{
"uuid": "6fcffdab-4ae8-4036-a363-f4c919dd3a69",
"name": "Electronic devices and computers"
},
{
"uuid": "6fbce0bd-7659-4d4e-bb66-d7aa1251c173",
"name": "Events & ticketing"
},
{
"uuid": "8d7aacd2-83e4-400e-bcfe-46bc8259d0a6",
"name": "Fashion & beauty"
},
{
"uuid": "86d8cba5-9e3a-4b88-85c0-aa0d8b488828",
"name": "Financial services"
},
{
"uuid": "e4b29330-b563-465d-9dcc-d7118fef8041",
"name": "Forex & crypto"
},
{
"uuid": "2d71086c-7118-493b-b932-91747cc3b350",
"name": "Garden, pets and tooling articles"
},
{
"uuid": "3dd46703-3dab-42fc-be86-26b14117442c",
"name": "Hotels & holiday rentals"
},
{
"uuid": "5b8c032e-22e0-473e-9722-d2d83cdc5dd3",
"name": "House and decoration"
},
{
"uuid": "9cad54e9-d572-4d91-9c68-2706f4255656",
"name": "House rental"
},
{
"uuid": "977d0b76-3710-4590-8081-a0c3a551520d",
"name": "Insurances"
},
{
"uuid": "af00e52f-62f6-428a-a182-9b06e25513ed",
"name": "Online Gaming"
},
{
"uuid": "3adc7370-174c-4351-a517-b2a8956c46ba",
"name": "Online entertainment"
},
{
"uuid": "6322b1b6-976e-45b3-b87d-d98e471e3f9c",
"name": "Pharmacy"
},
{
"uuid": "b31501bd-c343-48a5-88c0-873fb1c8bc41",
"name": "Public bodies & associations"
},
{
"uuid": "337e945d-f6cb-4f64-8eff-e748e18fbd14",
"name": "Restaurants"
},
{
"uuid": "55f6ac76-8629-41b7-a6d1-e8e056852287",
"name": "Sale of precious metals and jewelry"
},
{
"uuid": "93aa1d9f-b986-40a5-8de5-29b5293d9439",
"name": "Software download"
},
{
"uuid": "3a7dfc47-5ca9-4a11-bd18-7dc9a3dfceee",
"name": "Spare parts"
},
{
"uuid": "e5320717-78e1-4c63-b6ca-a67602b9f19d",
"name": "Spirituality & divination"
},
{
"uuid": "dfa6dda9-62ce-4c3a-822e-6c3b10cf5331",
"name": "Sport & Fitness"
},
{
"uuid": "bdf29fa3-1c27-4675-97f7-4831de196c68",
"name": "Supermarkets"
},
{
"uuid": "2db6af93-161a-43ee-898a-2c479b575c44",
"name": "Toys and products for children"
},
{
"uuid": "df7d7575-85d8-4d50-a830-f38c06cb4f3b",
"name": "Training & education"
},
{
"uuid": "91608ac1-1752-4597-b281-56f59541a9ce",
"name": "Travel agency services"
},
{
"uuid": "aa0098c6-92cd-405d-9360-e2931b02f0b9",
"name": "Wineries"
},
{
"uuid": "d6282c23-e727-454a-a077-30a212aaf46c",
"name": "health care"
}
]
Get Activity Sector
This function allows you to list activity sectors.
GET https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-sector
curl -v\
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-sector \
-u 'login:password'
[
{
"uuid": "5b0a52bd-9e24-4ce2-8522-1e0d32ed19ff",
"name": "Artisans (plumber, electricians, ...)"
},
{
"uuid": "29d2c962-5c7c-493a-bc0b-56c0b36697f7",
"name": "Bakery"
},
{
"uuid": "fa29d453-fd82-4aa0-8eb1-e4849626b14b",
"name": "Bar"
},
{
"uuid": "072c8fcb-67fb-4f30-bbfd-cd94426496be",
"name": "Car wash"
},
{
"uuid": "85ec7664-9b45-4311-a1f3-eda3f0814e77",
"name": "Clothing, shoes, jewelry"
},
{
"uuid": "95a55027-0dbd-444f-9224-186bbaeda5b9",
"name": "Computer & Telecomunication"
},
{
"uuid": "2bbc0ba4-f6b5-4f3e-93b5-b651ef8376d4",
"name": "Cultural and leisure activities"
},
{
"uuid": "6e5df10d-1963-492a-bc7a-61d50ba925e4",
"name": "Dating"
},
{
"uuid": "04ad39c0-b358-45d9-8170-c6786f01e93d",
"name": "Debt collection agencies"
},
{
"uuid": "6fcffdab-4ae8-4036-a363-f4c919dd3a69",
"name": "Electronic devices and computers"
},
{
"uuid": "6fbce0bd-7659-4d4e-bb66-d7aa1251c173",
"name": "Events & ticketing"
},
{
"uuid": "8d7aacd2-83e4-400e-bcfe-46bc8259d0a6",
"name": "Fashion & beauty"
},
{
"uuid": "86d8cba5-9e3a-4b88-85c0-aa0d8b488828",
"name": "Financial services"
},
{
"uuid": "e4b29330-b563-465d-9dcc-d7118fef8041",
"name": "Forex & crypto"
},
{
"uuid": "2d71086c-7118-493b-b932-91747cc3b350",
"name": "Garden, pets and tooling articles"
},
{
"uuid": "3dd46703-3dab-42fc-be86-26b14117442c",
"name": "Hotels & holiday rentals"
},
{
"uuid": "5b8c032e-22e0-473e-9722-d2d83cdc5dd3",
"name": "House and decoration"
},
{
"uuid": "9cad54e9-d572-4d91-9c68-2706f4255656",
"name": "House rental"
},
{
"uuid": "977d0b76-3710-4590-8081-a0c3a551520d",
"name": "Insurances"
},
{
"uuid": "af00e52f-62f6-428a-a182-9b06e25513ed",
"name": "Online Gaming"
},
{
"uuid": "3adc7370-174c-4351-a517-b2a8956c46ba",
"name": "Online entertainment"
},
{
"uuid": "6322b1b6-976e-45b3-b87d-d98e471e3f9c",
"name": "Pharmacy"
},
{
"uuid": "b31501bd-c343-48a5-88c0-873fb1c8bc41",
"name": "Public bodies & associations"
},
{
"uuid": "337e945d-f6cb-4f64-8eff-e748e18fbd14",
"name": "Restaurants"
},
{
"uuid": "55f6ac76-8629-41b7-a6d1-e8e056852287",
"name": "Sale of precious metals and jewelry"
},
{
"uuid": "93aa1d9f-b986-40a5-8de5-29b5293d9439",
"name": "Software download"
},
{
"uuid": "3a7dfc47-5ca9-4a11-bd18-7dc9a3dfceee",
"name": "Spare parts"
},
{
"uuid": "e5320717-78e1-4c63-b6ca-a67602b9f19d",
"name": "Spirituality & divination"
},
{
"uuid": "dfa6dda9-62ce-4c3a-822e-6c3b10cf5331",
"name": "Sport & Fitness"
},
{
"uuid": "bdf29fa3-1c27-4675-97f7-4831de196c68",
"name": "Supermarkets"
},
{
"uuid": "2db6af93-161a-43ee-898a-2c479b575c44",
"name": "Toys and products for children"
},
{
"uuid": "df7d7575-85d8-4d50-a830-f38c06cb4f3b",
"name": "Training & education"
},
{
"uuid": "91608ac1-1752-4597-b281-56f59541a9ce",
"name": "Travel agency services"
},
{
"uuid": "aa0098c6-92cd-405d-9360-e2931b02f0b9",
"name": "Wineries"
},
{
"uuid": "d6282c23-e727-454a-a077-30a212aaf46c",
"name": "health care"
}
]
GET https://test-onboarding-api.centralpay.net/api/merchant-enrollment/contract
curl -v \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/contract \
-u 'login:password'
[
{
"uuid": "a674d481-4805-4a66-915a-67956efca36f",
"name": "CONTRAT - MULTI CURRENCY"
}
]
Get contract
This function allows you to list available contract.
GET https://test-onboarding-api.centralpay.net/api/merchant-enrollment/contract
curl -v \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/contract \
-u 'login:password'
[
{
"uuid": "a674d481-4805-4a66-915a-67956efca36f",
"name": "CONTRAT - MULTI CURRENCY"
}
]
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/fee-schedule
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/fee-schedule \
-u 'login:password' \
-F accountType=BASIC
[
{
"uuid": "88a18398-3597-403c-80c2-2719210c3899",
"name": "Tarif base",
"language": "fre"
}
]
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/fee-schedule \
-u 'login:password' \
-F accountType=STANDARD
[
{
"uuid": "2437a015-4aa6-4ee4-b0dc-6a4026800e9a",
"name": "Grille CPAY RESELER - STANDARD",
"language": "fre"
}
]
Get fee schedule
This function allows you to list available fee-schedule.
accountType* string (255) |
Note: STANDARD, BASIC |
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/fee-schedule
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/fee-schedule \
-u 'login:password' \
-F accountType=BASIC
[
{
"uuid": "88a18398-3597-403c-80c2-2719210c3899",
"name": "Tarif base",
"language": "fre"
}
]
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/fee-schedule \
-u 'login:password' \
-F accountType=STANDARD
[
{
"uuid": "2437a015-4aa6-4ee4-b0dc-6a4026800e9a",
"name": "Grille CPAY RESELER - STANDARD",
"language": "fre"
}
]
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/cgu
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/cgu \
-u 'login:password' \
-F accountType=BASIC
[
{
"uuid": "2ebbbf47-b8eb-4922-93db-8bc252eb7717",
"name": "CGU user basic"
}
]
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/cgu \
-u 'login:password' \
-F accountType=STANDARD
[
{
"uuid": "b6a0d4e3-0fe4-4cec-a710-cd68cf1a92c4",
"name": "CGU - STANDARD - CPAY RES",
"language": "fre"
}
]
Get cgu
This function allows you to list available cgu.
accountType* string (255) |
Note: STANDARD, BASIC |
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/cgu
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/cgu \
-u 'login:password' \
-F accountType=BASIC
[
{
"uuid": "2ebbbf47-b8eb-4922-93db-8bc252eb7717",
"name": "CGU user basic"
}
]
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/cgu \
-u 'login:password' \
-F accountType=STANDARD
[
{
"uuid": "b6a0d4e3-0fe4-4cec-a710-cd68cf1a92c4",
"name": "CGU - STANDARD - CPAY RES",
"language": "fre"
}
]
GET https://test-onboarding-api.centralpay.net/api/other/legal-status
curl -v \
https://test-onboarding-api.centralpay.net/api/other/legal-status \
-u 'login:password'
[
{
"uuid": "3b2a4f61-727c-43bb-b5b6-4a9a5eb110a5",
"name": "Charity"
},
{
"uuid": "5f74eb9e-9ed7-42a8-bec3-49f7a3bc3364",
"name": "Individual company"
},
{
"uuid": "cdd0d510-5e21-438c-ab73-7cca45ae9e18",
"name": "Limited Partnership - LLP"
},
{
"uuid": "ed832409-24e4-4b64-bf15-be4901684670",
"name": "Limited company"
},
{
"uuid": "d0c93e6f-249a-402c-9521-3a73104c2d4c",
"name": "Listed company"
},
{
"uuid": "bf55ea5f-2408-40be-8c64-12a001bc70b7",
"name": "Non limited company"
},
{
"uuid": "ee1ce020-0877-47e3-9c52-64e2438d28e5",
"name": "Other legal entity"
},
{
"uuid": "f715a2cb-9fb7-4266-8d08-21824e7029fb",
"name": "Public organization"
}
]
Get legal status
This function allows you to list legal status.
GET https://test-onboarding-api.centralpay.net/api/other/legal-status
curl -v \
https://test-onboarding-api.centralpay.net/api/other/legal-status \
-u 'login:password'
[
{
"uuid": "3b2a4f61-727c-43bb-b5b6-4a9a5eb110a5",
"name": "Charity"
},
{
"uuid": "5f74eb9e-9ed7-42a8-bec3-49f7a3bc3364",
"name": "Individual company"
},
{
"uuid": "cdd0d510-5e21-438c-ab73-7cca45ae9e18",
"name": "Limited Partnership - LLP"
},
{
"uuid": "ed832409-24e4-4b64-bf15-be4901684670",
"name": "Limited company"
},
{
"uuid": "d0c93e6f-249a-402c-9521-3a73104c2d4c",
"name": "Listed company"
},
{
"uuid": "bf55ea5f-2408-40be-8c64-12a001bc70b7",
"name": "Non limited company"
},
{
"uuid": "ee1ce020-0877-47e3-9c52-64e2438d28e5",
"name": "Other legal entity"
},
{
"uuid": "f715a2cb-9fb7-4266-8d08-21824e7029fb",
"name": "Public organization"
}
]
GET https://test-onboarding-api.centralpay.net/api/locale
curl -v \
https://test-onboarding-api.centralpay.net/api/locale/ \
-u 'login:password
[
{
"identifier": "en",
"name": "English"
},
{
"identifier": "fr",
"name": "Français"
}
]
Get locale
This function return onboarding locale available.
GET https://test-onboarding-api.centralpay.net/api/locale
curl -v \
https://test-onboarding-api.centralpay.net/api/locale/ \
-u 'login:password
[
{
"identifier": "en",
"name": "English"
},
{
"identifier": "fr",
"name": "Français"
}
]
GET https://test-onboarding-api.centralpay.net/api/nauth/profile/{uuid}/activity
↵
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity \
-u 'login:password'
{
"type": "FORM",
"form": {
"children": {
"firstname": {
"extra_data_to_pass": {
"default": "John"
},
"children": {
"value": {}
}
}
}
},
"category": "contact"
}
Get profile workflow step
This function allows you show Enrollment workflow step details.
uuid* UUID (36) |
Enrollment uuid |
GET https://test-onboarding-api.centralpay.net/api/nauth/profile/{uuid}/activity
↵
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity \
-u 'login:password'
{
"type": "FORM",
"form": {
"children": {
"firstname": {
"extra_data_to_pass": {
"default": "John"
},
"children": {
"value": {}
}
}
}
},
"category": "contact"
}
POST https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/turnover
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/turnover \
-u 'login:password' \
-F type=LEGAL_ENTITY
[
{
"uuid": "8b1dc704-4419-4c47-a9ca-85a573ae0634",
"name": "Less than 200k EUR"
},
{
"uuid": "11645eda-7e17-49fa-8348-6eb0bbb85f90",
"name": "From 200k to 500k EUR"
},
{
"uuid": "e6642f7b-22ad-4601-b5d7-de309ec7cf5a",
"name": "More than 500k EUR"
}
]
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/turnover \
-u 'login:password' \
-F type=INDIVIDUAL_WITH_STATUS
[
{
"uuid": "d92cbe28-0236-43b6-a480-22c186f254ee",
"name": "Less than 30k EUR"
},
{
"uuid": "5067a011-a5ed-45c1-81a4-88d7d02751d2",
"name": "From 30k to 60k EUR"
},
{
"uuid": "3a3e2eb9-067d-4a22-a111-760828b449da",
"name": "More than 60k EUR"
}
]
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/turnover \
-u 'login:password' \
-F type=INDIVIDUAL
[
{
"uuid": "aed57921-81d8-4f22-8b13-b2f150503800",
"name": "Less than 20k EUR"
},
{
"uuid": "a0bb62bd-582d-48eb-a11f-e03087aa73cc",
"name": "More than 20k EUR"
}
]
Get turnover
This function allows you to list turnover.
type* enum |
Enrollment type Note: INDIVIDUAL | INDIVIDUAL_WITH_STATUS | LEGAL_ENTITY |
POST https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/turnover
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/turnover \
-u 'login:password' \
-F type=LEGAL_ENTITY
[
{
"uuid": "8b1dc704-4419-4c47-a9ca-85a573ae0634",
"name": "Less than 200k EUR"
},
{
"uuid": "11645eda-7e17-49fa-8348-6eb0bbb85f90",
"name": "From 200k to 500k EUR"
},
{
"uuid": "e6642f7b-22ad-4601-b5d7-de309ec7cf5a",
"name": "More than 500k EUR"
}
]
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/turnover \
-u 'login:password' \
-F type=INDIVIDUAL_WITH_STATUS
[
{
"uuid": "d92cbe28-0236-43b6-a480-22c186f254ee",
"name": "Less than 30k EUR"
},
{
"uuid": "5067a011-a5ed-45c1-81a4-88d7d02751d2",
"name": "From 30k to 60k EUR"
},
{
"uuid": "3a3e2eb9-067d-4a22-a111-760828b449da",
"name": "More than 60k EUR"
}
]
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/turnover \
-u 'login:password' \
-F type=INDIVIDUAL
[
{
"uuid": "aed57921-81d8-4f22-8b13-b2f150503800",
"name": "Less than 20k EUR"
},
{
"uuid": "a0bb62bd-582d-48eb-a11f-e03087aa73cc",
"name": "More than 20k EUR"
}
]
GET https://test-onboarding-api.centralpay.net/api/workflow/
curl -v \
https://test-onboarding-api.centralpay.net/api/workflow/ \
-u 'login:password'
{
"uuid": "296a9536-a82f-42cd-b807-d41af904bc8a",
"name": "Individuel avec statut élevé",
"description": "Individuel avec statut élevé",
"max_risk": 15,
"type": "PARTICULAR",
"mode": "CONTINUAL",
"is_siren_mandatory": false
},
{
"uuid": "621ab607-3d1a-44c8-8c1b-b76edaa95454",
"name": "Individuel",
"description": "Individuel",
"max_risk": 15,
"type": "PARTICULAR_WITHOUT_STATUS",
"mode": "SEQUENTIAL",
"is_siren_mandatory": false
},
Get workflow
This function allows you to list workflows.
GET https://test-onboarding-api.centralpay.net/api/workflow/
curl -v \
https://test-onboarding-api.centralpay.net/api/workflow/ \
-u 'login:password'
{
"uuid": "296a9536-a82f-42cd-b807-d41af904bc8a",
"name": "Individuel avec statut élevé",
"description": "Individuel avec statut élevé",
"max_risk": 15,
"type": "PARTICULAR",
"mode": "CONTINUAL",
"is_siren_mandatory": false
},
{
"uuid": "621ab607-3d1a-44c8-8c1b-b76edaa95454",
"name": "Individuel",
"description": "Individuel",
"max_risk": 15,
"type": "PARTICULAR_WITHOUT_STATUS",
"mode": "SEQUENTIAL",
"is_siren_mandatory": false
},
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{enrollmentUuid}/activity/{activityUuid}/otp
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/edc30900-87be-4ff3-8416-0f936a54baee/otp
-u 'login:password'
Send OTP
This function allows you to send OTP code in order to validate contract.
enrollmentUuid* UUID (36) |
Enrollment uuid |
activityUuid* UUID (36) |
Activity uuid |
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{enrollmentUuid}/activity/{activityUuid}/otp
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/edc30900-87be-4ff3-8416-0f936a54baee/otp
-u 'login:password'
PATCH https://test-onboarding-api.centralpay.net/api/nauth/profile/{uuid}
curl -vX PATCH \
https://test-onboarding-api.centralpay.net/api/nauth/profile/eac67996-d309-471f-865b-e65f068ce0ac\
-H 'Content-Type: application/x-www-form-urlencoded' \
-u 'login:password' \
--data-urlencode email[value]=john.doe@gmail.com \
--data-urlencode phone[value]='+336******06' \
Update profile
This function allows you to update a profile.
firstname[value] string (255) |
Merchant firstname |
lastname[value] string (255) |
Merchant lastname |
email[value] String (255) |
Merchant email |
phone[value] String |
Merchant International phone number Note: |
language[locale] String |
Merchant mail language Note: GET /api/locale |
Note: With PATCH method you must use the « MIME » type: "application/x-www-form-urlencoded". You need to use an header with the adequate Content-Type, and the '--data-urlencode' to correctly change the phone number (cf cURL).
PATCH https://test-onboarding-api.centralpay.net/api/nauth/profile/{uuid}
curl -vX PATCH \
https://test-onboarding-api.centralpay.net/api/nauth/profile/eac67996-d309-471f-865b-e65f068ce0ac\
-H 'Content-Type: application/x-www-form-urlencoded' \
-u 'login:password' \
--data-urlencode email[value]=john.doe@gmail.com \
--data-urlencode phone[value]='+336******06' \
POST https://test-onboarding-api.centralpay.net/api/user/password/request-reset
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/user/password/request-reset
-u 'login:password'
-F email=john.doe@gmail.com
[
"token": "K0TY-Q2X77D2yVCY_1JjLVdkUb7c5CvniPgY6VrVp6o"
]
Request reset password
This function allows you to request password reset.
email* string |
Email of enrollment |
POST https://test-onboarding-api.centralpay.net/api/user/password/request-reset
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/user/password/request-reset
-u 'login:password'
-F email=john.doe@gmail.com
[
"token": "K0TY-Q2X77D2yVCY_1JjLVdkUb7c5CvniPgY6VrVp6o"
]
POST https://test-onboarding-api.centralpay.net//api/user/password/reset/token/{token}
curl -v -X POST \
https://test-onboarding-api.centralpay.net//api/user/password/reset/token/K0TY-Q2X77D2yVCY_1JjLVdkUb7c5CvniPgY6VrVp6o \
-u 'login:password' \
-F 'password=Password1$' \
-F client_ip=172.3.149.25 \
-F 'client_user_agent=Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0'
Reset password
This function allows you to reset password.
password* string |
Enrollment uuid |
client_ip* | |
client_user_agent* |
POST https://test-onboarding-api.centralpay.net//api/user/password/reset/token/{token}
curl -v -X POST \
https://test-onboarding-api.centralpay.net//api/user/password/reset/token/K0TY-Q2X77D2yVCY_1JjLVdkUb7c5CvniPgY6VrVp6o \
-u 'login:password' \
-F 'password=Password1$' \
-F client_ip=172.3.149.25 \
-F 'client_user_agent=Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0'
GET https://test-onboarding-api.centralpay.net/api/legal-entity/subtypes
{
"INDIVIDUAL_WITH_STATUS": [
"SOLE_TRADER",
"MERCHANT",
"ARTISAN"
],
"LEGAL_ENTITY": [
"ASSOCIATION",
"PUBLIC",
"COMMERCIAL",
"EIG",
"CIVIL"
],
"INDIVIDUAL": [
"INDIVIDUAL"
]
}
Get subtypes
This function allows you to list activity subtypes.
GET https://test-onboarding-api.centralpay.net/api/legal-entity/subtypes
{
"INDIVIDUAL_WITH_STATUS": [
"SOLE_TRADER",
"MERCHANT",
"ARTISAN"
],
"LEGAL_ENTITY": [
"ASSOCIATION",
"PUBLIC",
"COMMERCIAL",
"EIG",
"CIVIL"
],
"INDIVIDUAL": [
"INDIVIDUAL"
]
}
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollementId}}/workflow/reset
curl -vX POST https://https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollementId}}/workflow/reset \
-u 'login:password'
Reset data of a Workflow
This function allows you to reset the data of your workflow.
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollementId}}/workflow/reset
curl -vX POST https://https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{{enrollementId}}/workflow/reset \
-u 'login:password'
GET https://test-onboarding-api.centralpay.net/api/merchant-enrollment/hook
curl -v \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/hook \
-u 'login:password'
{"uuid":"af2f8f83-ab80-4ca3-9ffd-14cb05d80ece","name":"test webhook"}
Retrieve a hook
This function allows you to retrieve the list of the hooks configurated for your account.
GET https://test-onboarding-api.centralpay.net/api/merchant-enrollment/hook
curl -v \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/hook \
-u 'login:password'
{"uuid":"af2f8f83-ab80-4ca3-9ffd-14cb05d80ece","name":"test webhook"}
Transfer
Transfer objects allow you to transfer money from your wallet to another wallet.
POST https://test-api.centralpay.net/v2/rest/transfer
OBJ Json transfer type
curl -v https://test-api.centralpay.net/v2/rest/transfer \
-u 'doctest:4I9HJRTd' \
-d merchantTransferId='test doc' \
-d destinationWalletId=10cfe034-ba9a-457e-b13d-fc68a5bfd171 \
-d currency=EUR \
-d amount=1 \
-d transferGroup='transferGroup000000' \
-d additionalData=[transfer]transfer \
-d description='Création transfer' \
-d escrowDate=2035-12-23
{
"transferId": "24a53d19-8259-419d-8f16-6081d64e4412",
"creationDate": "2020-08-18T12:08:54.409696+02:00",
"merchantTransferId": "test doc",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"transferGroup": "transferGroup000000",
"description": "Création transfer",
"status": "PENDING",
"transferReversals": [],
"reversed": false,
"escrowDate": "2035-12-23",
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId": null,
"movementId": "a81c1ac2-a67b-4b2b-ba8d-b907319356f7",
"cancelMovementId": null,
"cancellationDate": null,
"additionalData": {
"transfer": "transfer"
}
}
Create a transfer
This function allows you to create a transfer. Allowed for RESELLERS
destinationWalletId Wallet |
Identifier of the Destination wallet Required : yes Validation: UUID Wallet of one of his sub-merchants |
currency Currency |
Currency Required : yes Validation: ISO4217 alpha format or num [A-Z]{3}|[0-9]{3} Existing for the transfer initiator Merchant 's walletIf sourceId is present, the object linked to this source must be have this currency |
amount Integer |
Amount of the transfer Required : yesValidation: Strictly superior to 0 and lower or equal to 9999999 If sourceType is not set, the amount must be lower or equals to the available amount of the wallet of this currency Note: In cents
|
merchantTransferId String |
Identifier of the Merchant Required : no Validation : .{0,100} |
fee Integer |
Currency Required : noValidation: Between 0 and the amount's transferFee will be deducted from the amountby Default 0 |
escrowDate Date |
Escrow date Required : no If sourceType is not set, tomorrow or laterIf sourceType equal to "TRANSACTION", the escrowDate must be equal to or greater than the transaction capture date plus 2 days If sourceType equal to "CREDIT", now +1d or later |
sourceId String (36) |
Identifier of the transfer source Required : yes if sourceType is set Validation: Authorized for merchantIf sourceType equal to "TRANSACTION", the status of the transaction must be CLEARED or CAPTURED If sourceType equal to "WIRE_TRANSFER", the status of the wireTransfer must be PENDING or RECEIVED If sourceType equal to "CREDIT", the credit status must be CLEARED |
sourceType String |
ENUM Required : yes (if the HTTP parameter sourceId is set) Values : TRANSACTION | WIRE_TRANSFER | CREDIT |
transferGroup String |
Identifier of the transfer group Required : noValidation : .{0,100} |
description String (256) |
Description Required : no Validation: .{0,256} |
additionalData String (256) |
Merchant data Required: no Sample: additionalData=[Key]Value Note: Number of key/value pairs as it can take multiple keys and values. |
POST https://test-api.centralpay.net/v2/rest/transfer
OBJ Json transfer type
curl -v https://test-api.centralpay.net/v2/rest/transfer \
-u 'doctest:4I9HJRTd' \
-d merchantTransferId='test doc' \
-d destinationWalletId=10cfe034-ba9a-457e-b13d-fc68a5bfd171 \
-d currency=EUR \
-d amount=1 \
-d transferGroup='transferGroup000000' \
-d additionalData=[transfer]transfer \
-d description='Création transfer' \
-d escrowDate=2035-12-23
{
"transferId": "24a53d19-8259-419d-8f16-6081d64e4412",
"creationDate": "2020-08-18T12:08:54.409696+02:00",
"merchantTransferId": "test doc",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"transferGroup": "transferGroup000000",
"description": "Création transfer",
"status": "PENDING",
"transferReversals": [],
"reversed": false,
"escrowDate": "2035-12-23",
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId": null,
"movementId": "a81c1ac2-a67b-4b2b-ba8d-b907319356f7",
"cancelMovementId": null,
"cancellationDate": null,
"additionalData": {
"transfer": "transfer"
}
}
POST https://test-api.centralpay.net/v2/rest/transfer/<transferId>
OBJ Json Transfer type
curl -v https://test-api.centralpay.net/v2/rest/transfer/24a53d19-8259-419d-8f16-6081d64e4412 \
-u 'doctest:4I9HJRTd' \
-d additionalData=[transfer]transferTest
{
"transferId": "24a53d19-8259-419d-8f16-6081d64e4412",
"creationDate": "2020-08-18T12:08:54.409696+02:00",
"merchantTransferId": "test doc",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"transferGroup": "transferGroup000000",
"description": "Création transfer",
"status": "PENDING",
"transferReversals": [],
"reversed": false,
"escrowDate": "2035-12-23",
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId": null,
"movementId": "a81c1ac2-a67b-4b2b-ba8d-b907319356f7",
"cancelMovementId": null,
"cancellationDate": null,
"additionalData": {
"transfer": "transferTest"
}
}
Update a Transfer
This function allows you to update a transfer. Allowed for RESELLERS
transferId String (36) |
Transfer ID Required: yes Validation: UUID - Existing - Authorised for the user |
merchantTransferId String (100) |
Merchant transfer ID
Required: no |
escrowDate String |
Escrow date
Required: no Note: ISO 8601 Validation:If sourceType is not set, tomorrow or later If sourceType equal to "TRANSACTION", the escrowDate must be equal to or greater than the transaction capture date + 2 days |
transferGroup String |
Identifier of the transfer group
Required: no |
description String (256) |
Description Required: no Validation: .{0,256} |
additionalData String (303) |
Merchant data
Required: no
Note: Number of key/value combinations because can take multiple keys and values. |
POST https://test-api.centralpay.net/v2/rest/transfer/<transferId>
OBJ Json Transfer type
curl -v https://test-api.centralpay.net/v2/rest/transfer/24a53d19-8259-419d-8f16-6081d64e4412 \
-u 'doctest:4I9HJRTd' \
-d additionalData=[transfer]transferTest
{
"transferId": "24a53d19-8259-419d-8f16-6081d64e4412",
"creationDate": "2020-08-18T12:08:54.409696+02:00",
"merchantTransferId": "test doc",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"transferGroup": "transferGroup000000",
"description": "Création transfer",
"status": "PENDING",
"transferReversals": [],
"reversed": false,
"escrowDate": "2035-12-23",
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId": null,
"movementId": "a81c1ac2-a67b-4b2b-ba8d-b907319356f7",
"cancelMovementId": null,
"cancellationDate": null,
"additionalData": {
"transfer": "transferTest"
}
}
POST https://test-api.centralpay.net/v2/rest/transfer/<transferId>/cancel
OBJ Json Transfer type
curl -vX POST https://test-api.centralpay.net/v2/rest/transfer/24a53d19-8259-419d-8f16-6081d64e4412/cancel \
-H 'Content-Type:application/x-www-form-urlencoded' \
-u 'doctest:4I9HJRTd'
{
"transferId": "24a53d19-8259-419d-8f16-6081d64e4412",
"creationDate": "2020-08-18T12:08:54.409696+02:00",
"merchantTransferId": "test doc",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"transferGroup": "transferGroup000000",
"description": "Création transfer",
"status": "CANCEL",
"transferReversals": [],
"reversed": false,
"escrowDate": "2035-12-23",
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId": null,
"movementId": "a81c1ac2-a67b-4b2b-ba8d-b907319356f7",
"cancelMovementId": "6aec7f6b-df88-4c0d-b450-8f9179a15dc5",
"cancellationDate": "2020-08-18T12:22:40.971718+02:00",
"additionalData": {
"transfer": "transferTest"
}
}
Cancel a Transfer
This function allows you to cancel a transfer with the transfer ID. Allowed for RESELLERS.
This function is available while the funds are "Pending". If the funds are "Available" this function will not be available. You'll have to use "transferReversal" instead.
Note that the destination account will see the transfer create and the transfer cancel in his Wallet.
transferId (URL) UUID (36) |
CentralPay ID of the Transfer
Required: yes Validation: Existing UUID belong to the merchant |
POST https://test-api.centralpay.net/v2/rest/transfer/<transferId>/cancel
OBJ Json Transfer type
curl -vX POST https://test-api.centralpay.net/v2/rest/transfer/24a53d19-8259-419d-8f16-6081d64e4412/cancel \
-H 'Content-Type:application/x-www-form-urlencoded' \
-u 'doctest:4I9HJRTd'
{
"transferId": "24a53d19-8259-419d-8f16-6081d64e4412",
"creationDate": "2020-08-18T12:08:54.409696+02:00",
"merchantTransferId": "test doc",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"transferGroup": "transferGroup000000",
"description": "Création transfer",
"status": "CANCEL",
"transferReversals": [],
"reversed": false,
"escrowDate": "2035-12-23",
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId": null,
"movementId": "a81c1ac2-a67b-4b2b-ba8d-b907319356f7",
"cancelMovementId": "6aec7f6b-df88-4c0d-b450-8f9179a15dc5",
"cancellationDate": "2020-08-18T12:22:40.971718+02:00",
"additionalData": {
"transfer": "transferTest"
}
}
GET https://test-api.centralpay.net/v2/rest/transfer/<transferId>
OBJ Json Transfer type
curl -v https://test-api.centralpay.net/v2/rest/transfer/43626afd-e8c5-4c42-a130-d40cdf97df2b \
-u 'doctest:4I9HJRTd'
{
"transferId": "43626afd-e8c5-4c42-a130-d40cdf97df2b",
"creationDate": "2018-08-03T17:34:27.317+02:00",
"merchantTransferId": "test doc",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"transferGroup": "transferGroup000000",
"description": "Création transfer",
"status": "CANCEL",
"transferReversals": [],
"reversed": false,
"escrowDate": "2019-05-23",
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId": null,
"movementId": "c0a867d9-65b3-4131-b38b-efb0b37bb0ac",
"cancelMovementId": "9f9071ad-ad57-41ff-ba4f-01eb85926942",
"cancellationDate": "2018-08-03T17:44:38.885+02:00",
"additionalData": {
"transfer": "transfer"
}
}
Retrieve a Transfer
This function allows you to retrieve a transfer with the transfert ID. Allowed for RESELLERS.
transferId (URL) transferId |
CentralPay ID of the Transfer Required: yes Validation: Existing UUID belonging to the merchant |
GET https://test-api.centralpay.net/v2/rest/transfer/<transferId>
OBJ Json Transfer type
curl -v https://test-api.centralpay.net/v2/rest/transfer/43626afd-e8c5-4c42-a130-d40cdf97df2b \
-u 'doctest:4I9HJRTd'
{
"transferId": "43626afd-e8c5-4c42-a130-d40cdf97df2b",
"creationDate": "2018-08-03T17:34:27.317+02:00",
"merchantTransferId": "test doc",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"transferGroup": "transferGroup000000",
"description": "Création transfer",
"status": "CANCEL",
"transferReversals": [],
"reversed": false,
"escrowDate": "2019-05-23",
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId": null,
"movementId": "c0a867d9-65b3-4131-b38b-efb0b37bb0ac",
"cancelMovementId": "9f9071ad-ad57-41ff-ba4f-01eb85926942",
"cancellationDate": "2018-08-03T17:44:38.885+02:00",
"additionalData": {
"transfer": "transfer"
}
}
GET https://test-api.centralpay.net/v2/rest/transfer
List OBJ Json transfer type
curl -X GET -v https://test-api.centralpay.net/v2/rest/transfer?status=PENDING \
-u 'doctest:4I9HJRTd'
{
"list": [
{
"transferId": "0141e32b-5184-4ebe-a0db-16d1a8c5b255",
"creationDate": "2020-08-13T17:22:17.185943+02:00",
"merchantTransferId": null,
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"sourceType": "TRANSACTION",
"transferGroup": null,
"description": null,
"status": "PENDING",
"transferReversals": [],
"reversed": false,
"escrowDate": "2025-10-01",
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId": "fa8b7bdb-adc0-4ffa-8aa7-9ad2faeca070",
"movementId": "d596f3c4-aea9-4323-95e8-ca5c719b9db4",
"cancelMovementId": null,
"cancellationDate": null,
"additionalData": {}
},
{
"transferId": "9288a4a3-41e8-4f21-905b-9f860aaaf7ad",
"creationDate": "2020-08-13T14:24:16.117376+02:00",
"merchantTransferId": null,
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"sourceType": "TRANSACTION",
"transferGroup": null,
"description": null,
"status": "PENDING",
"transferReversals": [],
"reversed": false,
"escrowDate": "2025-10-01",
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId": "6e2f2345-fe2a-4fee-9a72-9bc3b54dad26",
"movementId": "3aeb4001-2be2-4c43-ab26-0fb12a5846c9",
"cancelMovementId": null,
"cancellationDate": null,
"additionalData": {}
}
],
"totalCount": 6
}
List Transfer
This function allows you to search objects from a multi-criteria search. Allowed for RESELLERS. All the paramers used to search must be passed in the form of queries parameters.
« Transfer » specific parameters
merchantTransferId String (100) |
Merchant transfert ID Required: no |
destinationWalletID UUID (36) |
Destination Wallet ID
Required: no
Validation: must be a wallet of a sub-merchant |
transferGroup String (100) |
Transfer groupRequired: no |
status Enum TransferStatus |
Transfer status Required: no Validation: PENDING | TRANSFERRED | CANCEL |
GET https://test-api.centralpay.net/v2/rest/transfer
List OBJ Json transfer type
curl -X GET -v https://test-api.centralpay.net/v2/rest/transfer?status=PENDING \
-u 'doctest:4I9HJRTd'
{
"list": [
{
"transferId": "0141e32b-5184-4ebe-a0db-16d1a8c5b255",
"creationDate": "2020-08-13T17:22:17.185943+02:00",
"merchantTransferId": null,
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"sourceType": "TRANSACTION",
"transferGroup": null,
"description": null,
"status": "PENDING",
"transferReversals": [],
"reversed": false,
"escrowDate": "2025-10-01",
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId": "fa8b7bdb-adc0-4ffa-8aa7-9ad2faeca070",
"movementId": "d596f3c4-aea9-4323-95e8-ca5c719b9db4",
"cancelMovementId": null,
"cancellationDate": null,
"additionalData": {}
},
{
"transferId": "9288a4a3-41e8-4f21-905b-9f860aaaf7ad",
"creationDate": "2020-08-13T14:24:16.117376+02:00",
"merchantTransferId": null,
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"sourceType": "TRANSACTION",
"transferGroup": null,
"description": null,
"status": "PENDING",
"transferReversals": [],
"reversed": false,
"escrowDate": "2025-10-01",
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId": "6e2f2345-fe2a-4fee-9a72-9bc3b54dad26",
"movementId": "3aeb4001-2be2-4c43-ab26-0fb12a5846c9",
"cancelMovementId": null,
"cancellationDate": null,
"additionalData": {}
}
],
"totalCount": 6
}
Transfer object
The Json "Transfer" Object
The "Transfer" object response represents an electronic transfert from wallet to wallet.
transferId String(36) |
Tranfer ID Note: UUID Format |
merchantTransferId String (100) |
CentralPay's merchant transfer ID Note: Merchant internal reference for tracability purposes |
creationDate String |
Creation date Note: ISO 8601 |
description String |
Description |
currency String |
Currency Note: Favourite format |
amount Integer |
Amount Note: in cents |
fee Integer |
Fee Note: in cents |
net Integer |
Net amount Note: in cents |
escrowDate String |
Escrow date Note: ISO 8601 |
destinationWalletId String(36) |
Destinaiton Wallet ID Note: UUID Format |
sourceId String(36) |
Source ID Note: UNCAPTURED | CAPTURED | CLEARED | CANCELED |
sourceType Enum TransferSourceType |
Source typeAmount debitedNote: TRANSACTION | WIRE_TRANSFER | CREDIT |
transferGroup String |
Transfer group |
status EnumTransferStatus |
Status Note: PENDING | TRANSFERRED | CANCEL |
cancellationDate String |
Concellation date Note: ISO 8601 |
transferReversals List<TransferReversal> |
Transfer reversals |
reversed Boolean |
Reversed |
movementId String |
Movement IDNote: UUID Format |
cancelMovementId String |
Cancel Movement IDNote: UUID Format |
additionalData Object |
Merchant data Note: Contains keys/values |
TransferReversal
The Json "TransferReversal" Object
POST https://test-api.centralpay.net/v2/rest/transferReversal
OBJ Json transferReversal type
curl -v https://test-api.centralpay.net/v2/rest/transferReversal \
-u 'doctest:4I9HJRTd' \
-d transferId=9e146823-9cfc-4bd7-b595-b10c5ced2ab8 \
-d merchantTransferReversalId='test' \
-d amount=1
{
"transferReversalId": "e8b02763-ebf6-4968-8f81-1c9de99cef43",
"creationDate": "2020-08-19T10:24:09.934778+02:00",
"transferId": "f0f517d5-a2c3-451c-8b1f-62b6d93d38d4",
"merchantTransferReversalId": null,
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"refundFee": true,
"description": null,
"status": "TRANSFERRED",
"movementId": "7e21084e-0a53-4e73-961f-a22ede7e6fe7",
"escrowDate": null,
"additionalData": {}
}
Create a transferReversal
This function allows you to create a transferReversal
transferId String |
Identifier of the transfer Required : yes Validation : UUID Format Transfer status must be TRANSFERRED |
merchantTransferReversalId Wallet |
Identifier of the merchant Required : no Validation : .{0,100} |
amount Integer |
Amount to reverse
Required: yes Must bo lower or equal to transfer destination wallet available plus transfer destination wallet pending of this currency Note: In cents |
refundFee Boolean |
Indicates whether the transfer fee is refunded Required : noBy Default true |
Fee Integer |
Fee Required : noBy Default 0 Validation: Strictly superior to 0 and lower or equal to 9999999Note: In cents
|
description String (256) |
Description Required : no Validation: .{0,256} |
escrowDate String |
Escrow date Required : noNote: ISO 8601 |
additionalData String (256) |
Merchant data Required: no Sample: additionalData=[Key]Value Note : max 25 |
POST https://test-api.centralpay.net/v2/rest/transferReversal
OBJ Json transferReversal type
curl -v https://test-api.centralpay.net/v2/rest/transferReversal \
-u 'doctest:4I9HJRTd' \
-d transferId=9e146823-9cfc-4bd7-b595-b10c5ced2ab8 \
-d merchantTransferReversalId='test' \
-d amount=1
{
"transferReversalId": "e8b02763-ebf6-4968-8f81-1c9de99cef43",
"creationDate": "2020-08-19T10:24:09.934778+02:00",
"transferId": "f0f517d5-a2c3-451c-8b1f-62b6d93d38d4",
"merchantTransferReversalId": null,
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"refundFee": true,
"description": null,
"status": "TRANSFERRED",
"movementId": "7e21084e-0a53-4e73-961f-a22ede7e6fe7",
"escrowDate": null,
"additionalData": {}
}
POST https://test-api.centralpay.net/v2/rest/transferReversal/<transferReversalId>
OBJ Json TransferReversal type
curl -v https://test-api.centralpay.net/v2/rest/transferReversal/e1140714-b59f-44f3-910d-2195ac61a106 \
-u 'doctest:4I9HJRTd' \
-d description=Description_Updated_1
{
"transferReversalId":"e1140714-b59f-44f3-910d-2195ac61a106",
"creationDate":"2018-08-17T09:07:45.045+02:00",
"merchantTransferReversalId":"test",
"currency":"EUR",
"amount":1,
"refundFee":true,
"description":"Description_Updated_1",
"transferId":"9e146823-9cfc-4bd7-b595-b10c5ced2ab8",
"movementId":"e19c0b74-abe0-4acd-8bc1-141387f055f8",
"additionalData":{}}
Update a TransferReversal
This service allows you to update a transferReversal. Allowed for the PARTNER level or more
transferReversalId String (36) |
TransferReversal ID Required: yes Validation: UUID - Existing - Authorised for the user |
merchantTransferReversalId String (100) |
Merchant transfer reversal ID
Required: no |
description String (256) |
Description Required: no Validation: .{0,256} |
additionalData String (256) |
Merchant data
Required: no
Note: Number of key/value combinations because can take multiple keys and values. |
POST https://test-api.centralpay.net/v2/rest/transferReversal/<transferReversalId>
OBJ Json TransferReversal type
curl -v https://test-api.centralpay.net/v2/rest/transferReversal/e1140714-b59f-44f3-910d-2195ac61a106 \
-u 'doctest:4I9HJRTd' \
-d description=Description_Updated_1
{
"transferReversalId":"e1140714-b59f-44f3-910d-2195ac61a106",
"creationDate":"2018-08-17T09:07:45.045+02:00",
"merchantTransferReversalId":"test",
"currency":"EUR",
"amount":1,
"refundFee":true,
"description":"Description_Updated_1",
"transferId":"9e146823-9cfc-4bd7-b595-b10c5ced2ab8",
"movementId":"e19c0b74-abe0-4acd-8bc1-141387f055f8",
"additionalData":{}}
GET https://test-api.centralpay.net/v2/rest/transferReversal/<transferReversalId>
OBJ Json TransferReversal type
curl -v https://test-api.centralpay.net/v2/rest/transferReversal/e1140714-b59f-44f3-910d-2195ac61a106 \
-u 'doctest:4I9HJRTd'
{
"transferReversalId":"e1140714-b59f-44f3-910d-2195ac61a106",
"creationDate":"2018-08-17T09:07:45.045+02:00",
"merchantTransferReversalId":"test",
"currency":"EUR",
"amount":1,
"refundFee":true,
"description":null,
"transferId":"9e146823-9cfc-4bd7-b595-b10c5ced2ab8",
"movementId":"e19c0b74-abe0-4acd-8bc1-141387f055f8",
"additionalData":{}}
Retrieve a transferReversal
This function allows you to retrieve a transferReversal object. Allowed for the PARTNER level or more
transferReversalId (URL) transferReversalId |
CentralPay identifier of the transfer reversal Required: yes Validation: UUID Format Existing UUID belonging to the merchant |
GET https://test-api.centralpay.net/v2/rest/transferReversal/<transferReversalId>
OBJ Json TransferReversal type
curl -v https://test-api.centralpay.net/v2/rest/transferReversal/e1140714-b59f-44f3-910d-2195ac61a106 \
-u 'doctest:4I9HJRTd'
{
"transferReversalId":"e1140714-b59f-44f3-910d-2195ac61a106",
"creationDate":"2018-08-17T09:07:45.045+02:00",
"merchantTransferReversalId":"test",
"currency":"EUR",
"amount":1,
"refundFee":true,
"description":null,
"transferId":"9e146823-9cfc-4bd7-b595-b10c5ced2ab8",
"movementId":"e19c0b74-abe0-4acd-8bc1-141387f055f8",
"additionalData":{}}
GET https://test-api.centralpay.net/v2/rest/transferReversal
List OBJ Json transferReversal type
curl -X GET -v https://test-api.centralpay.net/v2/rest/transferReversal?merchantTransferReversalId=test \
-u 'doctest:4I9HJRTd'
{
"list":[{"transferReversalId":"e1140714-b59f-44f3-910d-2195ac61a106",
"creationDate":"2018-08-17T09:07:45.045+02:00",
"merchantTransferReversalId":"test",
"currency":"EUR",
"amount":1,
"refundFee":true,
"description":null,
"transferId":"9e146823-9cfc-4bd7-b595-b10c5ced2ab8",
"movementId":"e19c0b74-abe0-4acd-8bc1-141387f055f8",
"additionalData":{}}],
"totalCount":1}
List transferReversal
This function allows you to search trasnferReversal objects from a one-criteria search. All the paramers used to search must be passed in the form of queries parameters.
Allowed for the PARTNER level or more
merchantTransferReversalId String (100) |
Identifier of the merchant Required: noValidation : .{0,100} |
GET https://test-api.centralpay.net/v2/rest/transferReversal
List OBJ Json transferReversal type
curl -X GET -v https://test-api.centralpay.net/v2/rest/transferReversal?merchantTransferReversalId=test \
-u 'doctest:4I9HJRTd'
{
"list":[{"transferReversalId":"e1140714-b59f-44f3-910d-2195ac61a106",
"creationDate":"2018-08-17T09:07:45.045+02:00",
"merchantTransferReversalId":"test",
"currency":"EUR",
"amount":1,
"refundFee":true,
"description":null,
"transferId":"9e146823-9cfc-4bd7-b595-b10c5ced2ab8",
"movementId":"e19c0b74-abe0-4acd-8bc1-141387f055f8",
"additionalData":{}}],
"totalCount":1}
TransferReversal Object
The "TransferReversal" object response represents an electronic transfert reversal from wallet to wallet.
transferReversalId String(36) |
Identifier of the transferReversal Note: UUID Format |
creationDate String |
Creation date |
merchantTransferReversalId String (100) |
Identifier of the CentralPay's merchant transferReversal |
currency String |
Currency of the transferReversal Note: Favourite format |
amount Integer |
Total amount of the transferReversal Note: in cents |
refundFee Boolean |
Refund fee amount of the transfer |
description String |
Description |
transferId String(36) |
Identifier of the transfer Note: UUID Format |
movementId String(36) |
Identifier of the movement Note: UUID Format |
additionalData Object |
Merchant data Note: Contains keys/values |
Fee Integer |
Fee of the transferReversal |
Net Integer |
Net amount of the transferReversal |
escrowDate String |
Escrow date Note: ISO 8601 |
status EnumTransferStatus |
Status Note: PENDING | TRANSFERRED |
Payout
A "Payout" is moving money from Centralpay to the merchant's bank account for a specific currency.
curl -v https://test-api.centralpay.net/v2/rest/payout \
-u 'doctest:4I9HJRTd' \
-d merchantPayoutId='test doctest REF-API' \
-d currency=EUR \
-d amount=1 \
-d description='payout service creation'
{
"payoutId": "3c3f64ec-0848-4b54-a327-63896454aea0",
"creationDate": "2020-08-19T10:04:55.176936+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": null,
"expectedArrivalDate": "2020-08-21",
"arrivalDate": null,
"merchantPayoutId": "test fmi",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"description": "payout service creation",
"status": "PENDING",
"automatic": false,
"payoutReference": "PAYOUT-20200819100455",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "c29c7cc4-2d8e-45e2-9a04-69bc023635f4",
"cancelMovementId": null,
"additionalData": {}
}
Create a payout
This service allows you to create a payout.
Allowed for the STANDARD level or more
Note: The create payout service can be called once a day, by merchant by currency .
amount Integer |
Amount of the payout Required : yesValidation: Strictly superior to 0 and lower or equal to 9999999The amount must not exceed the available amount in the wallet for the currency setted.Note: In cents |
currency Currency |
Currency Required : yes Validation: ISO4217 alpha format or num [A-Z}{3}|[0-9]{3} Existing for Merchant 's wallet. |
merchantPayoutId String |
Identifier of the Merchant Required : no Min length : 0Max length : 100 |
destinationBankAccountId BankAccount |
Destination bank account identifier of the merchant Required : noAuthorized by the merchantThe currency of the destination bank account must be equal to currency settedIf you dont set this HTTP parameter, the default value will be the default bank account of currency settedNote: UUID Format |
description String |
Description Required : noMin length : 0Max length : 256 |
payoutReference String |
Payout reference Required : no Min length : 1Max length : 35 If you dont set this HTTP parameter, the default value will be equal to PAYOUT-currentTimeMillis Validation: [a-zA-Z0-9 /-?:().,'+]{1,30} |
additionalData String (256) |
Merchant data Required: no Sample: additionalData=[Key]Value Note: Number of key/value pairs as it can take multiple keys and values. |
curl -v https://test-api.centralpay.net/v2/rest/payout \
-u 'doctest:4I9HJRTd' \
-d merchantPayoutId='test doctest REF-API' \
-d currency=EUR \
-d amount=1 \
-d description='payout service creation'
{
"payoutId": "3c3f64ec-0848-4b54-a327-63896454aea0",
"creationDate": "2020-08-19T10:04:55.176936+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": null,
"expectedArrivalDate": "2020-08-21",
"arrivalDate": null,
"merchantPayoutId": "test fmi",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"description": "payout service creation",
"status": "PENDING",
"automatic": false,
"payoutReference": "PAYOUT-20200819100455",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "c29c7cc4-2d8e-45e2-9a04-69bc023635f4",
"cancelMovementId": null,
"additionalData": {}
}
curl -v https://test-api.centralpay.net/v2/rest/payout/2351c9fd-d09c-4bfb-a190-f87b2a458214 \
-u 'doctest:4I9HJRTd' \
-d merchantPayoutId=Up_test_fmi
{
"payoutId": "3c3f64ec-0848-4b54-a327-63896454aea0",
"creationDate": "2020-08-19T10:04:55.176936+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": null,
"expectedArrivalDate": "2020-08-21",
"arrivalDate": null,
"merchantPayoutId": "Up_test_fmi",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"description": "payout service creation",
"status": "PENDING",
"automatic": false,
"payoutReference": "PAYOUT-20200819100455",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "c29c7cc4-2d8e-45e2-9a04-69bc023635f4",
"cancelMovementId": null,
"additionalData": {}
}
Update a payout
This function allows you to update a payout. Allowed for the STANDARD level or more
payoutId String (36) |
Payout ID Required: yes Validation: UUID - Existing - Authorised for the user |
merchantPayoutId String (100) |
Merchant payout ID
Required: no |
description String (256) |
Description Required: no Validation: .{0,256} |
additionalData String (256) |
Merchant data
Required: no
Note: Number of key/value combinations because can take multiple keys and values. |
curl -v https://test-api.centralpay.net/v2/rest/payout/2351c9fd-d09c-4bfb-a190-f87b2a458214 \
-u 'doctest:4I9HJRTd' \
-d merchantPayoutId=Up_test_fmi
{
"payoutId": "3c3f64ec-0848-4b54-a327-63896454aea0",
"creationDate": "2020-08-19T10:04:55.176936+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": null,
"expectedArrivalDate": "2020-08-21",
"arrivalDate": null,
"merchantPayoutId": "Up_test_fmi",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"description": "payout service creation",
"status": "PENDING",
"automatic": false,
"payoutReference": "PAYOUT-20200819100455",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "c29c7cc4-2d8e-45e2-9a04-69bc023635f4",
"cancelMovementId": null,
"additionalData": {}
}
curl -vX POST https://test-api.centralpay.net/v2/rest/payout/3c3f64ec-0848-4b54-a327-63896454aea0/cancel \
-H 'Content-Type:application/x-www-form-urlencoded' \
-u 'doctest:4I9HJRTd'
{
"payoutId": "3c3f64ec-0848-4b54-a327-63896454aea0",
"creationDate": "2020-08-19T10:04:55.176936+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": "2020-08-19T10:13:19.981583+02:00",
"expectedArrivalDate": "2020-08-21",
"arrivalDate": null,
"merchantPayoutId": "Up_test_fmi",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"description": "payout service creation",
"status": "CANCEL",
"automatic": false,
"payoutReference": "PAYOUT-20200819100455",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "c29c7cc4-2d8e-45e2-9a04-69bc023635f4",
"cancelMovementId": "c8d43be4-8aaa-4ec8-b764-b838f75bee54",
"additionalData": {}
}
Cancel a payout
This service allows you to cancel a payout with the payout ID. Allowed for the STANDARD level or more
payoutId (URL) UUID (36) |
CentralPay ID of the Payout
Required: yes Validation: Existing UUID belong to the merchant |
curl -vX POST https://test-api.centralpay.net/v2/rest/payout/3c3f64ec-0848-4b54-a327-63896454aea0/cancel \
-H 'Content-Type:application/x-www-form-urlencoded' \
-u 'doctest:4I9HJRTd'
{
"payoutId": "3c3f64ec-0848-4b54-a327-63896454aea0",
"creationDate": "2020-08-19T10:04:55.176936+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": "2020-08-19T10:13:19.981583+02:00",
"expectedArrivalDate": "2020-08-21",
"arrivalDate": null,
"merchantPayoutId": "Up_test_fmi",
"currency": "EUR",
"amount": 1,
"fee": 0,
"net": 1,
"description": "payout service creation",
"status": "CANCEL",
"automatic": false,
"payoutReference": "PAYOUT-20200819100455",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "c29c7cc4-2d8e-45e2-9a04-69bc023635f4",
"cancelMovementId": "c8d43be4-8aaa-4ec8-b764-b838f75bee54",
"additionalData": {}
}
curl -v https://test-api.centralpay.net/v2/rest/payout/2351c9fd-d09c-4bfb-a190-f87b2a458214 \
-u 'doctest:4I9HJRTd'
{
"payoutId": "2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate": "2018-08-03T17:58:07.681+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": "2018-08-03T18:01:33.027+02:00",
"expectedArrivalDate": "2018-08-08",
"arrivalDate": null,
"merchantPayoutId": "Up_test_fmi",
"currency": "EUR",
"amount": 1,
"fee": null,
"net": null,
"description": "payout service creation",
"status": "CANCEL",
"automatic": false,
"payoutReference": "PAYOUT-1533311887663",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"cancelMovementId": "cbfff894-be8b-4e90-8a43-9a62ad481859",
"additionalData": {}
}
Retrieve a payout
This service allows you to retrieve a payout with the payout ID. Allowed for the STANDARD level or more
payoutId UUID (36) |
CentralPay ID of the payout Required: yes Validation: UUID |
curl -v https://test-api.centralpay.net/v2/rest/payout/2351c9fd-d09c-4bfb-a190-f87b2a458214 \
-u 'doctest:4I9HJRTd'
{
"payoutId": "2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate": "2018-08-03T17:58:07.681+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": "2018-08-03T18:01:33.027+02:00",
"expectedArrivalDate": "2018-08-08",
"arrivalDate": null,
"merchantPayoutId": "Up_test_fmi",
"currency": "EUR",
"amount": 1,
"fee": null,
"net": null,
"description": "payout service creation",
"status": "CANCEL",
"automatic": false,
"payoutReference": "PAYOUT-1533311887663",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"cancelMovementId": "cbfff894-be8b-4e90-8a43-9a62ad481859",
"additionalData": {}
}
GET https://test-api.centralpay.net/v2/rest/payout
List OBJ Json payout type
curl -X GET -v https://test-api.centralpay.net/v2/rest/payout?merchantPayoutId=Up_test_fmi \
-u 'doctest:4I9HJRTd'
{
"list": [
{
"payoutId": "2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate": "2018-08-03T17:58:07.681+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": "2018-08-03T18:01:33.027+02:00",
"expectedArrivalDate": "2018-08-08",
"arrivalDate": null,
"merchantPayoutId": "Up_test_fmi",
"currency": "EUR",
"amount": 1,
"fee": null,
"net": null,
"description": "payout service creation",
"status": "CANCEL",
"automatic": false,
"payoutReference": "PAYOUT-1533311887663",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"cancelMovementId": "cbfff894-be8b-4e90-8a43-9a62ad481859",
"additionalData": {}
}
],
"totalCount": 1
}
List payouts
This service allows you to search objects from a multi-criteria search. Allowed for the STANDARD level or more
« Payout » specific parameters
merchantPayoutId String (100) |
Merchant payout ID Required: no |
destinationBankAccountID UUID (36) |
Destination Bank Account IDRequired: no Validation: Authorized to the merchant |
expectedArrivalDate localeDate |
Expected arrival dateRequired: no |
arrivalDate localeDate |
Arrival dateRequired: no |
status Enum PayoutStatus |
Payout status Required: no Validation: PENDING | TRANSFER_ORDER_SENT | PAID | FAILED | CANCEL |
GET https://test-api.centralpay.net/v2/rest/payout
List OBJ Json payout type
curl -X GET -v https://test-api.centralpay.net/v2/rest/payout?merchantPayoutId=Up_test_fmi \
-u 'doctest:4I9HJRTd'
{
"list": [
{
"payoutId": "2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate": "2018-08-03T17:58:07.681+02:00",
"destinationBankAccountId": "cb40425a-8e61-4486-b88f-c568fd45d057",
"cancellationDate": "2018-08-03T18:01:33.027+02:00",
"expectedArrivalDate": "2018-08-08",
"arrivalDate": null,
"merchantPayoutId": "Up_test_fmi",
"currency": "EUR",
"amount": 1,
"fee": null,
"net": null,
"description": "payout service creation",
"status": "CANCEL",
"automatic": false,
"payoutReference": "PAYOUT-1533311887663",
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"movementId": "f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"cancelMovementId": "cbfff894-be8b-4e90-8a43-9a62ad481859",
"additionalData": {}
}
],
"totalCount": 1
}
Payout Object
The Json "Payout" Object
The "Payout" object response represents a payout.
Note: UUID Format
payoutId String (36) |
Payout identifier Note: UUID Format |
|
creationDate OffsetDateTime |
Creation date | |
merchantPayoutId String |
Merchant payout identifier | |
amount Integer |
Amount | |
currency String |
Currency Preferred format |
|
destinationBankAccountId String(36) |
Destination bank account identifier of the merchant Note: UUID Format |
|
description String |
Description | |
status String |
Payout status Possible values: PENDING , PAID , CANCEL. |
|
cancellationDate OffsetDateTime |
Cancellation date |
|
automatic String |
The payout is automatic or not Possible values: TRUE, FALSE |
|
expectedArrivalDate LocalDate |
Expected arrival date |
|
arrivalDate LocalDate |
Arrival date | |
payoutReference String |
The reference of the payout |
|
movementId String(36) |
Movement identifier Note: UUID Format |
|
cancelMovementId String(36) |
Cancel movement identifier Note: UUID Format |
|
additionalData[*] Map |
Merchant data |
Payout by a Marketplace
A "Payout by a Market place" is moving money from Centralpay wallet to the sub-merchant's bank account for a specific currency.
POST https://test-api.centralpay.net/v2/rest/payout/byMarketplace
OBJ Json payout type
curl --location --request POST 'https://test-api.centralpay.net/v2/rest/payout/byMarketplace' \
-u 'doctest:4I9HJRTd' \
-d 'amount=30' \
-d 'currency=EUR' \
-d 'destinationBankAccountId=55a05b4c-d85f-46f8-aa50-2af2a2f1345a'
{
"payoutId": "5cefe8bd-a7c7-4313-a535-64978940f6e0",
"creationDate": "2020-11-17T12:13:52.522452+01:00",
"destinationBankAccountId": "55a05b4c-d85f-46f8-aa50-2af2a2f1345a",
"cancellationDate": null,
"expectedArrivalDate": "2020-11-19",
"arrivalDate": null,
"merchantPayoutId": null,
"currency": "EUR",
"amount": 30,
"fee": 0,
"net": 30,
"description": null,
"status": "PENDING",
"automatic": true,
"payoutReference": "PAYOUT-20201117121352",
"walletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"movementId": "e46be558-3a65-42a7-a0fb-823d542f54ed",
"cancelMovementId": null,
"additionalData": {}
}
Create Payout by a Market place
Note: The create payout service can be called once a day, by sub-merchant by currency .
amount Integer |
Amount of the payout Required : yesValidation: Strictly superior to 0 and lower or equal to 9999999The amount must not exceed the available amount in the wallet for the currency setted.Note: In cents |
currency Currency |
Currency Required : yes Validation: ISO4217 alpha format or num [A-Z}{3}|[0-9]{3} Existing for Merchant 's wallet. |
destinationBankAccountId BankAccount |
Destination bank account identifier of the sub-merchant Required : yesAuthorized by the merchantThe currency of the destination bank account must be equal to currency settedNote: UUID Format |
merchantPayoutId String |
Identifier of the Merchant Required : no Min length : 0Max length : 100 |
description String |
Description Required : noMin length : 0Max length : 256 |
payoutReference String |
Payout reference Required : no Min length : 1Max length : 35 If you dont set this HTTP parameter, the default value will be equal to PAYOUT-currentTimeMillis Validation: [a-zA-Z0-9 /-?:().,'+]{1,30} |
additionalData String (256) |
Merchant data Required: no Sample: additionalData=[Key]Value Note: Number of key/value pairs as it can take multiple keys and values. |
POST https://test-api.centralpay.net/v2/rest/payout/byMarketplace
OBJ Json payout type
curl --location --request POST 'https://test-api.centralpay.net/v2/rest/payout/byMarketplace' \
-u 'doctest:4I9HJRTd' \
-d 'amount=30' \
-d 'currency=EUR' \
-d 'destinationBankAccountId=55a05b4c-d85f-46f8-aa50-2af2a2f1345a'
{
"payoutId": "5cefe8bd-a7c7-4313-a535-64978940f6e0",
"creationDate": "2020-11-17T12:13:52.522452+01:00",
"destinationBankAccountId": "55a05b4c-d85f-46f8-aa50-2af2a2f1345a",
"cancellationDate": null,
"expectedArrivalDate": "2020-11-19",
"arrivalDate": null,
"merchantPayoutId": null,
"currency": "EUR",
"amount": 30,
"fee": 0,
"net": 30,
"description": null,
"status": "PENDING",
"automatic": true,
"payoutReference": "PAYOUT-20201117121352",
"walletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"movementId": "e46be558-3a65-42a7-a0fb-823d542f54ed",
"cancelMovementId": null,
"additionalData": {}
}
GET https://test-api.centralpay.net/v2/rest/payout/byMarketplace/<payoutId>
OBJ Json payout type
curl --location --request GET 'https://test-api.centralpay.net/v2/rest/payout/byMarketplace/f2e49ccd-a3e7-4bd1-828d-ade53eaba9f3' \
-u 'doctest:4I9HJRTd'
{
"payoutId": "f2e49ccd-a3e7-4bd1-828d-ade53eaba9f3",
"creationDate": "2020-10-28T10:21:20.591693+01:00",
"destinationBankAccountId": "55a05b4c-d85f-46f8-aa50-2af2a2f1345a",
"cancellationDate": null,
"expectedArrivalDate": "2020-10-30",
"arrivalDate": null,
"merchantPayoutId": null,
"currency": "EUR",
"amount": 30,
"fee": 0,
"net": 30,
"description": null,
"status": "PAID",
"automatic": true,
"payoutReference": "PAYOUT-20201028102120547",
"walletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"movementId": "03e627fc-3932-4b10-9b1d-33d1b6f77c82",
"cancelMovementId": null,
"additionalData": {}
}
Retrieve a Payout by a Market Place
This service allows you to retrieve a payout with the WalletID. Allowed for the STANDARD, PLATEFORM level or more
payoutId UUID (36) |
Identifier of the payout Required: yes Validation: UUID |
GET https://test-api.centralpay.net/v2/rest/payout/byMarketplace/<payoutId>
OBJ Json payout type
curl --location --request GET 'https://test-api.centralpay.net/v2/rest/payout/byMarketplace/f2e49ccd-a3e7-4bd1-828d-ade53eaba9f3' \
-u 'doctest:4I9HJRTd'
{
"payoutId": "f2e49ccd-a3e7-4bd1-828d-ade53eaba9f3",
"creationDate": "2020-10-28T10:21:20.591693+01:00",
"destinationBankAccountId": "55a05b4c-d85f-46f8-aa50-2af2a2f1345a",
"cancellationDate": null,
"expectedArrivalDate": "2020-10-30",
"arrivalDate": null,
"merchantPayoutId": null,
"currency": "EUR",
"amount": 30,
"fee": 0,
"net": 30,
"description": null,
"status": "PAID",
"automatic": true,
"payoutReference": "PAYOUT-20201028102120547",
"walletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"movementId": "03e627fc-3932-4b10-9b1d-33d1b6f77c82",
"cancelMovementId": null,
"additionalData": {}
}
GET https://test-api.centralpay.net/v2/rest/payout/byMarketplace?walletId={{UUID}}
List OBJ Json payout type
curl --location --request GET 'https://test-api.centralpay.net/v2/rest/payout/byMarketplace?walletId=10cfe034-ba9a-457e-b13d-fc68a5bfd171' \
-u 'doctest:4I9HJRTd'
{
"list": [
{
"payoutId": "f2e49ccd-a3e7-4bd1-828d-ade53eaba9f3",
"creationDate": "2020-10-28T10:21:20.591693+01:00",
"destinationBankAccountId": "55a05b4c-d85f-46f8-aa50-2af2a2f1345a",
"cancellationDate": null,
"expectedArrivalDate": "2020-10-30",
"arrivalDate": null,
"merchantPayoutId": null,
"currency": "EUR",
"amount": 30,
"fee": 0,
"net": 30,
"description": null,
"status": "PAID",
"automatic": true,
"payoutReference": "PAYOUT-20201028102120547",
"walletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"movementId": "03e627fc-3932-4b10-9b1d-33d1b6f77c82",
"cancelMovementId": null,
"additionalData": {}
}
],
"totalCount": 1
}
List Payouts by MarketPlace
This service allows you to search objects from a multi-criteria search. Allowed for the STANDARD level or more
« Payout » specific parameters
walletId UUID |
Wallet of the marketplace Required: yes |
GET https://test-api.centralpay.net/v2/rest/payout/byMarketplace?walletId={{UUID}}
List OBJ Json payout type
curl --location --request GET 'https://test-api.centralpay.net/v2/rest/payout/byMarketplace?walletId=10cfe034-ba9a-457e-b13d-fc68a5bfd171' \
-u 'doctest:4I9HJRTd'
{
"list": [
{
"payoutId": "f2e49ccd-a3e7-4bd1-828d-ade53eaba9f3",
"creationDate": "2020-10-28T10:21:20.591693+01:00",
"destinationBankAccountId": "55a05b4c-d85f-46f8-aa50-2af2a2f1345a",
"cancellationDate": null,
"expectedArrivalDate": "2020-10-30",
"arrivalDate": null,
"merchantPayoutId": null,
"currency": "EUR",
"amount": 30,
"fee": 0,
"net": 30,
"description": null,
"status": "PAID",
"automatic": true,
"payoutReference": "PAYOUT-20201028102120547",
"walletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"movementId": "03e627fc-3932-4b10-9b1d-33d1b6f77c82",
"cancelMovementId": null,
"additionalData": {}
}
],
"totalCount": 1
}
Payout by Market place Object
The Json "Payout by Marketplace" Object
The "Payout by Marketplace" object response represents a payout created by a Marketplace for a .
Note: UUID Format
payoutId String (36) |
Payout identifier Note: UUID Format |
|
creationDate OffsetDateTime |
Creation date | |
merchantPayoutId String |
Merchant payout identifier | |
amount Integer |
Amount | |
currency String |
Currency Preferred format |
|
destinationBankAccountId String(36) |
Destination bank account identifier of the sub-merchant Note: UUID Format |
|
description String |
Description | |
status String |
Payout status Possible values: PENDING , PAID , CANCEL. |
|
cancellationDate OffsetDateTime |
Cancellation date |
|
automatic String |
The payout is automatic or not Possible values: TRUE, FALSE |
|
expectedArrivalDate LocalDate |
Expected arrival date |
|
arrivalDate LocalDate |
Arrival date | |
payoutReference String |
The reference of the payout |
|
movementId String(36) |
Movement identifier Note: UUID Format |
|
cancelMovementId String(36) |
Cancel movement identifier Note: UUID Format |
|
additionalData[*] Map |
Merchant data |