Plateform
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": {}
}
Wallet
The wallet endpoint is used to create an electronic money account to store digital values.
The Wallet is always attached to a "Customer". It can be used without KYC under strict limitations (less than 150 €).
To use a verify account and remove limitation, you must use the API Onboarding.
curl -v POST 'https://test-api.centralpay.net/v2/rest/wallets' \
-u 'doctest:4I9HJRTd' \
-d 'currency=GTH' \
-d 'reference=njzeh' \
-d 'expirationDate=2024-01-05' \
-d 'activationDate=2023-05-10' \
-d 'customerId=7f75ae7b-9bd8-42ca-ae30-4c9ee2932250'
{
"walletId": "eb69cf8d-5458-4eab-af86-a3f2b957b40e",
"available": [],
"pending": [],
"currency": "GTH",
"reference": "njzeh",
"expirationDate": "2024-01-05",
"activationDate": "2023-05-10"
}
WALLET - Create a wallet
This service allows you to create a wallet.
customerId string |
Identifier of a CentralPay Customer Required: yes (customerId or merchantId) Validation: UUID |
merchantId string |
Identifier of a CentralPay Merchant Required: yes (customerId or merchantId) Validation: UUID |
currency string(3) |
Internal currency of the wallet Required: yes |
reference string |
reference of the wallet Required: not |
expirationDate date |
expiration date of the wallet Required: no |
activationDate date |
activation date of the wallet Required: no |
additionalData object |
Additional data associated with the object Required: no |
curl -v POST 'https://test-api.centralpay.net/v2/rest/wallets' \
-u 'doctest:4I9HJRTd' \
-d 'currency=GTH' \
-d 'reference=njzeh' \
-d 'expirationDate=2024-01-05' \
-d 'activationDate=2023-05-10' \
-d 'customerId=7f75ae7b-9bd8-42ca-ae30-4c9ee2932250'
{
"walletId": "eb69cf8d-5458-4eab-af86-a3f2b957b40e",
"available": [],
"pending": [],
"currency": "GTH",
"reference": "njzeh",
"expirationDate": "2024-01-05",
"activationDate": "2023-05-10"
}
curl -v POST 'https://test-api.centralpay.net/v2/rest/wallets/9b7f18d8-734f-4c72-8792-aea2ecdbdbaa' \
-u 'doctest:4I9HJRTd' \
-d 'reference=ref-api' \
-d 'expirationDate=2026-01-05' \
-d 'activationDate=2021-05-10'
{
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"available": [
{
"amount": 2999000,
"minimumAmount": 3000000,
"currency": "EUR"
}
],
"pending": [
{
"amount": 35498846,
"minimumAmount": null,
"currency": "EUR"
}
],
"currency": null,
"reference": "ref-api",
"expirationDate": "2026-01-05",
"activationDate": "2021-05-10"
}
WALLET - Update a wallet
This service allows you to update a wallet.
walletId string(uuid) |
identifier of the wallet
Required: yes Validation : UUID |
reference string |
Reference of the wallet Required: no |
expirationDate date |
Expiration date Required: no |
activationDate date |
Activation date Required: no |
additionalData object |
Additional data associated with the object Required: no |
merchantId UUID |
Identifier of the merchant to link with the wallet Required: no |
curl -v POST 'https://test-api.centralpay.net/v2/rest/wallets/9b7f18d8-734f-4c72-8792-aea2ecdbdbaa' \
-u 'doctest:4I9HJRTd' \
-d 'reference=ref-api' \
-d 'expirationDate=2026-01-05' \
-d 'activationDate=2021-05-10'
{
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"available": [
{
"amount": 2999000,
"minimumAmount": 3000000,
"currency": "EUR"
}
],
"pending": [
{
"amount": 35498846,
"minimumAmount": null,
"currency": "EUR"
}
],
"currency": null,
"reference": "ref-api",
"expirationDate": "2026-01-05",
"activationDate": "2021-05-10"
}
curl -v https://test-api.centralpay.net/v2/rest/wallets/9b7f18d8-734f-4c72-8792-aea2ecdbdbaa \
-u 'doctest:4I9HJRTd'
{
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"available": [
{
"amount": 2999000,
"minimumAmount": 3000000,
"currency": "EUR"
}
],
"pending": [
{
"amount": 35498846,
"minimumAmount": null,
"currency": "EUR"
}
],
"currency": null,
"reference": "jhdiorhi",
"expirationDate": "2023-01-05",
"activationDate": "2022-05-10"
}
WALLET - Retrieve a wallet
This service allows you to retrieve a wallet with the wallet ID. All the paramers used to search must be passed in the form of queries parameters.
walletId UUID (36) |
CentralPay ID of the wallet Required: yes Validation: UUID Wallet of the connected merchant or wallet of one of his sub-merchants By default, the wallet of the connected merchant |
curl -v https://test-api.centralpay.net/v2/rest/wallets/9b7f18d8-734f-4c72-8792-aea2ecdbdbaa \
-u 'doctest:4I9HJRTd'
{
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"available": [
{
"amount": 2999000,
"minimumAmount": 3000000,
"currency": "EUR"
}
],
"pending": [
{
"amount": 35498846,
"minimumAmount": null,
"currency": "EUR"
}
],
"currency": null,
"reference": "jhdiorhi",
"expirationDate": "2023-01-05",
"activationDate": "2022-05-10"
}
curl -v GET https://test-api.centralpay.net/v2/rest/wallets \
-u 'doctest:4I9HJRTd'
{
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"available": [
{
"amount": 2999000,
"minimumAmount": 3000000,
"currency": "EUR"
}
],
"pending": [
{
"amount": 35498846,
"minimumAmount": null,
"currency": "EUR"
}
],
"currency": null,
"reference": "jhdiorhi",
"expirationDate": "2023-01-05",
"activationDate": "2022-05-10"
}
WALLET - Get all wallets
This service allows you to create a wallet.
customerID string |
Identifier of the customer
Required: yes Validation: UUID
|
currency string |
currency of the wallet Required: yes |
after String |
Only returns items created after specified date time Example : 2020-08-31T07:13:22.639Z Required: no |
before String |
Only returns items created before specified date time Example : 2020-08-31T07:13:22.639Z Required: no |
limit String |
Number of items to return Default value : 10 Required: no |
page String |
Page index to get Default value : 1 Required: no |
curl -v GET https://test-api.centralpay.net/v2/rest/wallets \
-u 'doctest:4I9HJRTd'
{
"walletId": "9b7f18d8-734f-4c72-8792-aea2ecdbdbaa",
"available": [
{
"amount": 2999000,
"minimumAmount": 3000000,
"currency": "EUR"
}
],
"pending": [
{
"amount": 35498846,
"minimumAmount": null,
"currency": "EUR"
}
],
"currency": null,
"reference": "jhdiorhi",
"expirationDate": "2023-01-05",
"activationDate": "2022-05-10"
}
WALLET - Object
The Json "Wallet" Object
The "Wallet" object response represents a wallet situation at the moment
available List<WalletItem> |
Wallet available amounts |
currency String |
Currency Note: Favourite format |
amount Integer |
Amount Note: in cents |
pending List<WalletItem> |
Wallet pending amounts Note: |
currency String |
Currency Note: Favourite format |
amount Integer |
Amount Note: in cents |
Onboarding (Payment Services)
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
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.
This function allows you to create a new merchant enrollment.
profile[firstname][value]* string (255) |
Merchant firstname Since 1.15.0 Required : yes Validation : alpha characters and "-" character |
profile[lastname][value]* string (255) |
Merchant lastname Since 1.15.0 Required : yes Validation : alpha characters and "-" character |
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 |
birthdayConfirmation[value] date |
Note: This parameter is required if the merchant is already affiliate with an agent. Date of birth Format : YYYY-mm-dd Optionnal : yes if the merchant is already affiliate with an agent. |
payoutProfile UUID (36) |
Required : noNote: POST /api/merchant-enrollment/payout-profile |
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
}
Complete an enrollement
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": "97d6d67d-bcac-4396-82dd-1d3aa3361df9",
"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
In order to complete the profil, we need to get the value [workflow][status] to "ACCEPTED", for now the status is : "ON_GOING".
As long as it is not done, steps to fill out will be submitted to unlock the next step.
To get the first step, we use the enrollementID and retrieve our first activity UUID ("97d6d67d-bcac-4396-82dd-1d3aa3361df9" in this example)
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": "97d6d67d-bcac-4396-82dd-1d3aa3361df9",
"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"
}
Retrieve profile fields to complete
In order to know the fields you will need to complete for the first step of the profile, you must 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.
{
"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'
Complete profile fields
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.
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"
}
Checking workflow status
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.
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"
}
List of activities profile workflow
List of the activities needed to complete the profil.
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 |
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.
Format :
/api/merchant-enrollment/{merchantUuid}/activity/{uuid}
/api/merchant-enrollment/{uuid}/complete
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 Bank Informations
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_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 '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 '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 https://{{OBD_URI}}/api/merchant-enrollment/{{enrollmentId}}/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"
}
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/{{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"
}
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"
}
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 '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"
}
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
}
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/search
curl --location 'https://test-onboarding-api.centralpay.net/api/merchant-enrollment/search' \\
--header 'Content-Type: application/x-www-form-urlencoded' \\
--header 'Authorization: Basic yours'
--data-urlencode 'email=testcustomer@gmail.com'
{
"0": {
"uuid": "0626d028-b7cc-4b0d-8c55-7c11566faa75",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:37:33",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quatrefdiiftioydfn@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"1": {
"uuid": "2dd27998-f5aa-45fc-8331-988c56497063",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:38:34",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": "LOW",
"workflowName": "E_WALLET YMO",
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": "ON_GOING",
"name": "Cormier",
"firstname": "Myah",
"email": "enid51@hotmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"2": {
"uuid": "34abec10-334c-4331-bc95-7db32cb41191",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:36:15",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quatrediitioydn@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"3": {
"uuid": "427fd364-8a20-4aeb-a8e8-d7010f6afcae",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:37:12",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quatrefdiitioydfn@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"4": {
"uuid": "693a0158-20e2-4e86-88fb-a8f7b70ddc37",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:35:31",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quatrediitioyn@gmail.com",
"activitySector": "Software download",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"5": {
"uuid": "700925d9-8c56-4266-9eda-6d1000ca4bbb",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-05T16:15:36",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": "LOW",
"workflowName": "E_WALLET YMO",
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": "ON_GOING",
"name": "Wiza",
"firstname": "Laron",
"email": "amina64@hotmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"6": {
"uuid": "7a52cff2-5581-4993-a90b-31ebceb70e83",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:27:26",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": "LOW",
"workflowName": "E_WALLET YMO",
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": "ON_GOING",
"name": "Crist",
"firstname": "Jacinthe",
"email": "esperanza.kuhic70@hotmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"7": {
"uuid": "b17b9418-1e87-4196-9f16-ca42dc9b8498",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-15T12:12:08",
"lastUpdatedAt": "2024-01-15T12:14:16",
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "Monahan",
"firstname": "Leora",
"email": "vaughn_jenkins18@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"8": {
"uuid": "b7fa53f5-1cc7-4524-8a41-364b6e85f6b4",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-25T12:21:11",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": "LOW",
"workflowName": "E_WALLET YMO",
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": "ON_GOING",
"name": "Walter",
"firstname": "Alejandra",
"email": "tessie_ebert@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"9": {
"uuid": "c2e03650-2427-4c25-aa31-016c63f7261b",
"riskPoints": 4,
"customReference": null,
"createdAt": "2024-01-10T09:14:51",
"lastUpdatedAt": "2024-01-10T09:16:03",
"accountType": "BASIC",
"isConverted": true,
"convertedAt": "2024-01-10T09:17:03",
"riskLevel": "LOW",
"workflowName": "E_WALLET YMO",
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ACCEPTED",
"status": "ON_GOING",
"name": "Littel",
"firstname": "Carmelo",
"email": "verna11@yahoo.com",
"activitySector": "Hotels & holiday rentals",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"10": {
"uuid": "cada9f07-17b9-46ae-94a7-94dd94c84d12",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:40:42",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quaftrefydiiftioydfn@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"11": {
"uuid": "d0d6a040-11c0-4196-b07e-65e6c8ce8b72",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:37:52",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quaftrefdiiftioydfn@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"12": {
"uuid": "e375d513-9305-4352-a3d5-a5732ea8954a",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:36:43",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quatrediitioydfn@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"total": {
"total": 13
}
}
Search merchant enrollments
You can use this request to search a merchant enrollment.
date[left_datetime] string |
Filter by from date |
date[right_datetime] string |
Filter by to date |
last_updated_at[left_datetime] string |
Filter by from last updated date |
last_updated_at[right_datetime] string |
Filter by to last updated date |
name string |
Merchant enrollment lastname or company name |
uuid string |
Merchant enrollment uuid |
email string |
Merchant enrollment email |
reference string |
Merchant enrollment reference |
activitySector array |
Activity sector ID |
language array |
Language identifier |
status array |
Merchant enrollment status, list given by /status |
conformityStatusLevelTwo array
|
Merchant enrollment validation status, list given by /status |
accountType array |
Account type |
actor array |
Actor who initiate the merchant enrollment |
isConverted array |
account status |
enrollmentType array |
type of enrollment |
riskLevel array |
risk level of enrollment |
workflowMode array |
Mode du workflow |
additionalDocumentNeedValidation boolean |
Enrollement has additional document which need validation |
additionalDocumentNotUploaded boolean |
Enrollement has additional document which need upload |
options[offset] string |
Offset Default value : 0 |
options[nbPerPage] string |
Nb max of enrollment by response Default value : 20
|
options[sort][*][name] string |
Sort on field |
options[sort][*][direction] string |
Sort direction Available values : ASC, DESC |
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/search
curl --location 'https://test-onboarding-api.centralpay.net/api/merchant-enrollment/search' \\
--header 'Content-Type: application/x-www-form-urlencoded' \\
--header 'Authorization: Basic yours'
--data-urlencode 'email=testcustomer@gmail.com'
{
"0": {
"uuid": "0626d028-b7cc-4b0d-8c55-7c11566faa75",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:37:33",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quatrefdiiftioydfn@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"1": {
"uuid": "2dd27998-f5aa-45fc-8331-988c56497063",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:38:34",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": "LOW",
"workflowName": "E_WALLET YMO",
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": "ON_GOING",
"name": "Cormier",
"firstname": "Myah",
"email": "enid51@hotmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"2": {
"uuid": "34abec10-334c-4331-bc95-7db32cb41191",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:36:15",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quatrediitioydn@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"3": {
"uuid": "427fd364-8a20-4aeb-a8e8-d7010f6afcae",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:37:12",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quatrefdiitioydfn@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"4": {
"uuid": "693a0158-20e2-4e86-88fb-a8f7b70ddc37",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:35:31",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quatrediitioyn@gmail.com",
"activitySector": "Software download",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"5": {
"uuid": "700925d9-8c56-4266-9eda-6d1000ca4bbb",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-05T16:15:36",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": "LOW",
"workflowName": "E_WALLET YMO",
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": "ON_GOING",
"name": "Wiza",
"firstname": "Laron",
"email": "amina64@hotmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"6": {
"uuid": "7a52cff2-5581-4993-a90b-31ebceb70e83",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:27:26",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": "LOW",
"workflowName": "E_WALLET YMO",
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": "ON_GOING",
"name": "Crist",
"firstname": "Jacinthe",
"email": "esperanza.kuhic70@hotmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"7": {
"uuid": "b17b9418-1e87-4196-9f16-ca42dc9b8498",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-15T12:12:08",
"lastUpdatedAt": "2024-01-15T12:14:16",
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "Monahan",
"firstname": "Leora",
"email": "vaughn_jenkins18@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"8": {
"uuid": "b7fa53f5-1cc7-4524-8a41-364b6e85f6b4",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-25T12:21:11",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": "LOW",
"workflowName": "E_WALLET YMO",
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": "ON_GOING",
"name": "Walter",
"firstname": "Alejandra",
"email": "tessie_ebert@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"9": {
"uuid": "c2e03650-2427-4c25-aa31-016c63f7261b",
"riskPoints": 4,
"customReference": null,
"createdAt": "2024-01-10T09:14:51",
"lastUpdatedAt": "2024-01-10T09:16:03",
"accountType": "BASIC",
"isConverted": true,
"convertedAt": "2024-01-10T09:17:03",
"riskLevel": "LOW",
"workflowName": "E_WALLET YMO",
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ACCEPTED",
"status": "ON_GOING",
"name": "Littel",
"firstname": "Carmelo",
"email": "verna11@yahoo.com",
"activitySector": "Hotels & holiday rentals",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"10": {
"uuid": "cada9f07-17b9-46ae-94a7-94dd94c84d12",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:40:42",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quaftrefydiiftioydfn@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"11": {
"uuid": "d0d6a040-11c0-4196-b07e-65e6c8ce8b72",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:37:52",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quaftrefdiiftioydfn@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"12": {
"uuid": "e375d513-9305-4352-a3d5-a5732ea8954a",
"riskPoints": null,
"customReference": null,
"createdAt": "2024-01-12T15:36:43",
"lastUpdatedAt": null,
"accountType": "BASIC",
"isConverted": false,
"convertedAt": null,
"riskLevel": null,
"workflowName": null,
"enrollmentType": "INDIVIDUAL",
"workflowMode": "SEQUENTIAL",
"conformityStatus": "ON_GOING",
"status": null,
"name": "APITEST",
"firstname": "SCT",
"email": "quatrediitioydfn@gmail.com",
"activitySector": "Artisans (plumber, electricians, ...)",
"locale": "fr",
"nationality": null,
"actorInitiator": "e962cfc2-1d4f-4f4f-8688-71c38920ca6b",
"additionalDocumentNeedUpload": false
},
"total": {
"total": 13
}
}
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/nauth/merchant-enrollment/{Enrollment_Uuid}
{
"workflow": {
"uuid": "23a92b66-3dea-4fc6-89e8-3512eeac81bc",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [],
"uuid": "78b696ca-0c27-4dad-a94a-be3b6f2f70b4",
"name": "CompanyInfosA",
"state": "OK",
"category": "company",
"created_at": "2022-05-25T12:18:02"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "8a40191b-d839-46df-a6df-6bf26624df15",
"created_at": "2022-05-25T12:18:38",
"cgu_uuid": "1b644478-46d5-45ab-bce8-e37db1a91498",
"security_uuid": null,
"fee_schedule_uuid": "216e19cf-88a5-4708-acca-1f9edcde08b9",
"element-type": "contract-validation"
}
],
"uuid": "53f2978b-931f-4814-b086-e300109aae40",
"name": "ContractValiA",
"state": "OK",
"category": "validation",
"created_at": "2022-05-25T12:18:12"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "e0e45621-f354-4deb-ac54-18c191183bb7",
"created_at": "2022-05-25T12:20:05",
"type": "UNLOCK_PAYOUT_LIMITS",
"tag": "YES",
"element-type": "question"
}
],
"uuid": "8bd347f4-2b62-45cb-a644-3c6410012d81",
"name": "QuestionLvl1A",
"state": "OK",
"category": "validation",
"created_at": "2022-05-25T12:18:38"
},
{
"step_elements": [],
"uuid": "6dc47b7b-3749-416d-855c-bbff34b9e67e",
"name": "checkInfogreffeRepresentativeA",
"state": "OK",
"category": "company",
"created_at": "2022-05-25T12:20:07"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "04561ef4-5525-4c29-980b-bf42c6483c7e",
"created_at": "2022-05-25T12:20:21",
"documents": [
{
"file_check": [],
"uuid": "be4e1ee1-e886-4f01-8634-e0a157dcb54c",
"mime_type": "image/jpeg"
}
],
"type": "PASSPORT",
"proof_of_identity_document": null,
"expiry_date": "2022-06-30T00:00:00",
"document_number": null,
"mrz_line1": null,
"mrz_line2": null,
"issuing_country": null,
"element-type": "identity-document"
}
],
"uuid": "14edb288-0ec4-4318-b4f9-08ec8927a109",
"name": "DirectorsInfoA",
"state": "OK",
"category": "company",
"created_at": "2022-05-25T12:20:07"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "096410c4-fe96-46cb-943a-c6c0489cf067",
"created_at": "2022-05-25T12:20:22",
"reference": null,
"review_url": null,
"status_call": null,
"element-type": "sanction-check"
}
],
"uuid": "0a3a7ded-f74b-4f34-98e4-4e1d970f3631",
"name": "checkSanctionListA",
"state": "OK",
"category": null,
"created_at": "2022-05-25T12:20:22"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "d8b2296e-4b93-45a8-b163-45d2870930fd",
"created_at": "2022-05-25T12:29:59",
"document": {
"file_check": null,
"uuid": "bad3cdb1-bbc6-4861-8cb8-ee798321df37",
"mime_type": "image/jpeg"
},
"expiry_date": "2027-05-25T00:00:00",
"element-type": "company-registration-number-document"
}
],
"uuid": "ddc673e9-b9a0-4d8d-ab57-1b37b4a0e315",
"name": "CompanyDocA",
"state": "OK",
"category": "company",
"created_at": "2022-05-25T12:20:22"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "33f0a46a-dcad-4a71-a239-bf09fa3a4f4f",
"created_at": "2022-05-25T12:20:46",
"value": "AXABFRPP",
"element-type": "bic"
},
{
"status": "COMPLETED",
"uuid": "76c972da-072e-4f61-a672-1796e1c99266",
"created_at": "2022-05-25T12:30:17",
"document": {
"file_check": null,
"uuid": "cd3687b3-152e-4ba2-86c8-0814e4e5ef54",
"mime_type": "image/jpeg"
},
"expiry_date": "2122-05-25T00:00:00",
"element-type": "iban-document"
},
{
"status": "COMPLETED",
"uuid": "b9584e68-8585-47d8-89a5-57047c401356",
"created_at": "2022-05-25T12:20:46",
"value": "FR7612548029980000000150086",
"element-type": "iban"
}
],
"uuid": "f6599c76-8578-4370-8520-404ef44861df",
"name": "BankA",
"state": "OK",
"category": "company",
"created_at": "2022-05-25T12:20:33"
},
{
"step_elements": [],
"uuid": "0e8567a1-42b8-42f9-a7f1-3f7d8de10241",
"name": "QuestionLvl2A",
"state": "TODO",
"category": "validation",
"created_at": "2022-05-25T12:20:46"
}
],
"additional_documents": []
},
"identity_badge": {
"siren": "807848478"
},
"representatives_list": {
"uuid": "874d0b8a-fd82-4718-92c3-a930a5f1d1f7",
"representatives_physical": [
{
"usename": null,
"uuid": "b7b58547-0c18-479c-9e43-020ee186f57d",
"firstname": "testEnrolIBasicIndiv",
"lastname": "testEnrolIBasicIndiv",
"birthday": "1995-05-17T00:00:00",
"role": "PRESIDENT",
"identity_document": [
{
"status": "COMPLETED",
"uuid": "04561ef4-5525-4c29-980b-bf42c6483c7e",
"created_at": "2022-05-25T12:20:21",
"documents": [
{
"file_check": [],
"uuid": "be4e1ee1-e886-4f01-8634-e0a157dcb54c",
"mime_type": "image/jpeg"
}
],
"type": "PASSPORT",
"proof_of_identity_document": null,
"expiry_date": "2022-06-30T00:00:00",
"document_number": null,
"mrz_line1": null,
"mrz_line2": null,
"issuing_country": null,
"element-type": "identity-document"
}
],
"is_manual": true
}
],
"representatives_corporate": []
},
"inactive_representatives_list": [],
"infogreffe_identity": {
"uuid": "5c244a92-178e-41fb-851e-178b338aa0e2",
"status_call": "200",
"created_at": "2024-02-15T17:29:50"
},
"language": "fr",
"risk_score": {
"activity": 2,
"activity_age": 1,
"turnover": null,
"bank_account": 1,
"total": 4
},
"monthly_turnover": 0,
"monthly_turnover_currency": "",
"merchant_enrollment_autocompleted": null,
"api_infogreffe_identity": {
"api_error": 200,
"last_execution_date": "2024-02-15T17:29:50"
},
"kyc_update": {
"uuid": "f75acbe5-52d6-4802-8bf1-3ba3425b1279",
"created_at": "2024-02-15T17:29:49",
"kyc_update_history": [
{
"uuid": "ceaa41d9-e1e1-40e4-aa5c-befcb0e672a3",
"created_at": "2024-02-15T17:29:50",
"status": "OK",
"comment": "BATCH OBD : Entreprise AE ou LE sans changements",
"bo_user_uuid": null
},
{
"uuid": "49a74a57-99cc-4812-9be8-9456178dba55",
"created_at": "2024-02-15T17:29:49",
"status": "ON_GOING_UNSUPPORTED",
"comment": null,
"bo_user_uuid": null
}
]
},
"additional_document_need_upload": false,
"uuid": "422f6f04-9a52-4770-9cd5-633fec09737c",
"risk_points": 4,
"created_at": "2022-05-25T12:15:26",
"last_updated_at": "2022-05-25T12:32:42",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": "HIGH",
"actor_initiator": "0055bff7-566c-4688-818c-85caf3601785",
"type": "INDIVIDUAL_WITH_STATUS",
"is_canceled": false,
"enrollment_account": {
"login": "testenrolibasicindiv@gmail.com"
},
"profile": {
"birthname": null,
"uuid": "f709338b-b647-433e-95fc-940b8ef80076",
"workflow": {
"uuid": "da96a170-a746-4d3d-b37c-915b7c4f7680",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "ec6429fe-faa4-4b7f-802a-a745c6be6587",
"created_at": "2022-05-25T12:15:26",
"value": "testEnrolIBasicIndiv",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "49a0f512-09d7-4ce8-ab7d-4591c534ca8b",
"created_at": "2022-05-25T12:15:26",
"value": "+33625079245",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "a504888b-eb70-44f2-9f24-b84246a19804",
"created_at": "2022-05-25T12:15:26",
"value": "testenrolibasicindiv@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "94676f73-1415-4a59-bb7e-50e2fafd5ce6",
"created_at": "2022-05-25T12:16:24",
"value": "1995-05-17T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "408fd586-ac53-4619-9b15-e4655c8f4e94",
"created_at": "2022-05-25T12:15:26",
"value": "testEnrolIBasicIndiv",
"element-type": "firstname"
}
],
"uuid": "3304b130-c3c8-40d0-bd28-67dc0023f1cc",
"name": "identityInfos",
"state": "OK",
"category": "identity",
"created_at": "2022-05-25T12:15:26"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "8d9ac561-af36-4742-b270-4b3172c264ea",
"created_at": "2022-05-25T12:16:40",
"name_line1": "6 rue Emile Zola",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Tours",
"postal_code": "37000",
"country": "FRA",
"element-type": "address"
}
],
"uuid": "f66aba15-c967-4e85-ab7e-10befca8830a",
"name": "domiciliation",
"state": "OK",
"category": "identity",
"created_at": "2022-05-25T12:16:24"
},
{
"step_elements": [],
"uuid": "08540293-e967-4627-8c67-539b82c6feea",
"name": "checkInfogreffeA",
"state": "OK",
"category": "company",
"created_at": "2022-05-25T12:16:40"
},
{
"step_elements": [],
"uuid": "a437db03-1c8b-4076-a3cc-c7b2987c7155",
"name": "finished",
"state": "OK",
"category": null,
"created_at": "2022-05-25T12:16:41"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "408fd586-ac53-4619-9b15-e4655c8f4e94",
"created_at": "2022-05-25T12:15:26",
"value": "testEnrolIBasicIndiv",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "ec6429fe-faa4-4b7f-802a-a745c6be6587",
"created_at": "2022-05-25T12:15:26",
"value": "testEnrolIBasicIndiv",
"element-type": "lastname"
},
"usename": null,
"email": {
"status": "COMPLETED",
"uuid": "a504888b-eb70-44f2-9f24-b84246a19804",
"created_at": "2022-05-25T12:15:26",
"value": "testenrolibasicindiv@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "6995923e-17fe-412b-8a59-6208c2961aec",
"created_at": "2022-05-25T12:15:26",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "49a0f512-09d7-4ce8-ab7d-4591c534ca8b",
"created_at": "2022-05-25T12:15:26",
"value": "+33625079245",
"element-type": "phone"
},
"birthday": {
"status": "COMPLETED",
"uuid": "94676f73-1415-4a59-bb7e-50e2fafd5ce6",
"created_at": "2022-05-25T12:16:24",
"value": "1995-05-17T00:00:00",
"element-type": "birthday"
},
"login": "testenrolibasicindiv@gmail.com",
"bo_user_uuid": "15e8ec39-479a-40df-b1e0-70e05a86b174"
},
"activity_sector": {
"uuid": "6fcffdab-4ae8-4036-a363-f4c919dd3a69",
"name": "Electronic devices and computers"
},
"data": {
"type": "PARTICULAR",
"company_name": "THEO TISON",
"history": [],
"turnover": null,
"activity_age": {
"uuid": "7ed342d1-d187-4beb-80fe-bdf6158b83b9"
}
},
"custom_reference": null,
"is_converted": true,
"conformity_status": "ACCEPTED",
"conformity_status_level_two": null,
"validator_level_one": "be24f3ec-e291-4a81-81e1-9b6f35e46806",
"validator_level_two": null,
"merchant_uuid": "aea7ec9a-d568-43b3-96ad-8956e7189759",
"validation_date": "2022-05-30T17:28:11",
"validation_date_level_two": null,
"sub_type": null,
"api_infogreffe_attempt": 0,
"next_step": 6,
"merchant_enrollment_additional": [
{
"uuid": "6789d730-946e-457d-b4ad-5aeb65505046",
"created_at": "2023-01-30T17:14:16",
"actor_initiator_additional": "d724fc79-6aec-4526-a4eb-30c3c7f8897d",
"cgu": "109bab51-7c4a-42c4-9399-dba16fce8f7e",
"fee_schedule": "b102b0dc-7689-4e15-be63-63e56bdd380c",
"security_reference": null,
"contract": null,
"contract_validated": false,
"contract_validated_at": null,
"linked": false,
"linked_at": null,
"current_workflow": {
"uuid": "6dac427e-513e-4d35-886c-b1fdede861c9",
"status": "ON_GOING",
"activities": [
{
"step_elements": [],
"uuid": "55f13cdd-7341-4d2f-91c6-fc40c6852cca",
"name": "CompanyInfosA",
"state": "TODO",
"category": "company",
"created_at": "2023-01-30T17:14:16"
}
],
"additional_documents": []
},
"account_type": "BASIC"
}
],
"full_kyc": false,
"auto_updated_data": false
}
Get Merchant Enrollment
This function allows you to get a merchant enrollment.
GET https://test-onboarding-api.centralpay.net/api/nauth/merchant-enrollment/{Enrollment_Uuid}
{
"workflow": {
"uuid": "23a92b66-3dea-4fc6-89e8-3512eeac81bc",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [],
"uuid": "78b696ca-0c27-4dad-a94a-be3b6f2f70b4",
"name": "CompanyInfosA",
"state": "OK",
"category": "company",
"created_at": "2022-05-25T12:18:02"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "8a40191b-d839-46df-a6df-6bf26624df15",
"created_at": "2022-05-25T12:18:38",
"cgu_uuid": "1b644478-46d5-45ab-bce8-e37db1a91498",
"security_uuid": null,
"fee_schedule_uuid": "216e19cf-88a5-4708-acca-1f9edcde08b9",
"element-type": "contract-validation"
}
],
"uuid": "53f2978b-931f-4814-b086-e300109aae40",
"name": "ContractValiA",
"state": "OK",
"category": "validation",
"created_at": "2022-05-25T12:18:12"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "e0e45621-f354-4deb-ac54-18c191183bb7",
"created_at": "2022-05-25T12:20:05",
"type": "UNLOCK_PAYOUT_LIMITS",
"tag": "YES",
"element-type": "question"
}
],
"uuid": "8bd347f4-2b62-45cb-a644-3c6410012d81",
"name": "QuestionLvl1A",
"state": "OK",
"category": "validation",
"created_at": "2022-05-25T12:18:38"
},
{
"step_elements": [],
"uuid": "6dc47b7b-3749-416d-855c-bbff34b9e67e",
"name": "checkInfogreffeRepresentativeA",
"state": "OK",
"category": "company",
"created_at": "2022-05-25T12:20:07"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "04561ef4-5525-4c29-980b-bf42c6483c7e",
"created_at": "2022-05-25T12:20:21",
"documents": [
{
"file_check": [],
"uuid": "be4e1ee1-e886-4f01-8634-e0a157dcb54c",
"mime_type": "image/jpeg"
}
],
"type": "PASSPORT",
"proof_of_identity_document": null,
"expiry_date": "2022-06-30T00:00:00",
"document_number": null,
"mrz_line1": null,
"mrz_line2": null,
"issuing_country": null,
"element-type": "identity-document"
}
],
"uuid": "14edb288-0ec4-4318-b4f9-08ec8927a109",
"name": "DirectorsInfoA",
"state": "OK",
"category": "company",
"created_at": "2022-05-25T12:20:07"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "096410c4-fe96-46cb-943a-c6c0489cf067",
"created_at": "2022-05-25T12:20:22",
"reference": null,
"review_url": null,
"status_call": null,
"element-type": "sanction-check"
}
],
"uuid": "0a3a7ded-f74b-4f34-98e4-4e1d970f3631",
"name": "checkSanctionListA",
"state": "OK",
"category": null,
"created_at": "2022-05-25T12:20:22"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "d8b2296e-4b93-45a8-b163-45d2870930fd",
"created_at": "2022-05-25T12:29:59",
"document": {
"file_check": null,
"uuid": "bad3cdb1-bbc6-4861-8cb8-ee798321df37",
"mime_type": "image/jpeg"
},
"expiry_date": "2027-05-25T00:00:00",
"element-type": "company-registration-number-document"
}
],
"uuid": "ddc673e9-b9a0-4d8d-ab57-1b37b4a0e315",
"name": "CompanyDocA",
"state": "OK",
"category": "company",
"created_at": "2022-05-25T12:20:22"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "33f0a46a-dcad-4a71-a239-bf09fa3a4f4f",
"created_at": "2022-05-25T12:20:46",
"value": "AXABFRPP",
"element-type": "bic"
},
{
"status": "COMPLETED",
"uuid": "76c972da-072e-4f61-a672-1796e1c99266",
"created_at": "2022-05-25T12:30:17",
"document": {
"file_check": null,
"uuid": "cd3687b3-152e-4ba2-86c8-0814e4e5ef54",
"mime_type": "image/jpeg"
},
"expiry_date": "2122-05-25T00:00:00",
"element-type": "iban-document"
},
{
"status": "COMPLETED",
"uuid": "b9584e68-8585-47d8-89a5-57047c401356",
"created_at": "2022-05-25T12:20:46",
"value": "FR7612548029980000000150086",
"element-type": "iban"
}
],
"uuid": "f6599c76-8578-4370-8520-404ef44861df",
"name": "BankA",
"state": "OK",
"category": "company",
"created_at": "2022-05-25T12:20:33"
},
{
"step_elements": [],
"uuid": "0e8567a1-42b8-42f9-a7f1-3f7d8de10241",
"name": "QuestionLvl2A",
"state": "TODO",
"category": "validation",
"created_at": "2022-05-25T12:20:46"
}
],
"additional_documents": []
},
"identity_badge": {
"siren": "807848478"
},
"representatives_list": {
"uuid": "874d0b8a-fd82-4718-92c3-a930a5f1d1f7",
"representatives_physical": [
{
"usename": null,
"uuid": "b7b58547-0c18-479c-9e43-020ee186f57d",
"firstname": "testEnrolIBasicIndiv",
"lastname": "testEnrolIBasicIndiv",
"birthday": "1995-05-17T00:00:00",
"role": "PRESIDENT",
"identity_document": [
{
"status": "COMPLETED",
"uuid": "04561ef4-5525-4c29-980b-bf42c6483c7e",
"created_at": "2022-05-25T12:20:21",
"documents": [
{
"file_check": [],
"uuid": "be4e1ee1-e886-4f01-8634-e0a157dcb54c",
"mime_type": "image/jpeg"
}
],
"type": "PASSPORT",
"proof_of_identity_document": null,
"expiry_date": "2022-06-30T00:00:00",
"document_number": null,
"mrz_line1": null,
"mrz_line2": null,
"issuing_country": null,
"element-type": "identity-document"
}
],
"is_manual": true
}
],
"representatives_corporate": []
},
"inactive_representatives_list": [],
"infogreffe_identity": {
"uuid": "5c244a92-178e-41fb-851e-178b338aa0e2",
"status_call": "200",
"created_at": "2024-02-15T17:29:50"
},
"language": "fr",
"risk_score": {
"activity": 2,
"activity_age": 1,
"turnover": null,
"bank_account": 1,
"total": 4
},
"monthly_turnover": 0,
"monthly_turnover_currency": "",
"merchant_enrollment_autocompleted": null,
"api_infogreffe_identity": {
"api_error": 200,
"last_execution_date": "2024-02-15T17:29:50"
},
"kyc_update": {
"uuid": "f75acbe5-52d6-4802-8bf1-3ba3425b1279",
"created_at": "2024-02-15T17:29:49",
"kyc_update_history": [
{
"uuid": "ceaa41d9-e1e1-40e4-aa5c-befcb0e672a3",
"created_at": "2024-02-15T17:29:50",
"status": "OK",
"comment": "BATCH OBD : Entreprise AE ou LE sans changements",
"bo_user_uuid": null
},
{
"uuid": "49a74a57-99cc-4812-9be8-9456178dba55",
"created_at": "2024-02-15T17:29:49",
"status": "ON_GOING_UNSUPPORTED",
"comment": null,
"bo_user_uuid": null
}
]
},
"additional_document_need_upload": false,
"uuid": "422f6f04-9a52-4770-9cd5-633fec09737c",
"risk_points": 4,
"created_at": "2022-05-25T12:15:26",
"last_updated_at": "2022-05-25T12:32:42",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": "HIGH",
"actor_initiator": "0055bff7-566c-4688-818c-85caf3601785",
"type": "INDIVIDUAL_WITH_STATUS",
"is_canceled": false,
"enrollment_account": {
"login": "testenrolibasicindiv@gmail.com"
},
"profile": {
"birthname": null,
"uuid": "f709338b-b647-433e-95fc-940b8ef80076",
"workflow": {
"uuid": "da96a170-a746-4d3d-b37c-915b7c4f7680",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "ec6429fe-faa4-4b7f-802a-a745c6be6587",
"created_at": "2022-05-25T12:15:26",
"value": "testEnrolIBasicIndiv",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "49a0f512-09d7-4ce8-ab7d-4591c534ca8b",
"created_at": "2022-05-25T12:15:26",
"value": "+33625079245",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "a504888b-eb70-44f2-9f24-b84246a19804",
"created_at": "2022-05-25T12:15:26",
"value": "testenrolibasicindiv@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "94676f73-1415-4a59-bb7e-50e2fafd5ce6",
"created_at": "2022-05-25T12:16:24",
"value": "1995-05-17T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "408fd586-ac53-4619-9b15-e4655c8f4e94",
"created_at": "2022-05-25T12:15:26",
"value": "testEnrolIBasicIndiv",
"element-type": "firstname"
}
],
"uuid": "3304b130-c3c8-40d0-bd28-67dc0023f1cc",
"name": "identityInfos",
"state": "OK",
"category": "identity",
"created_at": "2022-05-25T12:15:26"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "8d9ac561-af36-4742-b270-4b3172c264ea",
"created_at": "2022-05-25T12:16:40",
"name_line1": "6 rue Emile Zola",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Tours",
"postal_code": "37000",
"country": "FRA",
"element-type": "address"
}
],
"uuid": "f66aba15-c967-4e85-ab7e-10befca8830a",
"name": "domiciliation",
"state": "OK",
"category": "identity",
"created_at": "2022-05-25T12:16:24"
},
{
"step_elements": [],
"uuid": "08540293-e967-4627-8c67-539b82c6feea",
"name": "checkInfogreffeA",
"state": "OK",
"category": "company",
"created_at": "2022-05-25T12:16:40"
},
{
"step_elements": [],
"uuid": "a437db03-1c8b-4076-a3cc-c7b2987c7155",
"name": "finished",
"state": "OK",
"category": null,
"created_at": "2022-05-25T12:16:41"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "408fd586-ac53-4619-9b15-e4655c8f4e94",
"created_at": "2022-05-25T12:15:26",
"value": "testEnrolIBasicIndiv",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "ec6429fe-faa4-4b7f-802a-a745c6be6587",
"created_at": "2022-05-25T12:15:26",
"value": "testEnrolIBasicIndiv",
"element-type": "lastname"
},
"usename": null,
"email": {
"status": "COMPLETED",
"uuid": "a504888b-eb70-44f2-9f24-b84246a19804",
"created_at": "2022-05-25T12:15:26",
"value": "testenrolibasicindiv@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "6995923e-17fe-412b-8a59-6208c2961aec",
"created_at": "2022-05-25T12:15:26",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "49a0f512-09d7-4ce8-ab7d-4591c534ca8b",
"created_at": "2022-05-25T12:15:26",
"value": "+33625079245",
"element-type": "phone"
},
"birthday": {
"status": "COMPLETED",
"uuid": "94676f73-1415-4a59-bb7e-50e2fafd5ce6",
"created_at": "2022-05-25T12:16:24",
"value": "1995-05-17T00:00:00",
"element-type": "birthday"
},
"login": "testenrolibasicindiv@gmail.com",
"bo_user_uuid": "15e8ec39-479a-40df-b1e0-70e05a86b174"
},
"activity_sector": {
"uuid": "6fcffdab-4ae8-4036-a363-f4c919dd3a69",
"name": "Electronic devices and computers"
},
"data": {
"type": "PARTICULAR",
"company_name": "THEO TISON",
"history": [],
"turnover": null,
"activity_age": {
"uuid": "7ed342d1-d187-4beb-80fe-bdf6158b83b9"
}
},
"custom_reference": null,
"is_converted": true,
"conformity_status": "ACCEPTED",
"conformity_status_level_two": null,
"validator_level_one": "be24f3ec-e291-4a81-81e1-9b6f35e46806",
"validator_level_two": null,
"merchant_uuid": "aea7ec9a-d568-43b3-96ad-8956e7189759",
"validation_date": "2022-05-30T17:28:11",
"validation_date_level_two": null,
"sub_type": null,
"api_infogreffe_attempt": 0,
"next_step": 6,
"merchant_enrollment_additional": [
{
"uuid": "6789d730-946e-457d-b4ad-5aeb65505046",
"created_at": "2023-01-30T17:14:16",
"actor_initiator_additional": "d724fc79-6aec-4526-a4eb-30c3c7f8897d",
"cgu": "109bab51-7c4a-42c4-9399-dba16fce8f7e",
"fee_schedule": "b102b0dc-7689-4e15-be63-63e56bdd380c",
"security_reference": null,
"contract": null,
"contract_validated": false,
"contract_validated_at": null,
"linked": false,
"linked_at": null,
"current_workflow": {
"uuid": "6dac427e-513e-4d35-886c-b1fdede861c9",
"status": "ON_GOING",
"activities": [
{
"step_elements": [],
"uuid": "55f13cdd-7341-4d2f-91c6-fc40c6852cca",
"name": "CompanyInfosA",
"state": "TODO",
"category": "company",
"created_at": "2023-01-30T17:14:16"
}
],
"additional_documents": []
},
"account_type": "BASIC"
}
],
"full_kyc": false,
"auto_updated_data": false
}
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"}
Onboarding (E-money)
These requests allows you to achieve an onboarding process for an electronic money account.
In the context of an electronic money onboarding, these requests allow you to quickly complete the process by using first the Create request then the Autocomplete. In case the identity or bank documents are refused by our conformity service, you can use the Autoupdate request to resend them.
We will call EM user (Electronic Money user) the person getting enrolled.
curl --location 'https://test-onboarding-api.centralpay.net/api/merchant-enrollment' \
--header 'Authorization: Basic ZG9jdGVzdF9hdXRyZW1hcmNoYW5kOjRJOUhKUlRk' \
--header 'Cookie: PHPSESSID=mopdm7amrnvi3jaa7sukbap6nl' \
--form 'profile[firstname][value]="John"' \
--form 'profile[lastname][value]="Doe"' \
--form 'profile[email][value]="jdoe10@gmail.com"' \
--form 'profile[phone][value]="+33678910112"' \
--form 'profile[birthday][value]="1984-12-21"' \
--form 'profile[place_of_birth][value]="Tours"' \
--form 'profile[country_of_birth][country]="FRA"' \
--form 'language="fr"' \
--form 'accountType="BASIC"' \
--form 'activitySector="6d8241d5-e9e3-4980-844d-c2f29bea0b05"' \
--form 'feeSchedule="216e19cf-88a5-4708-acca-1f9edcde08b9"' \
--form 'type="INDIVIDUAL"' \
--form 'allowedEmailCommunication="false"' \
--form 'profileWorkflowDefinition="17d3e285-6bed-440b-9eb3-b1be71d54a5f"' \
--form 'workflowDefinition="6841b2a8-c9ee-4095-99bd-de0f7e3b12a3"' \
--form 'workflowMode="SEQUENTIAL"' \
--form 'turnover="aed57921-81d8-4f22-8b13-b2f150503800"' \
--form 'walletId="4622723a-6318-41e8-b2db-607cf9b06b02"'
{
"workflow": {
"uuid": "9cc21050-7142-4e9b-b442-07a10609431c",
"status": "ON_GOING",
"activities": [
{
"step_elements": [],
"uuid": "2ead765c-7e05-47b1-aa84-7b9c4e417fe0",
"name": "ContractValiA",
"state": "TODO",
"category": "validation",
"created_at": "2023-05-16T09:27:21"
}
],
"additional_documents": []
},
"identity_badge": null,
"representatives_list": null,
"infogreffe_identity": null,
"language": "fr",
"risk_score": {
"activity": 2,
"activity_age": null,
"turnover": 1,
"bank_account": 0,
"total": null
},
"uuid": "3fb02825-bcd5-45b8-97c4-e7c349783194",
"risk_points": null,
"created_at": "2023-05-16T09:27:21",
"last_updated_at": null,
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": "LOW",
"type": "INDIVIDUAL",
"is_canceled": false,
"enrollment_account": null,
"profile": {
"uuid": "7509b84f-0a1f-4f4e-97a1-ae879374e6a7",
"workflow": {
"uuid": "97967c48-5ef8-4640-9cbe-a852e031e39d",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "ec5ae939-7385-42ac-9f86-b1f7c7773c65",
"value": "Tours",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "812bf047-6c71-4b46-b137-4aff31709ae4",
"country": "FRA",
"element-type": "country-of-birth"
}
],
"uuid": "7b8e1e39-4965-44f5-9129-8579ae46e5ef",
"name": "identityInfos",
"state": "TODO",
"category": "identity",
"created_at": "2023-05-16T09:27:21"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
"usename": null,
"email": {
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "8e1755e4-10d3-43d6-aca3-c406f1c36d0e",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
"birthday": {
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
"login": null,
"bo_user_uuid": null
},
"activity_sector": {
"name": "Agriculture"
},
"data": {
"type": "PARTICULAR",
"company_name": null,
"turnover": {
"name": "Less than 20k EUR"
},
"activity_age": null
},
"custom_reference": null,
"is_converted": false,
"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 request allows you to create an electronic money enrollment.
profile[firstname][value] string (255) |
EM user firstname Required : yes Validation : alpha characters and "-" character |
profile[lastname][value] string (255) |
EM user lastname Required : yes Validation : alpha characters and "-" character |
profile[email][value] String (255) |
EM user email Required : yes |
profile[phone][value] String (15) |
EM user International phone number Required : yes |
profile[birthday][value] Date (YYYY-MM-DD) |
EM user date of birth Required : yes |
profile[place_of_birth][value] String (255) |
EM user place of birth Required : yes |
profile[country_of_birth][country] String (3) |
EM user country of birth Required : yes Constraint : ISO 3166-1 alpha-3 |
language String (3) |
Desired language for the enrollment Required : yes Validation : "en" or "fr" (English or French) |
accountType String (50) |
EM user enrollment account type Required : yes Validation : "BASIC" |
activitySector uuid (36) |
EM user activity sector Required : yes Use this request to get the uuid of your activitySector |
feeSchedule uuid (36) |
EM user feeSchedule Required : yes Use this request to get the uuid of your feeSchedule |
type String (20) |
EM user legal status Required : yes Validation : "INDIVIDUAL" |
allowedEmailCommunication Boolean |
True if the EM user wants to receive our communication mails, false if he doesn't Required : yes Validation : true or false |
profileWorkflowDefinition uuid (36) |
Specific for each merchant, provided by CentralPay Required : yes Validation : valid uuid |
workflowDefinition uuid (36) |
Specific for each merchant, provided by CentralPay Required : yes Validation : valid uuid |
workflowMode string (255) |
Defines when the identity documents will be asked, in the case of an electronic money onboarding it must be "SEQUENTIAL" Required : yes Validation : "SEQUENTIAL" |
turnover uuid (36) |
Expected annual turnover Required : yes Use this request to get the corresponding uuid for your turnover |
walletId uuid (36) |
The uuid of the EM user wallet Required : yes Validation : valid uuid |
curl --location 'https://test-onboarding-api.centralpay.net/api/merchant-enrollment' \
--header 'Authorization: Basic ZG9jdGVzdF9hdXRyZW1hcmNoYW5kOjRJOUhKUlRk' \
--header 'Cookie: PHPSESSID=mopdm7amrnvi3jaa7sukbap6nl' \
--form 'profile[firstname][value]="John"' \
--form 'profile[lastname][value]="Doe"' \
--form 'profile[email][value]="jdoe10@gmail.com"' \
--form 'profile[phone][value]="+33678910112"' \
--form 'profile[birthday][value]="1984-12-21"' \
--form 'profile[place_of_birth][value]="Tours"' \
--form 'profile[country_of_birth][country]="FRA"' \
--form 'language="fr"' \
--form 'accountType="BASIC"' \
--form 'activitySector="6d8241d5-e9e3-4980-844d-c2f29bea0b05"' \
--form 'feeSchedule="216e19cf-88a5-4708-acca-1f9edcde08b9"' \
--form 'type="INDIVIDUAL"' \
--form 'allowedEmailCommunication="false"' \
--form 'profileWorkflowDefinition="17d3e285-6bed-440b-9eb3-b1be71d54a5f"' \
--form 'workflowDefinition="6841b2a8-c9ee-4095-99bd-de0f7e3b12a3"' \
--form 'workflowMode="SEQUENTIAL"' \
--form 'turnover="aed57921-81d8-4f22-8b13-b2f150503800"' \
--form 'walletId="4622723a-6318-41e8-b2db-607cf9b06b02"'
{
"workflow": {
"uuid": "9cc21050-7142-4e9b-b442-07a10609431c",
"status": "ON_GOING",
"activities": [
{
"step_elements": [],
"uuid": "2ead765c-7e05-47b1-aa84-7b9c4e417fe0",
"name": "ContractValiA",
"state": "TODO",
"category": "validation",
"created_at": "2023-05-16T09:27:21"
}
],
"additional_documents": []
},
"identity_badge": null,
"representatives_list": null,
"infogreffe_identity": null,
"language": "fr",
"risk_score": {
"activity": 2,
"activity_age": null,
"turnover": 1,
"bank_account": 0,
"total": null
},
"uuid": "3fb02825-bcd5-45b8-97c4-e7c349783194",
"risk_points": null,
"created_at": "2023-05-16T09:27:21",
"last_updated_at": null,
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": "LOW",
"type": "INDIVIDUAL",
"is_canceled": false,
"enrollment_account": null,
"profile": {
"uuid": "7509b84f-0a1f-4f4e-97a1-ae879374e6a7",
"workflow": {
"uuid": "97967c48-5ef8-4640-9cbe-a852e031e39d",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "ec5ae939-7385-42ac-9f86-b1f7c7773c65",
"value": "Tours",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "812bf047-6c71-4b46-b137-4aff31709ae4",
"country": "FRA",
"element-type": "country-of-birth"
}
],
"uuid": "7b8e1e39-4965-44f5-9129-8579ae46e5ef",
"name": "identityInfos",
"state": "TODO",
"category": "identity",
"created_at": "2023-05-16T09:27:21"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
"usename": null,
"email": {
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "8e1755e4-10d3-43d6-aca3-c406f1c36d0e",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
"birthday": {
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
"login": null,
"bo_user_uuid": null
},
"activity_sector": {
"name": "Agriculture"
},
"data": {
"type": "PARTICULAR",
"company_name": null,
"turnover": {
"name": "Less than 20k EUR"
},
"activity_age": null
},
"custom_reference": null,
"is_converted": false,
"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
}
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/3fb02825-bcd5-45b8-97c4-e7c349783194/autocomplete
curl --location 'https://test-onboarding-api.centralpay.net/api/merchant-enrollment/3fb02825-bcd5-45b8-97c4-e7c349783194/autocomplete' \
--header 'Browser-User-Agent: edo-test-user-agent' \
--header 'Browser-IP: 8.8.8.8' \
--header 'Authorization: Basic ZG9jdGVzdF9hdXRyZW1hcmNoYW5kOjRJOUhKUlRk' \
--header 'Cookie: PHPSESSID=30lgom2f5tra5apage0qijuv3d' \
--form 'address[locality]="Tours"' \
--form 'address[nameLine1]="Rue du bois"' \
--form 'address[postalCode]="37000"' \
--form 'address[country]="FRA"' \
--form 'identityDocument[type]="VISA"' \
--form 'identityDocument[documents][0]=@"/home/jdoe/Documents/image.png"' \
--form 'identityDocument[expiryDate]="1984-12-21"' \
--form 'identityDocument[documentNumber]="123456789"' \
--form 'identityDocument[mrzLine1]=">>>123456789abc"' \
--form 'identityDocument[mrzLine2]=">>>123456789abc"' \
--form 'identityDocument[issuingCountry]="FRA"' \
--form 'iban[value]="FR7612548029980000000150086"' \
--form 'bic[value]="AXABFRPP"' \
--form 'ibanDocument[document]=@"/home/jdoe/Documents/image.png"' \
--form 'metaData="'\''{\"action\":\"réaction\"}'\''"' \
--form 'riskData[isPep]="false"' \
--form 'riskData[isInSanctionList]="false"' \
--form 'riskData[residentAlpha3Code]="FRA"' \
--form 'riskData[isHighRiskResident]="false"' \
--form 'riskData[nationalityAlpha3Code]="FRA"' \
--form 'riskData[isHighRiskNationality]="false"' \
--form 'riskData[isHighRiskMCCActivitySector]="false"' \
--form 'riskData[MCCActivitySector]="7011"' \
--form 'riskData[monthlyLimit]="100000"' \
--form 'riskData[monthlyLimitCurrencyAlphabeticCode]="GTH"' \
--form 'complementaryIdentityDocument[documents][0]=@"/home/jdoe/Documents/image.png"' \
--form 'complementaryIdentityDocument[documents][1]=@"/home/jdoe/Documents/image.png"' \
--form 'complementaryIdentityDocument[documents][2]=@"/home/jdoe/Documents/image.png"' \
--form 'incomeDocument[document]=@"/home/jdoe/Documents/image.png"'
{
"workflow": {
"uuid": "9cc21050-7142-4e9b-b442-07a10609431c",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "13875b60-f70c-4b99-b65a-df2a00976569",
"element-type": "contract-validation"
}
],
"uuid": "2ead765c-7e05-47b1-aa84-7b9c4e417fe0",
"name": "ContractValiA",
"state": "OK",
"category": "validation",
"created_at": "2023-05-16T09:27:21"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "54f1250c-f665-4b0e-951f-3f5c0aea72a9",
"reference": null,
"review_url": null,
"status_call": null,
"element-type": "sanction-check"
}
],
"uuid": "0dad7211-f823-4eb7-b365-dd5d6df5885b",
"name": "checkSanctionListA",
"state": "OK",
"category": null,
"created_at": "2023-05-16T09:28:39"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "d482ff6e-a24a-4e21-b413-91adf62246a6",
"type": "UNLOCK_PAYOUT_LIMITS",
"tag": "YES",
"element-type": "question"
}
],
"uuid": "ae1129d3-7a12-4caf-98fe-b5380d843505",
"name": "QuestionLvl1A",
"state": "OK",
"category": "validation",
"created_at": "2023-05-16T09:28:39"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "2e4d4288-9f27-4d72-b0fe-059b13353ee2",
"documents": [
{
"file_check": null
},
{
"file_check": null
},
{
"file_check": null
}
],
"expiry_date": null,
"document_number": null,
"mrz_line1": null,
"mrz_line2": null,
"issuing_country": null,
"element-type": "complementary-identity-document"
}
],
"uuid": "2332e321-804e-4832-a446-21674deeeaef",
"name": "compIdentityA",
"state": "OK",
"category": "identity",
"created_at": "2023-05-16T09:28:39"
},
{
"step_elements": [],
"uuid": "c8337caa-8ebe-499d-bd06-e4b74c8bf0a1",
"name": "QuestionLvl2A",
"state": "TODO",
"category": "validation",
"created_at": "2023-05-16T09:28:39"
}
],
"additional_documents": []
},
"identity_badge": null,
"representatives_list": null,
"infogreffe_identity": null,
"language": "fr",
"risk_score": {
"activity": 2,
"activity_age": null,
"turnover": 1,
"bank_account": 0,
"total": 7
},
"uuid": "3fb02825-bcd5-45b8-97c4-e7c349783194",
"risk_points": 7,
"created_at": "2023-05-16T09:27:21",
"last_updated_at": "2023-05-16T09:28:39",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": "MEDIUM",
"type": "INDIVIDUAL",
"is_canceled": false,
"enrollment_account": {
"login": "jdoe10@gmail.com"
},
"profile": {
"uuid": "7509b84f-0a1f-4f4e-97a1-ae879374e6a7",
"workflow": {
"uuid": "97967c48-5ef8-4640-9cbe-a852e031e39d",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "812bf047-6c71-4b46-b137-4aff31709ae4",
"country": "FRA",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "ec5ae939-7385-42ac-9f86-b1f7c7773c65",
"value": "Tours",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "ec5ae939-7385-42ac-9f86-b1f7c7773c65",
"value": "Tours",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "812bf047-6c71-4b46-b137-4aff31709ae4",
"country": "FRA",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "c4f845c7-44d8-48b4-bcf7-aee9f5cce365",
"documents": [
{
"file_check": null
}
],
"type": "VISA",
"expiry_date": "1984-12-21T00:00:00",
"document_number": "123456789",
"mrz_line1": ">>>123456789abc",
"mrz_line2": ">>>123456789abc",
"issuing_country": {
"country": "FRA"
},
"element-type": "identity-document"
},
{
"status": "COMPLETED",
"uuid": "35ffd5e6-4a78-43d3-b436-b5ce3ad3355e",
"name_line1": "Rue du bois",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Tours",
"postal_code": "37000",
"country": "FRA",
"element-type": "address"
}
],
"uuid": "7b8e1e39-4965-44f5-9129-8579ae46e5ef",
"name": "identityInfos",
"state": "OK",
"category": "identity",
"created_at": "2023-05-16T09:27:21"
},
{
"step_elements": [],
"uuid": "9da5b6b0-0eb1-4f56-bc31-9c9e2d4ee824",
"name": "finished",
"state": "OK",
"category": null,
"created_at": "2023-05-16T09:28:38"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
"usename": null,
"email": {
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "8e1755e4-10d3-43d6-aca3-c406f1c36d0e",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
"birthday": {
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
"login": "jdoe10@gmail.com",
"bo_user_uuid": null
},
"activity_sector": {
"name": "Agriculture"
},
"data": {
"type": "PARTICULAR",
"company_name": null,
"turnover": {
"name": "Less than 20k EUR"
},
"activity_age": null
},
"custom_reference": null,
"is_converted": false,
"conformity_status": "ACCEPTED",
"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
}
Autocomplete an enrollment
You can use this request to complete an enrollment faster. It allows you to send every needed informations in a single request.
This service allows you to complete an onboarding.
address[locality] string |
Name of the inhabited city Required: yes Validation: string |
address[nameLine1] string |
Street's name and number Required: yes Validation : string |
address[postalCode] string |
Postal code of the adress Required: yes Validation : string |
address[country] string |
Country of Residence Required: yes Validation : ISO 3166-1 alpha-3 |
identityDocument[type] string |
Identity document type Required: yes Validation : One of these values : - IDENTITY_CARD (2 documents required), - PASSPORT (1 document required), - RESIDENCE_PERMIT (2 documents required), - VISA (1 document required), - IDENTITY_DOCUMENT_RECEIPT (1 documents required)
|
identityDocument[documents][0] File |
Picture file of the document Required: yes Validation : Accepted format (JPG, JPEG or PNG) |
identityDocument[documents][1] File |
Picture file of the document Required: if identityDocument[type] is IDENTITY_CARD Validation : Accepted format (JPG, JPEG or PNG) |
identityDocument[checkId] String |
checkId from Onfido Required: no |
identityDocument[expiryDate] String |
Expiration date of the document Required: no Validation : YYYY-MM-DD format |
identityDocument[proofOfIdentityDocument] File |
Picture file of the document Required: if identityDocument[type] is IDENTITY_DOCUMENT_RECEIPT Validation : Accepted format (JPG, JPEG or PNG) |
identityDocument[proofOfIdentityDocuments][*] File |
Picture file of the documents Required: if identityDocument[type] is IDENTITY_DOCUMENT_RECEIPT Validation : Accepted format (JPG, JPEG or PNG) |
identityDocument[proofOfIdentityDocumentExpiryDate] String |
Expiration date of the proof identity document Required: if identityDocument[proofOfIdentityDocument] is present Validation : YYYY-MM-DD format |
identityDocument[documentNumber] String |
Reference number of the document Required: no Validation : String |
identityDocument[mrzLine1] String |
First line Required: no Validation : String |
identityDocument[mrzLine2] String |
Second line Required: no Validation : String |
identityDocument[issuingCountry] String |
The document issuing country Required: yes Validation : ISO 3166-1 alpha-3 |
identityDocument[checkId] String |
Determines whether enrollment will be automatically accepted Required: no Validation : String |
iban[value] String |
IBAN Required: no Validation : Valid IBAN |
bic[value] String |
BIC Required: no Validation : Valid BIC |
ibanDocument[document] File |
Picture of the bank details Required: no Validation : Accepted format (JPG, JPEG or PNG) |
metaData JSON File |
To pass more data Required: yes (can be empty) Validation : format : {"key":"value"} |
riskData[isPep] boolean |
Required: yes, false by default Validation : true or false |
riskData[isInSanctionList] boolean |
Required: yes, false by default Validation : true or false |
riskData[residentAlpha3Code] string |
Required: yes Validation : ISO 3166-1 alpha-3 |
riskData[isHighRiskResident] boolean |
Required: yes Validation : true or false |
riskData[nationalityAlpha3Code] string |
Required: yes Validation : ISO 3166-1 alpha-3 |
riskData[isHighRiskNationality] boolean |
Required: yes Validation : true or false |
riskData[isHighRiskMCCActivitySector] boolean |
Required: yes Validation : true or false |
riskData[MCCActivitySector] integer |
Required: yes Validation : existing Merchant Category Code |
riskData[monthlyLimit] integer |
Required: yes Validation : in [0;190000] in cents |
riskData[monthlyLimitCurrencyAlphabeticCode] String |
Currency of the monthly limit Required: yes Validation : existing currency code |
riskData[isCrossBorderPayment] Boolean |
is a crossborder payment Required: no, true by default Validation : true or false |
riskData[declaredMonthlyRevenue] integer |
Declared Monthly Revenue Required: no Validation : in [0;190000] |
riskData[verifiedMonthlyRevenue] integer |
verified Monthly Revenue Required: yes if full KYC Validation : in [0;190000] in cents |
complementaryIdentityDocument[documents][0] File |
To pass an additional identity document Required: deprecated Validation : Accepted format (JPG, JPEG or PNG) |
complementaryIdentityDocument[expiryDate] String |
Expiration date of the document Required: no Validation : YYYY-MM-DD format |
complementaryIdentityDocument[documentNumber] String |
Reference number of the document Required: no Validation : String |
complementaryIdentityDocument[mrzLine1] String |
First line Required: no Validation : String |
complementaryIdentityDocument[mrzLine2] String |
Second line Required: no Validation : String |
complementaryIdentityDocument[issuingCountry] String |
The document issuing country Required: no Validation : ISO 3166-1 alpha-3 |
proofOfAddressDocument[documents][0] File |
To pass the proof of address document Required: if HIGH risk class Validation : Accepted format (JPG, JPEG or PNG) |
incomeDocument[document] File |
To pass the income document (only one document) Required: if full KYC required Validation : Accepted format (JPG, JPEG or PNG) |
incomeDocument[documents][*] File |
To pass the income documents (multiple documents at once) Required: if full KYC required Validation : Accepted format (JPG, JPEG or PNG) |
additionalDocuments[X]['type'] document file type |
The document file type Validation: Valid values (UBO_DECLARATION, PROOF_OF_OWNERSHIP, CERTIFICATE_OF_REGISTRATION, BANK_ACCOUNT_IDENTIFICATION, CERTIFICATE_OF_GOOD_STANDING, CC_TRANSACTION_HISTORY, SUPPLIER_DOCUMENT, LICENSING_AGREEMENT, MODEL_CONTENT_LICENCE, MODEL_PASSPORT, SOFTWARE_LICENCE, AUDITED_FINANCIAL_REPORT, PROOF_OF_VAT_REGISTRATION, CONTRACTUAL_AMENDMENTS, EFFECTIVE_BENEFICIARY_PASSPORT, PROOF_ADDRESS_LEGAL_REPRESENTATIVE, PROOF_ADDRESS_EFFECTIVE_BENEFICIARY, PROCURATION_LEGAL_REPRESENTATIVE, UPDATED_STATUSES, CERTIFIED_STATUSES, PV_GENERAL_ASSEMBLY, REGISTRY_CERTIFICATE_LEGAL_PERSON_SHAREHOLDER, SHAREHOLDER_STATUSES, JUSTIFICATION_LETTER, CERTIFICATE_TAX_RESIDENCE, SHAREHOLDERS_REGISTRY, SHARE_CERTIFICATE, GOOD_STANDING_CERTIFICATE, PROOF_COMPANY_ADDRESS, PROOF_MODIFICATION_REGISTERED_OFFICE, PROOF_DOMAIN_NAME_OWNERSHIP, OTHER, IDENTITY_DOCUMENT_RECEIPT, RESIDENCE_PERMIT) |
additionalDocuments[X]['documents'][X] file |
The document picture file Required: if needed for a monthly limit lift Validation: Valid formats (JPG, JPEG or PNG) |
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/3fb02825-bcd5-45b8-97c4-e7c349783194/autocomplete
curl --location 'https://test-onboarding-api.centralpay.net/api/merchant-enrollment/3fb02825-bcd5-45b8-97c4-e7c349783194/autocomplete' \
--header 'Browser-User-Agent: edo-test-user-agent' \
--header 'Browser-IP: 8.8.8.8' \
--header 'Authorization: Basic ZG9jdGVzdF9hdXRyZW1hcmNoYW5kOjRJOUhKUlRk' \
--header 'Cookie: PHPSESSID=30lgom2f5tra5apage0qijuv3d' \
--form 'address[locality]="Tours"' \
--form 'address[nameLine1]="Rue du bois"' \
--form 'address[postalCode]="37000"' \
--form 'address[country]="FRA"' \
--form 'identityDocument[type]="VISA"' \
--form 'identityDocument[documents][0]=@"/home/jdoe/Documents/image.png"' \
--form 'identityDocument[expiryDate]="1984-12-21"' \
--form 'identityDocument[documentNumber]="123456789"' \
--form 'identityDocument[mrzLine1]=">>>123456789abc"' \
--form 'identityDocument[mrzLine2]=">>>123456789abc"' \
--form 'identityDocument[issuingCountry]="FRA"' \
--form 'iban[value]="FR7612548029980000000150086"' \
--form 'bic[value]="AXABFRPP"' \
--form 'ibanDocument[document]=@"/home/jdoe/Documents/image.png"' \
--form 'metaData="'\''{\"action\":\"réaction\"}'\''"' \
--form 'riskData[isPep]="false"' \
--form 'riskData[isInSanctionList]="false"' \
--form 'riskData[residentAlpha3Code]="FRA"' \
--form 'riskData[isHighRiskResident]="false"' \
--form 'riskData[nationalityAlpha3Code]="FRA"' \
--form 'riskData[isHighRiskNationality]="false"' \
--form 'riskData[isHighRiskMCCActivitySector]="false"' \
--form 'riskData[MCCActivitySector]="7011"' \
--form 'riskData[monthlyLimit]="100000"' \
--form 'riskData[monthlyLimitCurrencyAlphabeticCode]="GTH"' \
--form 'complementaryIdentityDocument[documents][0]=@"/home/jdoe/Documents/image.png"' \
--form 'complementaryIdentityDocument[documents][1]=@"/home/jdoe/Documents/image.png"' \
--form 'complementaryIdentityDocument[documents][2]=@"/home/jdoe/Documents/image.png"' \
--form 'incomeDocument[document]=@"/home/jdoe/Documents/image.png"'
{
"workflow": {
"uuid": "9cc21050-7142-4e9b-b442-07a10609431c",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "13875b60-f70c-4b99-b65a-df2a00976569",
"element-type": "contract-validation"
}
],
"uuid": "2ead765c-7e05-47b1-aa84-7b9c4e417fe0",
"name": "ContractValiA",
"state": "OK",
"category": "validation",
"created_at": "2023-05-16T09:27:21"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "54f1250c-f665-4b0e-951f-3f5c0aea72a9",
"reference": null,
"review_url": null,
"status_call": null,
"element-type": "sanction-check"
}
],
"uuid": "0dad7211-f823-4eb7-b365-dd5d6df5885b",
"name": "checkSanctionListA",
"state": "OK",
"category": null,
"created_at": "2023-05-16T09:28:39"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "d482ff6e-a24a-4e21-b413-91adf62246a6",
"type": "UNLOCK_PAYOUT_LIMITS",
"tag": "YES",
"element-type": "question"
}
],
"uuid": "ae1129d3-7a12-4caf-98fe-b5380d843505",
"name": "QuestionLvl1A",
"state": "OK",
"category": "validation",
"created_at": "2023-05-16T09:28:39"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "2e4d4288-9f27-4d72-b0fe-059b13353ee2",
"documents": [
{
"file_check": null
},
{
"file_check": null
},
{
"file_check": null
}
],
"expiry_date": null,
"document_number": null,
"mrz_line1": null,
"mrz_line2": null,
"issuing_country": null,
"element-type": "complementary-identity-document"
}
],
"uuid": "2332e321-804e-4832-a446-21674deeeaef",
"name": "compIdentityA",
"state": "OK",
"category": "identity",
"created_at": "2023-05-16T09:28:39"
},
{
"step_elements": [],
"uuid": "c8337caa-8ebe-499d-bd06-e4b74c8bf0a1",
"name": "QuestionLvl2A",
"state": "TODO",
"category": "validation",
"created_at": "2023-05-16T09:28:39"
}
],
"additional_documents": []
},
"identity_badge": null,
"representatives_list": null,
"infogreffe_identity": null,
"language": "fr",
"risk_score": {
"activity": 2,
"activity_age": null,
"turnover": 1,
"bank_account": 0,
"total": 7
},
"uuid": "3fb02825-bcd5-45b8-97c4-e7c349783194",
"risk_points": 7,
"created_at": "2023-05-16T09:27:21",
"last_updated_at": "2023-05-16T09:28:39",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": "MEDIUM",
"type": "INDIVIDUAL",
"is_canceled": false,
"enrollment_account": {
"login": "jdoe10@gmail.com"
},
"profile": {
"uuid": "7509b84f-0a1f-4f4e-97a1-ae879374e6a7",
"workflow": {
"uuid": "97967c48-5ef8-4640-9cbe-a852e031e39d",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "812bf047-6c71-4b46-b137-4aff31709ae4",
"country": "FRA",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "ec5ae939-7385-42ac-9f86-b1f7c7773c65",
"value": "Tours",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "ec5ae939-7385-42ac-9f86-b1f7c7773c65",
"value": "Tours",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "812bf047-6c71-4b46-b137-4aff31709ae4",
"country": "FRA",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "c4f845c7-44d8-48b4-bcf7-aee9f5cce365",
"documents": [
{
"file_check": null
}
],
"type": "VISA",
"expiry_date": "1984-12-21T00:00:00",
"document_number": "123456789",
"mrz_line1": ">>>123456789abc",
"mrz_line2": ">>>123456789abc",
"issuing_country": {
"country": "FRA"
},
"element-type": "identity-document"
},
{
"status": "COMPLETED",
"uuid": "35ffd5e6-4a78-43d3-b436-b5ce3ad3355e",
"name_line1": "Rue du bois",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Tours",
"postal_code": "37000",
"country": "FRA",
"element-type": "address"
}
],
"uuid": "7b8e1e39-4965-44f5-9129-8579ae46e5ef",
"name": "identityInfos",
"state": "OK",
"category": "identity",
"created_at": "2023-05-16T09:27:21"
},
{
"step_elements": [],
"uuid": "9da5b6b0-0eb1-4f56-bc31-9c9e2d4ee824",
"name": "finished",
"state": "OK",
"category": null,
"created_at": "2023-05-16T09:28:38"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
"usename": null,
"email": {
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "8e1755e4-10d3-43d6-aca3-c406f1c36d0e",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
"birthday": {
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
"login": "jdoe10@gmail.com",
"bo_user_uuid": null
},
"activity_sector": {
"name": "Agriculture"
},
"data": {
"type": "PARTICULAR",
"company_name": null,
"turnover": {
"name": "Less than 20k EUR"
},
"activity_age": null
},
"custom_reference": null,
"is_converted": false,
"conformity_status": "ACCEPTED",
"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
}
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/3fb02825-bcd5-45b8-97c4-e7c349783194/autoupdate
curl --location 'https://test-onboarding-api.centralpay.net/api/merchant-enrollment/3fb02825-bcd5-45b8-97c4-e7c349783194/autoupdate' \
--header 'Browser-User-Agent: edo-test-user-agent' \
--header 'Browser-IP: 8.8.8.8' \
--header 'Authorization: Basic ZG9jdGVzdF9hdXRyZW1hcmNoYW5kOjRJOUhKUlRk' \
--header 'Cookie: PHPSESSID=veb4gspq71hnqv9gu3h5kjr75j' \
--form 'identityDocument[type]="VISA"' \
--form 'identityDocument[documents][0]=@"/home/jdoe/Documents/image.png"'
{
"workflow": {
"uuid": "9cc21050-7142-4e9b-b442-07a10609431c",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "13875b60-f70c-4b99-b65a-df2a00976569",
"element-type": "contract-validation"
}
],
"uuid": "2ead765c-7e05-47b1-aa84-7b9c4e417fe0",
"name": "ContractValiA",
"state": "OK",
"category": "validation",
"created_at": "2023-05-16T09:27:21"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "54f1250c-f665-4b0e-951f-3f5c0aea72a9",
"reference": null,
"review_url": null,
"status_call": null,
"element-type": "sanction-check"
}
],
"uuid": "0dad7211-f823-4eb7-b365-dd5d6df5885b",
"name": "checkSanctionListA",
"state": "OK",
"category": null,
"created_at": "2023-05-16T09:28:39"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "d482ff6e-a24a-4e21-b413-91adf62246a6",
"type": "UNLOCK_PAYOUT_LIMITS",
"tag": "YES",
"element-type": "question"
}
],
"uuid": "ae1129d3-7a12-4caf-98fe-b5380d843505",
"name": "QuestionLvl1A",
"state": "OK",
"category": "validation",
"created_at": "2023-05-16T09:28:39"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "2e4d4288-9f27-4d72-b0fe-059b13353ee2",
"documents": [
{
"file_check": null
},
{
"file_check": null
},
{
"file_check": null
}
],
"expiry_date": "2023-06-01T00:00:00",
"document_number": null,
"mrz_line1": null,
"mrz_line2": null,
"issuing_country": null,
"element-type": "complementary-identity-document"
}
],
"uuid": "2332e321-804e-4832-a446-21674deeeaef",
"name": "compIdentityA",
"state": "OK",
"category": "identity",
"created_at": "2023-05-16T09:28:39"
},
{
"step_elements": [],
"uuid": "c8337caa-8ebe-499d-bd06-e4b74c8bf0a1",
"name": "QuestionLvl2A",
"state": "TODO",
"category": "validation",
"created_at": "2023-05-16T09:28:39"
}
],
"additional_documents": []
},
"identity_badge": null,
"representatives_list": null,
"infogreffe_identity": null,
"language": "fr",
"risk_score": {
"residentCountry": 1,
"nationalityCountry": 0,
"pep": 0,
"sanction": 0,
"activity": 3,
"monthlyLimit": 3,
"total": 7,
"metadata": "'{\"action\":\"réaction\"}'"
},
"uuid": "3fb02825-bcd5-45b8-97c4-e7c349783194",
"risk_points": 7,
"created_at": "2023-05-16T09:27:21",
"last_updated_at": "2023-05-16T09:57:17",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": "MEDIUM",
"type": "INDIVIDUAL",
"is_canceled": false,
"enrollment_account": {
"login": "jdoe10@gmail.com"
},
"profile": {
"uuid": "7509b84f-0a1f-4f4e-97a1-ae879374e6a7",
"workflow": {
"uuid": "97967c48-5ef8-4640-9cbe-a852e031e39d",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "35ffd5e6-4a78-43d3-b436-b5ce3ad3355e",
"name_line1": "Rue du bois",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Tours",
"postal_code": "37000",
"country": "FRA",
"element-type": "address"
},
{
"status": "COMPLETED",
"uuid": "812bf047-6c71-4b46-b137-4aff31709ae4",
"country": "FRA",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "ec5ae939-7385-42ac-9f86-b1f7c7773c65",
"value": "Tours",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "ec5ae939-7385-42ac-9f86-b1f7c7773c65",
"value": "Tours",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "812bf047-6c71-4b46-b137-4aff31709ae4",
"country": "FRA",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "1cacf4ad-b432-4aed-bdbd-34e85ca3b6d8",
"documents": [
{
"file_check": null
}
],
"type": "VISA",
"expiry_date": null,
"document_number": null,
"mrz_line1": null,
"mrz_line2": null,
"issuing_country": null,
"element-type": "identity-document"
},
{
"status": "COMPLETED",
"uuid": "35ffd5e6-4a78-43d3-b436-b5ce3ad3355e",
"name_line1": "Rue du bois",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Tours",
"postal_code": "37000",
"country": "FRA",
"element-type": "address"
}
],
"uuid": "7b8e1e39-4965-44f5-9129-8579ae46e5ef",
"name": "identityInfos",
"state": "OK",
"category": "identity",
"created_at": "2023-05-16T09:27:21"
},
{
"step_elements": [],
"uuid": "9da5b6b0-0eb1-4f56-bc31-9c9e2d4ee824",
"name": "finished",
"state": "OK",
"category": null,
"created_at": "2023-05-16T09:28:38"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
"usename": null,
"email": {
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "8e1755e4-10d3-43d6-aca3-c406f1c36d0e",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
"birthday": {
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
"login": "jdoe10@gmail.com",
"bo_user_uuid": "b2e8e66d-3923-4c0c-b8a5-d94ee17568dd"
},
"activity_sector": {
"name": "Agriculture"
},
"data": {
"type": "PARTICULAR",
"company_name": null,
"turnover": {
"name": "Less than 20k EUR"
},
"activity_age": null
},
"custom_reference": null,
"is_converted": true,
"conformity_status": "ACCEPTED",
"conformity_status_level_two": null,
"comments_level_two": "<p>pas ouf</p>",
"validator_level_one": null,
"validator_level_two": "e4746de9-ad13-4473-a6b4-89607540f9df",
"merchant_uuid": "9b34b9b8-fde1-460b-8d96-dac345642bc6",
"validation_date": null,
"validation_date_level_two": "2023-05-16T09:54:17",
"sub_type": null,
"api_infogreffe_attempt": 0,
"next_step": 0
}
Autoupdate an enrollment
You can use this request to send new identity document files when the previous ones were denied by the conformity service.
In this example the VISA has been denied and must be resent.
This service allows you to send the denied document.
identityDocument[type] string |
Document type Required: yes Validation: The denied document type:- IDENTITY_CARD (2 documents required), - PASSPORT (1 document required), - RESIDENCE_PERMIT (2 documents required), - VISA (1 document required), - IDENTITY_DOCUMENT_RECEIPT (1 documents required) |
identityDocument[documents][0] file |
The document picture file Required: yes Validation: Valid formats (JPG, JPEG or PNG) |
identityDocument[documents][1] file |
The document picture file Required: if identityDocument[type] is IDENTITY_CARD Validation: Valid formats (JPG, JPEG or PNG) |
identityDocument[issuingCountry] String |
The document issuing country Required: yes if a document is sent Validation : ISO 3166-1 alpha-3 |
complementaryIdentityDocument[documents][0] file |
The document picture file Required: if required by our conformity service Validation: Valid formats (JPG, JPEG or PNG) |
complementaryIdentityDocument[expiryDate] String |
Expiration date of the document Required: yes Validation : YYYY-MM-DD format |
complementaryIdentityDocument[documentNumber] String |
Reference number of the document Required: yes Validation : String |
complementaryIdentityDocument[mrzLine1] String |
First line Required: yes Validation : String |
complementaryIdentityDocument[mrzLine2] String |
Second line Required: yes Validation : String |
complementaryIdentityDocument[issuingCountry] String |
The document issuing country Required: yes Validation : ISO 3166-1 alpha-3 |
incomeDocument[document] file |
The document picture file (only one document) Required: if required by our conformity service Validation: Valid formats (JPG, JPEG or PNG) |
incomeDocument[documents][*] file |
The document picture file, replace the * with 0 for your first document, with 1 for the second, etc Required: if required by our conformity service Validation: Valid formats (JPG, JPEG or PNG) |
fullKyc boolean |
if false is sent enrollment will be simple KYC Required: no Validation : true or false |
profile[firstname][value] String |
firstname Required: no |
profile[lastname][value] String |
lastname Required: no |
profile[birthday][value] String |
Birthday date Required: no |
profile[place_of_birth][value] String |
Place of birth Required: no |
profile[country_of_birth][country] String |
country of birth - alphaThreecode Required: no |
profile[address][nameLine1] String |
address nameLine, required for address array Required: no |
profile[address][postalCode] String |
address postalCode, required for address array Required: no |
profile[address][country] String |
address country, required for address array Required: no |
profile[address][locality] String |
address locality - alphaThreecode, required for address array Required: no |
riskData[isPep] boolean |
Required: yes, false by default Validation : true or false |
riskData[isInSanctionList] boolean |
Required: yes, false by default Validation : true or false |
riskData[residentAlpha3Code] string |
Required: yes Validation : ISO 3166-1 alpha-3 |
riskData[isHighRiskResident] boolean |
Required: yes Validation : true or false |
riskData[nationalityAlpha3Code] string |
Required: yes Validation : ISO 3166-1 alpha-3 |
riskData[isHighRiskNationality] boolean |
Required: yes Validation : true or false |
riskData[isHighRiskMCCActivitySector] boolean |
Required: yes Validation : true or false |
riskData[MCCActivitySector] integer |
Required: yes Validation : existing Merchant Category Code |
riskData[monthlyLimit] integer |
Required: yes Validation : in [0;190000] in cents |
riskData[monthlyLimitCurrencyAlphabeticCode] String |
Currency of the monthly limit Required: yes Validation : existing currency code |
riskData[isCrossBorderPayment] Boolean |
is a crossborder payment Required: no, true by default Validation : true or false |
riskData[declaredMonthlyRevenue] integer |
Declared Monthly Revenue Required: no Validation : in [0;190000] |
riskData[verifiedMonthlyRevenue] integer |
verified Monthly Revenue Required: yes if full KYC Validation : in [0;190000] in cents |
additionalDocuments[X]['type'] document file type |
The document file type Validation: Valid values (UBO_DECLARATION, PROOF_OF_OWNERSHIP, CERTIFICATE_OF_REGISTRATION, BANK_ACCOUNT_IDENTIFICATION, CERTIFICATE_OF_GOOD_STANDING, CC_TRANSACTION_HISTORY, SUPPLIER_DOCUMENT, LICENSING_AGREEMENT, MODEL_CONTENT_LICENCE, MODEL_PASSPORT, SOFTWARE_LICENCE, AUDITED_FINANCIAL_REPORT, PROOF_OF_VAT_REGISTRATION, CONTRACTUAL_AMENDMENTS, EFFECTIVE_BENEFICIARY_PASSPORT, PROOF_ADDRESS_LEGAL_REPRESENTATIVE, PROOF_ADDRESS_EFFECTIVE_BENEFICIARY, PROCURATION_LEGAL_REPRESENTATIVE, UPDATED_STATUSES, CERTIFIED_STATUSES, PV_GENERAL_ASSEMBLY, REGISTRY_CERTIFICATE_LEGAL_PERSON_SHAREHOLDER, SHAREHOLDER_STATUSES, JUSTIFICATION_LETTER, CERTIFICATE_TAX_RESIDENCE, SHAREHOLDERS_REGISTRY, SHARE_CERTIFICATE, GOOD_STANDING_CERTIFICATE, PROOF_COMPANY_ADDRESS, PROOF_MODIFICATION_REGISTERED_OFFICE, PROOF_DOMAIN_NAME_OWNERSHIP, OTHER, IDENTITY_DOCUMENT_RECEIPT, RESIDENCE_PERMIT) |
additionalDocuments[X]['documents'][X] file |
The document picture file Required: if needed for a monthly limit lift Validation: Valid formats (JPG, JPEG or PNG) |
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/3fb02825-bcd5-45b8-97c4-e7c349783194/autoupdate
curl --location 'https://test-onboarding-api.centralpay.net/api/merchant-enrollment/3fb02825-bcd5-45b8-97c4-e7c349783194/autoupdate' \
--header 'Browser-User-Agent: edo-test-user-agent' \
--header 'Browser-IP: 8.8.8.8' \
--header 'Authorization: Basic ZG9jdGVzdF9hdXRyZW1hcmNoYW5kOjRJOUhKUlRk' \
--header 'Cookie: PHPSESSID=veb4gspq71hnqv9gu3h5kjr75j' \
--form 'identityDocument[type]="VISA"' \
--form 'identityDocument[documents][0]=@"/home/jdoe/Documents/image.png"'
{
"workflow": {
"uuid": "9cc21050-7142-4e9b-b442-07a10609431c",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "13875b60-f70c-4b99-b65a-df2a00976569",
"element-type": "contract-validation"
}
],
"uuid": "2ead765c-7e05-47b1-aa84-7b9c4e417fe0",
"name": "ContractValiA",
"state": "OK",
"category": "validation",
"created_at": "2023-05-16T09:27:21"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "54f1250c-f665-4b0e-951f-3f5c0aea72a9",
"reference": null,
"review_url": null,
"status_call": null,
"element-type": "sanction-check"
}
],
"uuid": "0dad7211-f823-4eb7-b365-dd5d6df5885b",
"name": "checkSanctionListA",
"state": "OK",
"category": null,
"created_at": "2023-05-16T09:28:39"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "d482ff6e-a24a-4e21-b413-91adf62246a6",
"type": "UNLOCK_PAYOUT_LIMITS",
"tag": "YES",
"element-type": "question"
}
],
"uuid": "ae1129d3-7a12-4caf-98fe-b5380d843505",
"name": "QuestionLvl1A",
"state": "OK",
"category": "validation",
"created_at": "2023-05-16T09:28:39"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "2e4d4288-9f27-4d72-b0fe-059b13353ee2",
"documents": [
{
"file_check": null
},
{
"file_check": null
},
{
"file_check": null
}
],
"expiry_date": "2023-06-01T00:00:00",
"document_number": null,
"mrz_line1": null,
"mrz_line2": null,
"issuing_country": null,
"element-type": "complementary-identity-document"
}
],
"uuid": "2332e321-804e-4832-a446-21674deeeaef",
"name": "compIdentityA",
"state": "OK",
"category": "identity",
"created_at": "2023-05-16T09:28:39"
},
{
"step_elements": [],
"uuid": "c8337caa-8ebe-499d-bd06-e4b74c8bf0a1",
"name": "QuestionLvl2A",
"state": "TODO",
"category": "validation",
"created_at": "2023-05-16T09:28:39"
}
],
"additional_documents": []
},
"identity_badge": null,
"representatives_list": null,
"infogreffe_identity": null,
"language": "fr",
"risk_score": {
"residentCountry": 1,
"nationalityCountry": 0,
"pep": 0,
"sanction": 0,
"activity": 3,
"monthlyLimit": 3,
"total": 7,
"metadata": "'{\"action\":\"réaction\"}'"
},
"uuid": "3fb02825-bcd5-45b8-97c4-e7c349783194",
"risk_points": 7,
"created_at": "2023-05-16T09:27:21",
"last_updated_at": "2023-05-16T09:57:17",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": "MEDIUM",
"type": "INDIVIDUAL",
"is_canceled": false,
"enrollment_account": {
"login": "jdoe10@gmail.com"
},
"profile": {
"uuid": "7509b84f-0a1f-4f4e-97a1-ae879374e6a7",
"workflow": {
"uuid": "97967c48-5ef8-4640-9cbe-a852e031e39d",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "35ffd5e6-4a78-43d3-b436-b5ce3ad3355e",
"name_line1": "Rue du bois",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Tours",
"postal_code": "37000",
"country": "FRA",
"element-type": "address"
},
{
"status": "COMPLETED",
"uuid": "812bf047-6c71-4b46-b137-4aff31709ae4",
"country": "FRA",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "ec5ae939-7385-42ac-9f86-b1f7c7773c65",
"value": "Tours",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "ec5ae939-7385-42ac-9f86-b1f7c7773c65",
"value": "Tours",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "812bf047-6c71-4b46-b137-4aff31709ae4",
"country": "FRA",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "1cacf4ad-b432-4aed-bdbd-34e85ca3b6d8",
"documents": [
{
"file_check": null
}
],
"type": "VISA",
"expiry_date": null,
"document_number": null,
"mrz_line1": null,
"mrz_line2": null,
"issuing_country": null,
"element-type": "identity-document"
},
{
"status": "COMPLETED",
"uuid": "35ffd5e6-4a78-43d3-b436-b5ce3ad3355e",
"name_line1": "Rue du bois",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Tours",
"postal_code": "37000",
"country": "FRA",
"element-type": "address"
}
],
"uuid": "7b8e1e39-4965-44f5-9129-8579ae46e5ef",
"name": "identityInfos",
"state": "OK",
"category": "identity",
"created_at": "2023-05-16T09:27:21"
},
{
"step_elements": [],
"uuid": "9da5b6b0-0eb1-4f56-bc31-9c9e2d4ee824",
"name": "finished",
"state": "OK",
"category": null,
"created_at": "2023-05-16T09:28:38"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "056123f8-b629-4e55-a070-4de07982c025",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "8fa357a9-0dff-4a34-9cdd-78ea99354511",
"value": "Doe",
"element-type": "lastname"
},
"usename": null,
"email": {
"status": "COMPLETED",
"uuid": "5f79f55b-ca8d-4cd8-9756-f689038de777",
"value": "jdoe10@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "8e1755e4-10d3-43d6-aca3-c406f1c36d0e",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "38209003-697f-4bf2-a4ff-865f4b3f3e0e",
"value": "+33678910112",
"element-type": "phone"
},
"birthday": {
"status": "COMPLETED",
"uuid": "62608a84-12e2-4329-b581-44ed7d71cb86",
"value": "1984-12-21T00:00:00",
"element-type": "birthday"
},
"login": "jdoe10@gmail.com",
"bo_user_uuid": "b2e8e66d-3923-4c0c-b8a5-d94ee17568dd"
},
"activity_sector": {
"name": "Agriculture"
},
"data": {
"type": "PARTICULAR",
"company_name": null,
"turnover": {
"name": "Less than 20k EUR"
},
"activity_age": null
},
"custom_reference": null,
"is_converted": true,
"conformity_status": "ACCEPTED",
"conformity_status_level_two": null,
"comments_level_two": "<p>pas ouf</p>",
"validator_level_one": null,
"validator_level_two": "e4746de9-ad13-4473-a6b4-89607540f9df",
"merchant_uuid": "9b34b9b8-fde1-460b-8d96-dac345642bc6",
"validation_date": null,
"validation_date_level_two": "2023-05-16T09:54:17",
"sub_type": null,
"api_infogreffe_attempt": 0,
"next_step": 0
}
GET https://test-onboarding.centralpay.net/api/merchant-enrollment/<enrolmentId>
curl -v -X GET https://test-onboarding.centralpay.net/api/merchant-enrollment/2a0638ab-395f-4bd1-82ef-e33f0a9fb80f \
-u 'doctest:4I9HJRTd'
{
"workflow": {
"uuid": "26f5a70e-c421-4414-aa34-3487666012e8",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "a7504a2b-d2a9-4102-9fbc-d6b871aa0f7e",
"created_at": "2024-03-26T12:25:56",
"cgu_uuid": "73ca4c77-8c5f-49d5-b31e-afdb5d90a6b5",
"security_uuid": null,
"fee_schedule_uuid": "9e4697cb-29e8-4a9f-b464-d84ec71eee06",
"element-type": "contract-validation"
}
],
"uuid": "7c21f21c-6812-4e7c-899e-d76cc9b0ead8",
"name": "ContractValiA",
"state": "OK",
"category": "validation",
"created_at": "2024-03-26T12:25:54"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "c56ac6ef-ef9b-4a0c-8afc-4629cc8b00b1",
"created_at": "2024-03-26T12:25:56",
"reference": null,
"review_url": null,
"status_call": null,
"element-type": "sanction-check"
}
],
"uuid": "ff3d14e5-7d13-49ce-8f42-2c32f03f02cb",
"name": "checkSanctionListA",
"state": "OK",
"category": null,
"created_at": "2024-03-26T12:25:56"
},
{
"step_elements": [],
"uuid": "c9fa66ae-5483-4c22-bbf4-ffb95e1cabd4",
"name": "QuestionLvl1A",
"state": "TODO",
"category": "validation",
"created_at": "2024-03-26T12:25:56"
}
],
"additional_documents": []
},
"identity_badge": null,
"representatives_list": null,
"inactive_representatives_list": [],
"infogreffe_identity": null,
"language": "fr",
"risk_score": {
"residentCountry": 0,
"nationalityCountry": 1,
"pep": 0,
"sanction": 0,
"activity": 1,
"crossBorderPayment": 2,
"total": 4,
"metadata": "{\"risk_score\":4,\"annual_revenue\":300000,\"onfido\":[{\"status\":\"complete\",\"result\":\"consider\",\"report_document_result\":\"consider\",\"report_document_sub_result\":\"rejected\",\"report_facial_similarity_photo_result\":\"consider\",\"report_watchlist_enchanced_result\":\"clear\"}]}"
},
"monthly_turnover": 90000,
"monthly_turnover_currency": "EUR",
"merchant_enrollment_autocompleted": {
"annual_turnover": 900000,
"monthly_turnover": 90000,
"uuid": "f3ba686f-12ab-4cd5-a3f4-445a3e793a0b",
"created_at": "2024-03-26T12:25:55",
"metadata": "{\"risk_score\":4,\"annual_revenue\":300000,\"onfido\":[{\"status\":\"complete\",\"result\":\"consider\",\"report_document_result\":\"consider\",\"report_document_sub_result\":\"rejected\",\"report_facial_similarity_photo_result\":\"consider\",\"report_watchlist_enchanced_result\":\"clear\"}]}",
"additional_documents": [],
"declared_monthly_revenue": null,
"verified_monthly_revenue": null
},
"api_infogreffe_identity": null,
"kyc_update": null,
"additional_document_need_upload": false,
"uuid": "2a0638ab-395f-4bd1-82ef-e33f0a9fb80f",
"risk_points": 4,
"created_at": "2024-03-26T12:25:53",
"last_updated_at": "2024-03-26T12:25:56",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": "LOW",
"actor_initiator": "3ad4b016-26a3-470a-afe4-cfcc802ca6ae",
"type": "INDIVIDUAL",
"is_canceled": false,
"enrollment_account": {
"login": "jd@testthree.com"
},
"profile": {
"birthname": {
"status": "ON_GOING",
"uuid": "50d59fa6-3d2a-4855-bb61-95eecf248a84",
"created_at": "2024-03-26T12:25:53",
"value": null,
"element-type": "birthname"
},
"uuid": "b07c16cf-d568-4376-a300-be59742d82f2",
"workflow": {
"uuid": "71af8de9-eae5-4166-8c26-00cd5f1751bf",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "97db6843-9de1-4899-a6b2-ab492cd5f3d0",
"created_at": "2024-03-26T12:25:53",
"country": "ESP",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "2b697073-4f1b-4e08-b741-1707ca82b386",
"created_at": "2024-03-26T12:25:53",
"value": "1990-01-01T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "53757508-5546-41b3-aeca-fa515122bdd5",
"created_at": "2024-03-26T12:25:53",
"value": "jd@testthree.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "e99f72f2-1ce8-4b5d-9830-6f93f288fd06",
"created_at": "2024-03-26T12:25:53",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "8d7c979b-3e22-427d-8e80-70aee2e8895b",
"created_at": "2024-03-26T12:25:53",
"value": "+34623254961",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "f6743f5f-6f71-4f9f-8c4d-8e5e108b4de8",
"created_at": "2024-03-26T12:25:55",
"name_line1": "1 Calle Marqués de Larios",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Málaga",
"postal_code": "29015",
"country": "ESP",
"element-type": "address"
},
{
"status": "COMPLETED",
"uuid": "1c6cf84b-3038-4c2c-989b-94cb4c1b0cbd",
"created_at": "2024-03-26T12:25:53",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "0334b321-9e6b-4ec0-a9cd-9bbb53302bee",
"created_at": "2024-03-26T12:25:53",
"value": "Madrid",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "c59af4d0-0136-4a4b-a67d-dcbe95c1a738",
"created_at": "2024-03-26T12:25:55",
"documents": [
{
"file_check": [],
"uuid": "10c88b4c-1aa0-4d57-a16d-d451b1453f48",
"mime_type": "image/jpeg"
}
],
"type": "PASSPORT",
"proof_of_identity_document": null,
"expiry_date": null,
"document_number": null,
"mrz_line1": null,
"mrz_line2": null,
"issuing_country": {
"country": "FRA"
},
"element-type": "identity-document"
}
],
"uuid": "f24c1af7-ece1-4a91-b586-d7b5aa8e9097",
"name": "identityInfos",
"state": "OK",
"category": "identity",
"created_at": "2024-03-26T12:25:53"
},
{
"step_elements": [],
"uuid": "128c27fd-02f4-46f0-8ac6-3720d0992d02",
"name": "finished",
"state": "OK",
"category": null,
"created_at": "2024-03-26T12:25:55"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "e99f72f2-1ce8-4b5d-9830-6f93f288fd06",
"created_at": "2024-03-26T12:25:53",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "1c6cf84b-3038-4c2c-989b-94cb4c1b0cbd",
"created_at": "2024-03-26T12:25:53",
"value": "Doe",
"element-type": "lastname"
},
"usename": {
"status": "ON_GOING",
"uuid": "50d59fa6-3d2a-4855-bb61-95eecf248a84",
"created_at": "2024-03-26T12:25:53",
"value": null,
"element-type": "birthname"
},
"email": {
"status": "COMPLETED",
"uuid": "53757508-5546-41b3-aeca-fa515122bdd5",
"created_at": "2024-03-26T12:25:53",
"value": "jd@testthree.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "ac82839b-f950-41f4-91b9-0f63c5e4ded5",
"created_at": "2024-03-26T12:25:53",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "8d7c979b-3e22-427d-8e80-70aee2e8895b",
"created_at": "2024-03-26T12:25:53",
"value": "+34623254961",
"element-type": "phone"
},
"birthday": {
"status": "COMPLETED",
"uuid": "2b697073-4f1b-4e08-b741-1707ca82b386",
"created_at": "2024-03-26T12:25:53",
"value": "1990-01-01T00:00:00",
"element-type": "birthday"
},
"login": "jd@testthree.com",
"bo_user_uuid": "f237259b-9734-4dce-be59-404eda367a0b"
},
"activity_sector": {
"uuid": "2fce29f9-4a9c-4d68-9c08-f56cb972d7e9",
"name": "Transport and logistics"
},
"data": {
"type": "PARTICULAR",
"company_name": null,
"history": [],
"turnover": {
"uuid": "aed57921-81d8-4f22-8b13-b2f150503800",
"name": "Less than 20k EUR"
},
"activity_age": null
},
"custom_reference": null,
"is_converted": true,
"conformity_status": "ACCEPTED",
"conformity_status_level_two": null,
"validator_level_one": "1d783cc9-a6dd-4b72-8d4a-5582d0b3a1bd",
"validator_level_two": null,
"merchant_uuid": "aea0540a-bb25-4367-b7e0-7880aed1bd89",
"validation_date": null,
"validation_date_level_two": null,
"sub_type": null,
"api_infogreffe_attempt": 0,
"next_step": 0,
"merchant_enrollment_additional": [],
"full_kyc": false,
"auto_updated_data": false
}
Retrieve an enrollment
This function allows you to retrieve an enrolment with the enrolment ID.
enrolmentId UUID (36) |
CentralPay ID of the enrolment Required: yes Validation: UUID |
GET https://test-onboarding.centralpay.net/api/merchant-enrollment/<enrolmentId>
curl -v -X GET https://test-onboarding.centralpay.net/api/merchant-enrollment/2a0638ab-395f-4bd1-82ef-e33f0a9fb80f \
-u 'doctest:4I9HJRTd'
{
"workflow": {
"uuid": "26f5a70e-c421-4414-aa34-3487666012e8",
"status": "ON_GOING",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "a7504a2b-d2a9-4102-9fbc-d6b871aa0f7e",
"created_at": "2024-03-26T12:25:56",
"cgu_uuid": "73ca4c77-8c5f-49d5-b31e-afdb5d90a6b5",
"security_uuid": null,
"fee_schedule_uuid": "9e4697cb-29e8-4a9f-b464-d84ec71eee06",
"element-type": "contract-validation"
}
],
"uuid": "7c21f21c-6812-4e7c-899e-d76cc9b0ead8",
"name": "ContractValiA",
"state": "OK",
"category": "validation",
"created_at": "2024-03-26T12:25:54"
},
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "c56ac6ef-ef9b-4a0c-8afc-4629cc8b00b1",
"created_at": "2024-03-26T12:25:56",
"reference": null,
"review_url": null,
"status_call": null,
"element-type": "sanction-check"
}
],
"uuid": "ff3d14e5-7d13-49ce-8f42-2c32f03f02cb",
"name": "checkSanctionListA",
"state": "OK",
"category": null,
"created_at": "2024-03-26T12:25:56"
},
{
"step_elements": [],
"uuid": "c9fa66ae-5483-4c22-bbf4-ffb95e1cabd4",
"name": "QuestionLvl1A",
"state": "TODO",
"category": "validation",
"created_at": "2024-03-26T12:25:56"
}
],
"additional_documents": []
},
"identity_badge": null,
"representatives_list": null,
"inactive_representatives_list": [],
"infogreffe_identity": null,
"language": "fr",
"risk_score": {
"residentCountry": 0,
"nationalityCountry": 1,
"pep": 0,
"sanction": 0,
"activity": 1,
"crossBorderPayment": 2,
"total": 4,
"metadata": "{\"risk_score\":4,\"annual_revenue\":300000,\"onfido\":[{\"status\":\"complete\",\"result\":\"consider\",\"report_document_result\":\"consider\",\"report_document_sub_result\":\"rejected\",\"report_facial_similarity_photo_result\":\"consider\",\"report_watchlist_enchanced_result\":\"clear\"}]}"
},
"monthly_turnover": 90000,
"monthly_turnover_currency": "EUR",
"merchant_enrollment_autocompleted": {
"annual_turnover": 900000,
"monthly_turnover": 90000,
"uuid": "f3ba686f-12ab-4cd5-a3f4-445a3e793a0b",
"created_at": "2024-03-26T12:25:55",
"metadata": "{\"risk_score\":4,\"annual_revenue\":300000,\"onfido\":[{\"status\":\"complete\",\"result\":\"consider\",\"report_document_result\":\"consider\",\"report_document_sub_result\":\"rejected\",\"report_facial_similarity_photo_result\":\"consider\",\"report_watchlist_enchanced_result\":\"clear\"}]}",
"additional_documents": [],
"declared_monthly_revenue": null,
"verified_monthly_revenue": null
},
"api_infogreffe_identity": null,
"kyc_update": null,
"additional_document_need_upload": false,
"uuid": "2a0638ab-395f-4bd1-82ef-e33f0a9fb80f",
"risk_points": 4,
"created_at": "2024-03-26T12:25:53",
"last_updated_at": "2024-03-26T12:25:56",
"turnover_is_fixed": false,
"workflow_mode": "SEQUENTIAL",
"risk_level": "LOW",
"actor_initiator": "3ad4b016-26a3-470a-afe4-cfcc802ca6ae",
"type": "INDIVIDUAL",
"is_canceled": false,
"enrollment_account": {
"login": "jd@testthree.com"
},
"profile": {
"birthname": {
"status": "ON_GOING",
"uuid": "50d59fa6-3d2a-4855-bb61-95eecf248a84",
"created_at": "2024-03-26T12:25:53",
"value": null,
"element-type": "birthname"
},
"uuid": "b07c16cf-d568-4376-a300-be59742d82f2",
"workflow": {
"uuid": "71af8de9-eae5-4166-8c26-00cd5f1751bf",
"status": "ACCEPTED",
"activities": [
{
"step_elements": [
{
"status": "COMPLETED",
"uuid": "97db6843-9de1-4899-a6b2-ab492cd5f3d0",
"created_at": "2024-03-26T12:25:53",
"country": "ESP",
"element-type": "country-of-birth"
},
{
"status": "COMPLETED",
"uuid": "2b697073-4f1b-4e08-b741-1707ca82b386",
"created_at": "2024-03-26T12:25:53",
"value": "1990-01-01T00:00:00",
"element-type": "birthday"
},
{
"status": "COMPLETED",
"uuid": "53757508-5546-41b3-aeca-fa515122bdd5",
"created_at": "2024-03-26T12:25:53",
"value": "jd@testthree.com",
"element-type": "email"
},
{
"status": "COMPLETED",
"uuid": "e99f72f2-1ce8-4b5d-9830-6f93f288fd06",
"created_at": "2024-03-26T12:25:53",
"value": "John",
"element-type": "firstname"
},
{
"status": "COMPLETED",
"uuid": "8d7c979b-3e22-427d-8e80-70aee2e8895b",
"created_at": "2024-03-26T12:25:53",
"value": "+34623254961",
"element-type": "phone"
},
{
"status": "COMPLETED",
"uuid": "f6743f5f-6f71-4f9f-8c4d-8e5e108b4de8",
"created_at": "2024-03-26T12:25:55",
"name_line1": "1 Calle Marqués de Larios",
"name_line2": null,
"name_line3": null,
"name_line4": null,
"locality": "Málaga",
"postal_code": "29015",
"country": "ESP",
"element-type": "address"
},
{
"status": "COMPLETED",
"uuid": "1c6cf84b-3038-4c2c-989b-94cb4c1b0cbd",
"created_at": "2024-03-26T12:25:53",
"value": "Doe",
"element-type": "lastname"
},
{
"status": "COMPLETED",
"uuid": "0334b321-9e6b-4ec0-a9cd-9bbb53302bee",
"created_at": "2024-03-26T12:25:53",
"value": "Madrid",
"element-type": "place-of-birth"
},
{
"status": "COMPLETED",
"uuid": "c59af4d0-0136-4a4b-a67d-dcbe95c1a738",
"created_at": "2024-03-26T12:25:55",
"documents": [
{
"file_check": [],
"uuid": "10c88b4c-1aa0-4d57-a16d-d451b1453f48",
"mime_type": "image/jpeg"
}
],
"type": "PASSPORT",
"proof_of_identity_document": null,
"expiry_date": null,
"document_number": null,
"mrz_line1": null,
"mrz_line2": null,
"issuing_country": {
"country": "FRA"
},
"element-type": "identity-document"
}
],
"uuid": "f24c1af7-ece1-4a91-b586-d7b5aa8e9097",
"name": "identityInfos",
"state": "OK",
"category": "identity",
"created_at": "2024-03-26T12:25:53"
},
{
"step_elements": [],
"uuid": "128c27fd-02f4-46f0-8ac6-3720d0992d02",
"name": "finished",
"state": "OK",
"category": null,
"created_at": "2024-03-26T12:25:55"
}
],
"additional_documents": []
},
"firstname": {
"status": "COMPLETED",
"uuid": "e99f72f2-1ce8-4b5d-9830-6f93f288fd06",
"created_at": "2024-03-26T12:25:53",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "COMPLETED",
"uuid": "1c6cf84b-3038-4c2c-989b-94cb4c1b0cbd",
"created_at": "2024-03-26T12:25:53",
"value": "Doe",
"element-type": "lastname"
},
"usename": {
"status": "ON_GOING",
"uuid": "50d59fa6-3d2a-4855-bb61-95eecf248a84",
"created_at": "2024-03-26T12:25:53",
"value": null,
"element-type": "birthname"
},
"email": {
"status": "COMPLETED",
"uuid": "53757508-5546-41b3-aeca-fa515122bdd5",
"created_at": "2024-03-26T12:25:53",
"value": "jd@testthree.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "ac82839b-f950-41f4-91b9-0f63c5e4ded5",
"created_at": "2024-03-26T12:25:53",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": {
"status": "COMPLETED",
"uuid": "8d7c979b-3e22-427d-8e80-70aee2e8895b",
"created_at": "2024-03-26T12:25:53",
"value": "+34623254961",
"element-type": "phone"
},
"birthday": {
"status": "COMPLETED",
"uuid": "2b697073-4f1b-4e08-b741-1707ca82b386",
"created_at": "2024-03-26T12:25:53",
"value": "1990-01-01T00:00:00",
"element-type": "birthday"
},
"login": "jd@testthree.com",
"bo_user_uuid": "f237259b-9734-4dce-be59-404eda367a0b"
},
"activity_sector": {
"uuid": "2fce29f9-4a9c-4d68-9c08-f56cb972d7e9",
"name": "Transport and logistics"
},
"data": {
"type": "PARTICULAR",
"company_name": null,
"history": [],
"turnover": {
"uuid": "aed57921-81d8-4f22-8b13-b2f150503800",
"name": "Less than 20k EUR"
},
"activity_age": null
},
"custom_reference": null,
"is_converted": true,
"conformity_status": "ACCEPTED",
"conformity_status_level_two": null,
"validator_level_one": "1d783cc9-a6dd-4b72-8d4a-5582d0b3a1bd",
"validator_level_two": null,
"merchant_uuid": "aea0540a-bb25-4367-b7e0-7880aed1bd89",
"validation_date": null,
"validation_date_level_two": null,
"sub_type": null,
"api_infogreffe_attempt": 0,
"next_step": 0,
"merchant_enrollment_additional": [],
"full_kyc": false,
"auto_updated_data": false
}
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 |
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
|
emissionWalletId Wallet |
Identifier of the Emission wallet Required : no Validation: UUID Wallet of one of his sub-merchants |
currency Currency |
Currency Required : no 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 |
fromCurrency Currency |
Currency Required : no 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 |
toCurrency Currency |
Currency Required : no 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 |
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 "SCT_TRANSACTION", the status of the sct must be PENDING or RECEIVED If sourceType equal to "CREDIT", the credit status must be CLEARED If sourceType equal to "SDD", the status of the sdd must be CLEARED |
sourceType String |
ENUM Required : yes (if the HTTP parameter sourceId is set) Values : TRANSACTION | SCT_TRANSACTION | CREDIT | SDD |
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. |
purposeCode String (ENUM) |
Required: no
|
purposeMessage String (100) |
addtional purpose dataRequired: needed if purposeCode = OTHR or IPDO |
metaData String (json) |
Merchant metadata Required: no |
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. |
metaData String (json) |
Json with any additional data Required: no |
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 |
after String |
Only returns items created after specified date time Example : 2020-08-31T07:13:22.639Z Required: no |
before String |
Only returns items created before specified date time Example : 2020-08-31T07:13:22.639Z Required: no |
limit String |
Number of items to return Default value : 10 Required: no |
page String |
Page index to get Default value : 1 Required: no |
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 |
Transfer Purpose Code
Here are all the current valid Purpose Codes
ACCT : AccountManagement ADCS : AdvisoryDonationCopyrightServices ADMG : AdministrativeManagement ADVA : AdvancePayment AEMP : ActiveEmploymentPolicy AGRT : AgriculturalTransfer AIRB : Air ALLW : Allowance ALMY : AlimonyPayment AMEX : Amex ANNI : Annuity ANTS : AnesthesiaServices AREN : AccountsReceivablesEntry AUCO : AuthenticatedCollections B112 : TrailerFeePayment BBSC : BabyBonusScheme BCDM : BearerChequeDomestic BCFG : BearerChequeForeign BECH : ChildBenefit BENE : UnemploymentDisabilityBenefit BEXP : BusinessExpenses BFWD : BondForward BKDF : BankLoanDelayedDrawFunding BKFE : BankLoanFees BKFM : BankLoanFundingMemo BKIP : BankLoanAccruedInterestPayment BKPP : BankLoanPrincipalPaydown BLDM : BuildingMaintenance BNET : BondForwardNetting BOCE : BackOfficeConversionEntry BOND : Bonds BONU : BonusPayment. BR12 : TrailerFeeRebate BUSB : Bus CABD : CorporateActions-Bonds CAEQ : CorporateActions-Equities CAFI : CustodianManagementFeeInhouse CASH : CashManagementTransfer CBCR : CreditCard CBFF : CapitalBuilding CBFR : CapitalBuildingRetirement CBLK : CardBulkClearing CBTV : CableTVBill CCHD : CashCompensationHelplessnessDisability CCIR : CrossCurrencyIRS CCPC : CCPClearedInitialMargin CCPM : CCPClearedVariationMargin CCRD : CreditCardPayment CCSM : CCPClearedInitialMarginSegregatedCash CDBL : CreditCardBill CDCB : CardPaymentWithCashBack CDCD : CashDisbursementCashSettlement CDCS : CashDisbursementWithSurcharging CDDP : CardDeferredPayment CDEP : CreditDefaultEventPayment CDOC : OriginalCredit CDQC : QuasiCash CFDI : CapitalFallingDueInhouse CFEE : CancellationFee CGDD : CardGeneratedDirectDebit CHAR : CharityPayment CLPR : CarLoanPrincipalRepayment CMDT : CommodityTransfer COLL : CollectionPayment COMC : CommercialPayment COMM : Commission COMP : CompensationPayment COMT : ConsumerThirdPartyConsolidatedPayment CORT : TradeSettlementPayment COST : Costs CPEN : CashPenalties CPKC : CarparkCharges CPYR : Copyright CRDS : CreditDefaultSwap CRPR : CrossProduct CRSP : CreditSupport CRTL : CreditLine CSDB : CashDisbursementCashManagement CSLP : CompanySocialLoanPaymentToBank CVCF : ConvalescentCareFacility DBCR : DebitCard DBTC : DebitCollectionPayment DCRD : DebitCardPayment DEBT : ChargesBorneByDebtor DEPD : DependentSupportPayment DEPT : Deposit DERI : Derivatives DICL : Diners DIVD : Dividend DMEQ : DurableMedicaleEquipment DNTS : DentalServices DSMT : PrintedOrderDisbursement DVPM : DeliverAgainstPayment ECPG : GuaranteedEPayment ECPR : EPaymentReturn ECPU : NonGuaranteedEPayment EDUC : Education EFTC : LowValueCredit EFTD : LowValueDebit ELEC : ElectricityBill ENRG : Energies EPAY : Epayment EQPT : EquityOption EQTS : Equities EQUS : EquitySwap ESTX : EstateTax ETUP : EPurseTopUp EXPT : ExoticOption EXTD : ExchangeTradedDerivatives FACT : FactorUpdateRelatedPayment FAND : FinancialAidInCaseOfNaturalDisaster FCOL : FeeCollection FCPM : LatePaymentOfFeesAndCharges FEES : PaymentOfFees FERB : Ferry FIXI : FixedIncome FLCR : FleetCard FNET : FuturesNettingPayment FORW : ForwardForeignExchange FREX : ForeignExchange FUTR : Futures FWBC : ForwardBrokerOwnedCashCollateral FWCC : ForwardClientOwnedCashCollateral FWLV : ForeignWorkerLevy FWSB : ForwardBrokerOwnedCashCollateralSegregated FWSC : ForwardClientOwnedSegregatedCashCollateral FXNT : ForeignExchangeRelatedNetting GAFA : GovernmentFamilyAllowance GAHO : GovernmentHousingAllowance GAMB : GamblingOrWageringPayment GASB : GasBill GDDS : PurchaseSaleOfGoods GDSV : PurchaseSaleOfGoodsAndServices GFRP : GuaranteeFundRightsPayment GIFT : Gift GOVI : GovernmentInsurance GOVT : GovernmentPayment GSCB : PurchaseSaleOfGoodsAndServicesWithCashBack GSTX : GoodsServicesTax GVEA : AustrianGovernmentEmployeesCategoryA GVEB : AustrianGovernmentEmployeesCategoryB GVEC : AustrianGovernmentEmployeesCategoryC GVED : AustrianGovernmentEmployeesCategoryD GWLT : GovermentWarLegislationTransfer HEDG : Hedging HLRP : PropertyLoanRepayment HLST : PropertyLoanSettlement HLTC : HomeHealthCare HLTI : HealthInsurance HREC : HousingRelatedContribution HSPC : HospitalCare HSTX : HousingTax ICCP : IrrevocableCreditCardPayment ICRF : IntermediateCareFacility IDCP : IrrevocableDebitCardPayment IHRP : InstalmentHirePurchaseAgreement INPC : InsurancePremiumCar INPR : InsurancePremiumRefund INSC : PaymentOfInsuranceClaim INSM : Installment INSU : InsurancePremium INTC : IntraCompanyPayment INTE : Interest INTP : IntraPartyPayment INTX : IncomeTax INVS : InvestmentAndSecurities IPAY : InstantPayments IPCA : InstantPaymentsCancellation IPDO : InstantPaymentsForDonations IPEA : InstantPaymentsInECommerceWithoutAddressData IPEC : InstantPaymentsInECommerceWithAddressData IPEW : InstantPaymentsInECommerce IPPS : InstantPaymentsAtPOS IPRT : InstantPaymentsReturn IPU2 : InstantPaymentsUnattendedVendingMachineWith2FA IPUW : InstantPaymentsUnattendedVendingMachineWithout2FA IVPT : InvoicePayment LBIN : LendingBuyInNetting LBRI : LaborInsurance LCOL : LendingCashCollateralFreeMovement LFEE : LendingFees LICF : LicenseFee LIFI : LifeInsurance LIMA : LiquidityManagement LMEQ : LendingEquityMarkedToMarketCashCollateral LMFI : LendingFixedIncomeMarkedToMarketCashCollateral LMRK : LendingUnspecifiedTypeOfMarkedToMarketCashCollateral LOAN : Loan LOAR : LoanRepayment LOTT : LotteryPayment LREB : LendingRebatePayments LREV : LendingRevenuePayments LSFL : LendingClaimPayment LTCF : LongTermCareFacility MAFC : MedicalAidFundContribution MARF : MedicalAidRefund MARG : DailyMarginOnListedDerivatives MBSB : MBSBrokerOwnedCashCollateral MBSC : MBSClientOwnedCashCollateral MCDM : MultiCurrenyChequeDomestic MCFG : MultiCurrenyChequeForeign MDCS : MedicalServices MGCC : FuturesInitialMargin MGSC : FuturesInitialMarginClientOwnedSegregatedCashCollateral MOMA : MoneyMarket MP2B : MobileP2BPayment MP2P : MobileP2PPayment MSVC : MultipleServiceTypes MTUP : MobileTopUp NETT : Netting NITX : NetIncomeTax NOWS : NotOtherwiseSpecified NWCH : NetworkCharge NWCM : NetworkCommunication OCCC : ClientOwnedOCCPledgedCollateral OCDM : OrderChequeDomestic OCFG : OrderChequeForeign OFEE : OpeningFee OPBC : OTCOptionBrokerOwnedCashCollateral OPCC : OTCOptionClientOwnedCashCollateral OPSB : OTCOptionBrokerOwnedSegregatedCashCollateral OPSC : OTCOptionClientOwnedCashSegregatedCashCollateral OPTN : FXOption OTCD : OTCDerivatives OTHR : Other OTLC : OtherTelecomRelatedBill PADD : PreauthorizedDebit PAYR : Payroll PCOM : PropertyCompletionPayment PDEP : PropertyDeposit PEFC : PensionFundContribution PENO : PaymentBasedOnEnforcementOrder PENS : PensionPayment PHON : TelephoneBill PLDS : PropertyLoanDisbursement PLRF : PropertyLoanRefinancing POPE : PointOfPurchaseEntry PPTI : PropertyInsurance PRCP : PricePayment PRME : PreciousMetal PTSP : PaymentTerms PTXP : PropertyTax RAPI : RapidPaymentInstruction RCKE : RepresentedCheckEntry RCPT : ReceiptPayment RDTX : RoadTax REBT : Rebate REFU : Refund RELG : RentalLeaseGeneral RENT : Rent REOD : AccountOverdraftRepayment REPO : RepurchaseAgreement RETL : RetailPayment RHBS : RehabilitationSupport RIMB : ReimbursementOfAPreviousErroneousTransaction RINP : RecurringInstallmentPayment RLWY : Railway ROYA : Royalties RPBC : BilateralRepoBrokerOwnedCollateral RPCC : RepoClientOwnedCollateral RPNT : BilateralRepoInternetNetting RPSB : BilateralRepoBrokerOwnedSegregatedCashCollateral RPSC : BilateralRepoClientOwnedSegregatedCashCollateral RRBN : RoundRobin RRCT : ReimbursementReceivedCreditTransfer RRTP : RelatedRequestToPay RVPM : ReceiveAgainstPayment RVPO : ReverseRepurchaseAgreement SALA : SalaryPayment SASW : ATM SAVG : Savings SBSC : SecuritiesBuySellSellBuyBack SCIE : SingleCurrencyIRSExotic SCIR : SingleCurrencyIRS SCRP : SecuritiesCrossProducts SCVE : PurchaseSaleOfServices SECU : Securities SEPI : SecuritiesPurchaseInhouse SERV : ServiceCharges SHBC : BrokerOwnedCollateralShortSale SHCC : ClientOwnedCollateralShortSale SHSL : ShortSell SLEB : SecuritiesLendingAndBorrowing SLOA : SecuredLoan SLPI : PaymentSlipInstruction SPLT : SplitPayments SPSP : SalaryPensionSumPayment SSBE : SocialSecurityBenefit STDY : Study SUBS : Subscription SUPP : SupplierPayment SWBC : SwapBrokerOwnedCashCollateral SWCC : SwapClientOwnedCashCollateral SWFP : SwapContractFinalPayment SWPP : SwapContractPartialPayment SWPT : Swaption SWRS : SwapContractResetPayment SWSB : SwapsBrokerOwnedSegregatedCashCollateral SWSC : SwapsClientOwnedSegregatedCashCollateral SWUF : SwapContractUpfrontPayment TAXR : TaxRefund TAXS : TaxPayment TBAN : TBAPairOffNetting TBAS : ToBeAnnounced TBBC : TBABrokerOwnedCashCollateral TBCC : TBAClientOwnedCashCollateral TBIL : TelecommunicationsBill TCSC : TownCouncilServiceCharges TELI : TelephoneInitiatedTransaction TLRF : NonUSMutualFundTrailerFeePayment TLRR : NonUSMutualFundTrailerFeeRebatePayment TMPG : TMPGClaimPayment TPRI : TriPartyRepoInterest TPRP : TriPartyRepoNetting TRAD : Commercial TRCP : TreasuryCrossProduct TREA : TreasuryPayment TRFD : TrustFund TRNC : TruncatedPaymentSlip TRPT : RoadPricing TRVC : TravellerCheque UBIL : Utilities UNIT : UnitTrustPurchase VATX : ValueAddedTaxPayment VIEW : VisionCare WEBI : InternetInitiatedTransaction WHLD : WithHolding WTER : WaterBill
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 |
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 |
merchantTransferReversalId String |
Identifier of the merchant Required : no Validation : .{0,100} |
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. |
escrowDate String |
Escrow date Required : noNote: ISO 8601 |
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} |
after String |
Only returns items created after specified date time Example : 2020-08-31T07:13:22.639Z Required: no |
before String |
Only returns items created before specified date time Example : 2020-08-31T07:13:22.639Z Required: no |
limit String |
Number of items to return Default value : 10 Required: no |
page String |
Page index to get Default value : 1 Required: no |
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.
It can also be used to payout to a customer bank account. Please note that you'll need the field destinationBankAccountId to have an CUSTOMER_ACCOUNT with accepted status (either ISO or EM)
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 .
currency Currency |
Currency Required : yes Validation: ISO4217 alpha format or num [A-Z}{3}|[0-9]{3} Existing for Merchant 's wallet. Value can be Null, but will withdraw the full available amount |
payoutType String (enum) |
Type of the payout. Required : yes |
destinationBankAccountId BankAccount |
Destination bank account identifier of the merchant or customer Required : Conditional (cardId or destinationBankAccountId) Authorized 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 |
cardId String (uuid) |
Card you want to credit the payout to. Required : Conditional (cardId or destinationBankAccountId) |
walletId String (uuid) |
Emission wallet Identifier of the payout wallet. Will use wallet by default if not used. |
amount Integer |
Amount of the payout Required : noValidation: Strictly superior to 0 and lower or equal to 9999999The amount must not exceed the available amount in the wallet for the currency setted.If null, maximum available amount will be withdraw Note: In cents |
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. |
transitionWallet String (uuid) |
Required: no Identifier of the wallet that should be used as transition for a Payout on a Customer wallet. |
customerId String (uuid) |
Required: no Identifier of the customer. |
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 |
after String |
Only returns items created after specified date time Example : 2020-08-31T07:13:22.639Z Required: no |
before String |
Only returns items created before specified date time Example : 2020-08-31T07:13:22.639Z Required: no |
limit String |
Number of items to return Default value : 10 Required: no |
page String |
Page index to get Default value : 1 Required: no |
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 |