Plateform
Onboarding
API Endpoint
Use the following link for testing: 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.
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.
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/
Example of curl code
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/ \
-u 'login:password' \
-F firstname=John \
-F lastname=Doe \
-F email=j.doe@gmail.com \
-F language=fr \
-F accountType=PARTNER \
-F feeSchedule=b52ae174-4830-4615-bdc4-a96ed9f05eeb \
-F activitySector=2ddb3e87-b3a4-4dc2-a535-cf73637b4cd6 \
-F contract=6c6f0529-76bf-43ed-9f5e-c2d4ea6ff4d9Back to JSON Format if NOK
{
"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."
]
}
}
}
}Back to JSON Format if OK
{
"workflow": null,
"uuid": "2aff09ff-1a55-4fff-aa5d-0430d26a3868",
"risk_points": null,
"turnover_is_fixed": false,
"enrollment_account": null,
"profile": {
"uuid": "eac67996-d309-471f-865b-e65f068ce0ac",
"workflow": {
"status": "ON_GOING",
"activities": [
{
"uuid": "97d6d67d-bcac-4396-82dd-1d3aa3361df9",
"name": "firstname",
"state": "ON_GOING",
"category": "contact",
"created_at": "2018-10-18T10:23:35+00:00",
"step_elements": [
{
"status": "ON_GOING",
"uuid": "3f4ac101-f5da-4003-87ac-45739ce1d7c2",
"value": "John",
"element-type": "firstname"
}
]
}
]
},
"firstname": {
"status": "ON_GOING",
"uuid": "3f4ac101-f5da-4003-87ac-45739ce1d7c2",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "ON_GOING",
"uuid": "5dc872a0-b365-4773-93c6-e13cdfc0e787",
"value": "Doe",
"element-type": "lastname"
},
"email": {
"status": "ON_GOING",
"uuid": "077a6d16-2eeb-42dc-aebd-41fbfb773e59",
"value": "j.doe@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "3ef3b019-d1df-44c5-a128-0beb745bad74",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": null
},
"activity_sector": {
"name": "Electronic devices and computers"
},
"data": null,
}
Create an Enrollment
This function allows you to create a new merchant enrollment.
| firstname* string (255) |
Merchant firstname |
| lastname* String (255) |
Merchant lastname |
| email* String (255) |
Merchant email |
| language* String |
Merchant mail language Note: GET /api/locale |
| accountType* ENUM |
Merchant account type Note: GET /api/merchant-enrollment/account-type |
| activitySector* UUID (36) |
Merchant activity sector Note: GET /api/nauth/enrollment-claim/activity-sector |
| feeSchedule* UUID (36) |
Fee schedule to apply Note: POST /api/merchant-enrollment/fee-schedule |
| contract UUID (36) |
Contract to apply
Note: GET/api/merchant-enrollment/contract Required if accountType is STANDARD,PARTNER or RESELLER |
| phone string |
Internationnal phone number |
| isCompany bool |
If is a particular or a company |
| turnoverIsFixed bool |
Force to fix turnover Note: Default false |
| sendClaimEmail bool |
Send initial mail to merchant Note: Default true |
| sendProfileCreationEmail bool |
Send mail after profile is completed
Note: Default false |
| sendAccountCreationEmail bool |
Send mail when merchant can use his Centralpay account Note: Default true |
|
customReference string (100) |
Your custom reference |
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/
Example of curl code
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/ \
-u 'login:password' \
-F firstname=John \
-F lastname=Doe \
-F email=j.doe@gmail.com \
-F language=fr \
-F accountType=PARTNER \
-F feeSchedule=b52ae174-4830-4615-bdc4-a96ed9f05eeb \
-F activitySector=2ddb3e87-b3a4-4dc2-a535-cf73637b4cd6 \
-F contract=6c6f0529-76bf-43ed-9f5e-c2d4ea6ff4d9Back to JSON Format if NOK
{
"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."
]
}
}
}
}Back to JSON Format if OK
{
"workflow": null,
"uuid": "2aff09ff-1a55-4fff-aa5d-0430d26a3868",
"risk_points": null,
"turnover_is_fixed": false,
"enrollment_account": null,
"profile": {
"uuid": "eac67996-d309-471f-865b-e65f068ce0ac",
"workflow": {
"status": "ON_GOING",
"activities": [
{
"uuid": "97d6d67d-bcac-4396-82dd-1d3aa3361df9",
"name": "firstname",
"state": "ON_GOING",
"category": "contact",
"created_at": "2018-10-18T10:23:35+00:00",
"step_elements": [
{
"status": "ON_GOING",
"uuid": "3f4ac101-f5da-4003-87ac-45739ce1d7c2",
"value": "John",
"element-type": "firstname"
}
]
}
]
},
"firstname": {
"status": "ON_GOING",
"uuid": "3f4ac101-f5da-4003-87ac-45739ce1d7c2",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "ON_GOING",
"uuid": "5dc872a0-b365-4773-93c6-e13cdfc0e787",
"value": "Doe",
"element-type": "lastname"
},
"email": {
"status": "ON_GOING",
"uuid": "077a6d16-2eeb-42dc-aebd-41fbfb773e59",
"value": "j.doe@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "3ef3b019-d1df-44c5-a128-0beb745bad74",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": null
},
"activity_sector": {
"name": "Electronic devices and computers"
},
"data": null,
}
Create full enrollment
CentralPay platform delivers through its API, functionalities that allow to manage all onboarding process requests without dealing with our Back Office. To do so, you’ve got to set up the onboarding platform URL within CentralPay Back Office.
The enrollment request creation is identical to an enrollment managed by CentralPay.
In order to complete the Prospect registration, the following steps have to be completed:
- Step 1: Complete your profile
- Step 2: Define a password
- Step 3: Complete the information to determine the workflow
- Step 4: Complete the workflow
Back to JSON Format
{
"workflow": null,
"uuid": "2aff09ff-1a55-4fff-aa5d-0430d26a3868",
"risk_points": null,
"turnover_is_fixed": false,
"enrollment_account": null,
"profile": {
"uuid": "eac67996-d309-471f-865b-e65f068ce0ac",
"workflow": {
"status": "ON_GOING",
"activities": [
{
"uuid": "97d6d67d-bcac-4396-82dd-1d3aa3361df9",
"name": "firstname",
"state": "ON_GOING",
"category": "contact",
"created_at": "2018-10-18T10:23:35+00:00",
"step_elements": [
{
"status": "ON_GOING",
"uuid": "3f4ac101-f5da-4003-87ac-45739ce1d7c2",
"value": "John",
"element-type": "firstname"
}
]
}
]
},
"firstname": {
"status": "ON_GOING",
"uuid": "3f4ac101-f5da-4003-87ac-45739ce1d7c2",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "ON_GOING",
"uuid": "5dc872a0-b365-4773-93c6-e13cdfc0e787",
"value": "Doe",
"element-type": "lastname"
},
"email": {
"status": "ON_GOING",
"uuid": "077a6d16-2eeb-42dc-aebd-41fbfb773e59",
"value": "j.doe@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "3ef3b019-d1df-44c5-a128-0beb745bad74",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": null
},
"activity_sector": {
"name": "Electronic devices and computers"
},
"data": null,
}
Complete profile workflow
The profile is completed when the profile[workflow][status] value is "ACCEPTED", for now the status is : "ON_GOING".
Back to JSON Format
{
"workflow": null,
"uuid": "2aff09ff-1a55-4fff-aa5d-0430d26a3868",
"risk_points": null,
"turnover_is_fixed": false,
"enrollment_account": null,
"profile": {
"uuid": "eac67996-d309-471f-865b-e65f068ce0ac",
"workflow": {
"status": "ON_GOING",
"activities": [
{
"uuid": "97d6d67d-bcac-4396-82dd-1d3aa3361df9",
"name": "firstname",
"state": "ON_GOING",
"category": "contact",
"created_at": "2018-10-18T10:23:35+00:00",
"step_elements": [
{
"status": "ON_GOING",
"uuid": "3f4ac101-f5da-4003-87ac-45739ce1d7c2",
"value": "John",
"element-type": "firstname"
}
]
}
]
},
"firstname": {
"status": "ON_GOING",
"uuid": "3f4ac101-f5da-4003-87ac-45739ce1d7c2",
"value": "John",
"element-type": "firstname"
},
"lastname": {
"status": "ON_GOING",
"uuid": "5dc872a0-b365-4773-93c6-e13cdfc0e787",
"value": "Doe",
"element-type": "lastname"
},
"email": {
"status": "ON_GOING",
"uuid": "077a6d16-2eeb-42dc-aebd-41fbfb773e59",
"value": "j.doe@gmail.com",
"element-type": "email"
},
"language": {
"status": "ON_GOING",
"uuid": "3ef3b019-d1df-44c5-a128-0beb745bad74",
"locale": {
"identifier": "fr"
},
"element-type": "language"
},
"phone": null
},
"activity_sector": {
"name": "Electronic devices and computers"
},
"data": null,
}
Complete profile
A profile is completed when the workflow is accepted. As long as it is not done, steps to fill out will be submitted to unlock the next step.
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"
}
Complete profile fields
In order to know the fields to complete for the first step of the profile workflow, you’ve got to create a request GET /api/nauth/profile/{{ activityUuid }}/activity containing activityUuid with the following value profile[workflow][ activities][0][uuid].
In this case, you’ve got to make a request GET /api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity.
To complete this first step, you’ve got to send a form with "John" (by default) as a "firstname". To make this step successful you’ve got to send valid information.
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"
}
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity
Example of curl code
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity \
-u 'login:password' \
-F firstname[value]=JeanBack to JSON Form
"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"
}
]
}
]
},Example to send a file
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
If you make the request GET /api/nauth/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868 once more, the workflow status that was previously "ON_GOING" is now "OK". The next step is now displayed.
As long as the profile workflow is "ON_GOING", you need to complete those steps.
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity
Example of curl code
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity \
-u 'login:password' \
-F firstname[value]=JeanBack to JSON Form
"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"
}
]
}
]
},Example to send a file
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'
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/user/define/{uuid}
Example of curl code
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
The prospect has to define a password to pursue the enrollment process. This password is identical to the one used to access the CentralPay back office.
enrollment_account[login] is now completed.
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/user/define/{uuid}
Example of curl code
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/user/define/2aff09ff-1a55-4fff-aa5d-0430d26a3868 \
-u 'login:password' \
-F password=StrongPwd14$HTTP Request
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/complete
Example of curl code
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/complete \
-u 'login:password' \
-F isCompany=1 \
-F bankAccountInEEACountry=1 \
-F turnover=3b71724f-a267-42b5-a52e-2af091f93d12 \
-F companyName=MyCompanyName \
-F activityAge=9396b5b3-b9bc-491b-9dc7-b941c21f6ff7
Back to JSON Format if NOK:
{
"code":400,
"message":"Validation Failed",
"errors":{
"errors":[
"No available suite with the entereded data"
],
"children":{
"isCompany":{
},
"type":{
},
"bankAccountInEEACountry":{
},
"companyName":{
},
"activityAge":{
},
"turnover":{
}
}
}
}Back to JSON Format if OK
{
"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.
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 and match with no workflow.
| 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 isCompany is true or type is COMPANY Note: GET /api/nauth/enrollment-claim/activity-age |
| DEPRECATED isCompany* bool |
DEPRECATED, please use 'type' field instead of isCompany |
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/complete
Example of curl code
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/complete \
-u 'login:password' \
-F isCompany=1 \
-F bankAccountInEEACountry=1 \
-F turnover=3b71724f-a267-42b5-a52e-2af091f93d12 \
-F companyName=MyCompanyName \
-F activityAge=9396b5b3-b9bc-491b-9dc7-b941c21f6ff7
Back to JSON Format if NOK:
{
"code":400,
"message":"Validation Failed",
"errors":{
"errors":[
"No available suite with the entereded data"
],
"children":{
"isCompany":{
},
"type":{
},
"bankAccountInEEACountry":{
},
"companyName":{
},
"activityAge":{
},
"turnover":{
}
}
}
}Back to JSON Format if OK
{
"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"
},
}
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/37a6c5c5-7ddf-4707-bc71-ce16272d38a4Example of curl code
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'Back to JSON Format
{
"type": "FORM",
"form": {
"children": {
"company_legal_status": {
"children": {
"value": {}
}
},
"company_registration_number": {
"children": {
"value": {}
}
}
}
},
"category": "company"
}
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/37a6c5c5-7ddf-4707-bc71-ce16272d38a4
Example of curl code
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]=123456789Complete workflow
You’ve got to complete this workflow like the profile workflow. Depending on the information entered, future steps will be unlocked.
A step can be one of the following types:
- FORM: needs to send information (name, first name…)
- API_CALL: the onboarding makes an external call
- VALIDATION: needs a manual approval in the CentralPay Back office
- ENDED: the worfklow is completed.
The selection of the fields to be sent during a FORM type step, is based on the "children" form name. E.g.: for the field company_legal_status, you have to send the following key company_legal_status[value] with its value.
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/37a6c5c5-7ddf-4707-bc71-ce16272d38a4Example of curl code
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'Back to JSON Format
{
"type": "FORM",
"form": {
"children": {
"company_legal_status": {
"children": {
"value": {}
}
},
"company_registration_number": {
"children": {
"value": {}
}
}
}
},
"category": "company"
}
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/2aff09ff-1a55-4fff-aa5d-0430d26a3868/activity/37a6c5c5-7ddf-4707-bc71-ce16272d38a4
Example of curl code
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]=123456789Field reference
Below the list of fields and associated constraints:
| language[locale] string |
Language NOTE: GET /api/locale |
| 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 |
|
selfie_document[document] File |
Selfie |
|
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 |
|
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] [] |
|
|
director_list[profileIsItem] bool |
If merchant is an item if directors NOTE: Default false |
|
director_list[items] [] |
|
| 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 |
Full API reference
Onboarding full API reference
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/merchant-enrollment/account-type
Example of curl code
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/account-type \
-u 'login:password'Back to JSON Format
[
"STANDARD",
"PARTNER",
"RESELLER"
]Account type
This function allows you to get available account-type.
Depends of current account type
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/merchant-enrollment/account-type
Example of curl code
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/account-type \
-u 'login:password'Back to JSON Format
[
"STANDARD",
"PARTNER",
"RESELLER"
]HTTP Request
POST https://test-onboarding-api.centralpay.net/api/user/define/{uuid}Example of curl code
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 |
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/user/define/{uuid}Example of curl code
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/user/define/2aff09ff-1a55-4fff-aa5d-0430d26a3868 \
-u 'login:password' \
-F password=StrongPwd14$HTTP Request
GET https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-age
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-age \
-u 'login:password'Back to JSON Format
[
{
"uuid": "9396b5b3-b9bc-491b-9dc7-b941c21f6ff7",
"name": "Less than a year"
},
{
"uuid": "fa854e5d-f9a2-4773-86e1-c9ec4d6a095d",
"name": "More than a year"
}
]
Get Activity Age
This function allows you to list activity age.
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-age
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-age \
-u 'login:password'Back to JSON Format
[
{
"uuid": "9396b5b3-b9bc-491b-9dc7-b941c21f6ff7",
"name": "Less than a year"
},
{
"uuid": "fa854e5d-f9a2-4773-86e1-c9ec4d6a095d",
"name": "More than a year"
}
]
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-sectorExample of curl code
curl -v\
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-sector \
-u 'login:password'Back to JSON Format
[
{
"uuid": "2ddb3e87-b3a4-4dc2-a535-cf73637b4cd6",
"name": "Electronic devices and computers"
},
{
"uuid": "7ac7db30-6a9d-41ef-bcec-3f6d3e2bdbf8",
"name": "Garden, pets and tooling articles"
},
{
"uuid": "3df6eb47-ecc5-40c1-8bf7-2622d024572a",
"name": "Sport & Fitness"
},
]
Get Activity Sector
This function allows you to list activity sectors.
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-sectorExample of curl code
curl -v\
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/activity-sector \
-u 'login:password'Back to JSON Format
[
{
"uuid": "2ddb3e87-b3a4-4dc2-a535-cf73637b4cd6",
"name": "Electronic devices and computers"
},
{
"uuid": "7ac7db30-6a9d-41ef-bcec-3f6d3e2bdbf8",
"name": "Garden, pets and tooling articles"
},
{
"uuid": "3df6eb47-ecc5-40c1-8bf7-2622d024572a",
"name": "Sport & Fitness"
},
]
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/contract
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/contract \
-u 'login:password'Back to JSON Format
[
{
"uuid": "6c6f0529-76bf-43ed-9f5e-c2d4ea6ff4d9",
"name": "Contrat 1 PF"
},
]
Get contract
This function allows you to list available contract.
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/contract
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/contract \
-u 'login:password'Back to JSON Format
[
{
"uuid": "6c6f0529-76bf-43ed-9f5e-c2d4ea6ff4d9",
"name": "Contrat 1 PF"
},
]
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/fee-schedule
Example of curl code
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/fee-schedule \
-u 'login:password' \
-F accountType=BASICBack to JSON Format
[
{
"uuid": "b52ae174-4830-4615-bdc4-a96ed9f05eeb",
"name": "Grille tarifaire A"
}
]
Get fee schedule
This function allows you to list available fee-schedule.
| accountType* string (255) |
Note: STANDARD, BASIC, PARTNER, RESELLER |
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/fee-schedule
Example of curl code
curl -vX POST \
https://test-onboarding-api.centralpay.net/api/merchant-enrollment/fee-schedule \
-u 'login:password' \
-F accountType=BASICBack to JSON Format
[
{
"uuid": "b52ae174-4830-4615-bdc4-a96ed9f05eeb",
"name": "Grille tarifaire A"
}
]
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/other/legal-status
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/other/legal-status \
-u 'login:password'Back to JSON Format
[
{
"uuid": "7c979e34-b0c4-4cd4-b373-d13ced303485",
"name": "Charity"
},
{
"uuid": "47047b5d-3734-4238-85fd-ab58026e4e86",
"name": "Government organization"
},
{
"uuid": "712eeeaa-4274-4747-b3b3-826eeac83481",
"name": "Individual company"
},
{
"uuid": "04ddc116-4cde-43c8-b29b-95af62e47907",
"name": "Limited company"
},
{
"uuid": "5be993b6-a11f-4058-83dd-e241dfad391f",
"name": "Listed company"
},
{
"uuid": "13e4bc39-8ac1-460a-ab7c-fa05e999dde9",
"name": "Non limited company"
}
]
Get legal status
This function allows you to list legal status.
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/other/legal-status
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/other/legal-status \
-u 'login:password'Back to JSON Format
[
{
"uuid": "7c979e34-b0c4-4cd4-b373-d13ced303485",
"name": "Charity"
},
{
"uuid": "47047b5d-3734-4238-85fd-ab58026e4e86",
"name": "Government organization"
},
{
"uuid": "712eeeaa-4274-4747-b3b3-826eeac83481",
"name": "Individual company"
},
{
"uuid": "04ddc116-4cde-43c8-b29b-95af62e47907",
"name": "Limited company"
},
{
"uuid": "5be993b6-a11f-4058-83dd-e241dfad391f",
"name": "Listed company"
},
{
"uuid": "13e4bc39-8ac1-460a-ab7c-fa05e999dde9",
"name": "Non limited company"
}
]
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/locale
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/locale/ \
-u 'login:passwordBack to JSON
[
{
"identifier": "en",
"name": "English"
},
{
"identifier": "fr",
"name": "Français"
}
]Get locale
This function return onboarding locale available.
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/locale
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/locale/ \
-u 'login:passwordBack to JSON
[
{
"identifier": "en",
"name": "English"
},
{
"identifier": "fr",
"name": "Français"
}
]HTTP Request
GET https://test-onboarding-api.centralpay.net/api/nauth/profile/{uuid}/activity
Example of curl code
↵
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity \
-u 'login:password'Back to JSON Format
{
"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 |
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/nauth/profile/{uuid}/activity
Example of curl code
↵
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/profile/97d6d67d-bcac-4396-82dd-1d3aa3361df9/activity \
-u 'login:password'Back to JSON Format
{
"type": "FORM",
"form": {
"children": {
"firstname": {
"extra_data_to_pass": {
"default": "John"
},
"children": {
"value": {}
}
}
}
},
"category": "contact"
}HTTP Request
POST https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/turnover
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/turnover \
-u 'login:password' \
-F type=COMPANYBack to JSON Format
[
{
"uuid": "3b71724f-a267-42b5-a52e-2af091f93d12",
"name": "Less than 200k EUR"
},
{
"uuid": "c6777c76-4e6f-4038-b340-1c93afb94cf0",
"name": "From 200k to 500k EUR"
},
{
"uuid": "dd188e92-bf2e-43e0-a878-d7063ef2504d",
"name": "More than 500k EUR"
}
]
Get turnover
This function allows you to list turnover.
| type* enum |
Enrollment type Note: INDIVIDUAL | INDIVIDUAL_WITH_STATUS | LEGAL_ENTITY |
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/turnover
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/turnover \
-u 'login:password' \
-F type=COMPANYBack to JSON Format
[
{
"uuid": "3b71724f-a267-42b5-a52e-2af091f93d12",
"name": "Less than 200k EUR"
},
{
"uuid": "c6777c76-4e6f-4038-b340-1c93afb94cf0",
"name": "From 200k to 500k EUR"
},
{
"uuid": "dd188e92-bf2e-43e0-a878-d7063ef2504d",
"name": "More than 500k EUR"
}
]
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/workflow/
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/workflow/ \
-u 'login:password'Back to JSON Format
[
{
"uuid": "b8c354df-0a4d-4915-9dbe-550c6c75faa5",
"name": "Original",
"description": "Original company",
"max_risk": 10,
"type": "COMPANY"
}
]
Get workflow
This function allows you to list workflows.
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/workflow/
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/workflow/ \
-u 'login:password'Back to JSON Format
[
{
"uuid": "b8c354df-0a4d-4915-9dbe-550c6c75faa5",
"name": "Original",
"description": "Original company",
"max_risk": 10,
"type": "COMPANY"
}
]
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{enrollmentUuid}/activity/{activityUuid}/otpExample of curl code
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 |
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/merchant-enrollment/{enrollmentUuid}/activity/{activityUuid}/otpExample of curl code
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'HTTP Request
POST https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/company-turnover
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/company-turnover \
-u 'login:password'Back to JSON Format
[
{
"uuid": "3b71724f-a267-42b5-a52e-2af091f93d12",
"name": "Less than 200k EUR"
},
{
"uuid": "c6777c76-4e6f-4038-b340-1c93afb94cf0",
"name": "From 200k to 500k EUR"
},
{
"uuid": "dd188e92-bf2e-43e0-a878-d7063ef2504d",
"name": "More than 500k EUR"
}
]
DEPRECATED Get company turnover
Please use "Get turnover"
This function allows you to list company turnover.
HTTP Request
POST https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/company-turnover
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/company-turnover \
-u 'login:password'Back to JSON Format
[
{
"uuid": "3b71724f-a267-42b5-a52e-2af091f93d12",
"name": "Less than 200k EUR"
},
{
"uuid": "c6777c76-4e6f-4038-b340-1c93afb94cf0",
"name": "From 200k to 500k EUR"
},
{
"uuid": "dd188e92-bf2e-43e0-a878-d7063ef2504d",
"name": "More than 500k EUR"
}
]
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/particular-turnover
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/particular-turnover \
-u 'login:password' Back to JSON Format
[
{
"uuid": "92be0040-652b-4092-9da8-bbbbb39b41dc",
"name": "Less than 30k EUR"
},
{
"uuid": "38edb3e3-5a63-4555-876a-e7117c2a0a98",
"name": "From 30k to 60k EUR"
},
{
"uuid": "90b02428-3160-4270-866e-c86885317fd7",
"name": "More than 60k EUR"
}
]
DEPRECATED Get particular turnover
Please use "Get turnover"
This function allows you to list particular turnover.
HTTP Request
GET https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/particular-turnover
Example of curl code
curl -v \
https://test-onboarding-api.centralpay.net/api/nauth/enrollment-claim/particular-turnover \
-u 'login:password' Back to JSON Format
[
{
"uuid": "92be0040-652b-4092-9da8-bbbbb39b41dc",
"name": "Less than 30k EUR"
},
{
"uuid": "38edb3e3-5a63-4555-876a-e7117c2a0a98",
"name": "From 30k to 60k EUR"
},
{
"uuid": "90b02428-3160-4270-866e-c86885317fd7",
"name": "More than 60k EUR"
}
]
Transfer
Transfer objects allow you to transfer money from your wallet to another wallet.
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 | [..] |
| 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 |
HTTP Request
POST https://test-api.centralpay.net/v2/rest/transfer
HTTP Response
OBJ Json transfer type
Example of curl code
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=2019-05-23
Back to JSON Format
{
"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,
"escrowDate":"2019-05-23",
"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId":null,
"transferGroup":"transferGroup000000",
"description":"Création transfer",
"status":"PENDING",
"transferReversals":[],
"reversed":false,
"movementId":"c0a867d9-65b3-4131-b38b-efb0b37bb0ac",
"cancelMovementId":null,
"cancellationDate":null,
"additionalData":{"transfer":"transfer"}}
Create a transfer
This function allows you to create a transfer
|
merchantTransferId String |
Identifier of the Merchant Required : no Validation : .{0,100} |
| destinationWalletId Wallet |
Identifier of the Destination wallet Required : yes Validation: UUID Wallet of one of his sub-merchants |
|
currency Currency |
Currency Required : yes Validation: ISO4217 alpha format or num [A-Z}{3}|[0-9]{3} Existing for Merchant 's wallet |
|
amount Integer |
Amount of the transfer Required : yesValidation: Strictly superior to 0 and lower or equal to 9999999 If sourceId is not set, the amount must be lower or equals to the available amount of the wallet Note: In cents |
|
fee Integer |
Currency Required : yes Validation: Between 0 and the amount's transferFee will be deducted from the amountby Default 0 |
|
escrowDate Date |
Escrow date Required : no If sourceId is set, the escrowDate must be equal to or greater than the transaction capture date plus 5 daysIf sourceId is not set, tomorrow or later |
|
sourceId String (36) |
Identifier of the transfer source Required : no Validation: Authorized for merchant |
|
sourceType String |
Currency Required : yes (if the HTTP parameter sourceId is set) Values : TRANSACTION |
|
transferGroup String |
Identifier of the transfer group Required : no Validation : .{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. |
HTTP Request
POST https://test-api.centralpay.net/v2/rest/transfer
HTTP Response
OBJ Json transfer type
Example of curl code
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=2019-05-23
Back to JSON Format
{
"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,
"escrowDate":"2019-05-23",
"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId":null,
"transferGroup":"transferGroup000000",
"description":"Création transfer",
"status":"PENDING",
"transferReversals":[],
"reversed":false,
"movementId":"c0a867d9-65b3-4131-b38b-efb0b37bb0ac",
"cancelMovementId":null,
"cancellationDate":null,
"additionalData":{"transfer":"transfer"}}
HTTP Request
POST https://test-api.centralpay.net/v2/rest/transfer/<transferId>
HTTP Response
OBJ Json Transfer type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transfer/43626afd-e8c5-4c42-a130-d40cdf97df2b \
-u 'doctest:4I9HJRTd' \
-d additionalData=[transfer]transfer
Back to Json format
{
"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,
"escrowDate":"2019-05-23",
"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId":null,
"transferGroup":"transferGroup000000",
"description":"Création transfer",
"status":"PENDING",
"transferReversals":[],
"reversed":false,
"movementId":"c0a867d9-65b3-4131-b38b-efb0b37bb0ac",
"cancelMovementId":null,
"cancellationDate":null,
"additionalData":{"transfer":"transfer"}}
Update a Transfer
This function allows you to update a transfer.
| 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 |
| transferGroup String |
Fee amount of the payment
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. |
HTTP Request
POST https://test-api.centralpay.net/v2/rest/transfer/<transferId>
HTTP Response
OBJ Json Transfer type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transfer/43626afd-e8c5-4c42-a130-d40cdf97df2b \
-u 'doctest:4I9HJRTd' \
-d additionalData=[transfer]transfer
Back to Json format
{
"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,
"escrowDate":"2019-05-23",
"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId":null,
"transferGroup":"transferGroup000000",
"description":"Création transfer",
"status":"PENDING",
"transferReversals":[],
"reversed":false,
"movementId":"c0a867d9-65b3-4131-b38b-efb0b37bb0ac",
"cancelMovementId":null,
"cancellationDate":null,
"additionalData":{"transfer":"transfer"}}
HTTP Request
POST https://test-api.centralpay.net/v2/rest/transfer/<transferId>/cancel
HTTP Response
OBJ Json Transfer type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transfer/43626afd-e8c5-4c42-a130-d40cdf97df2b/cancel \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"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,
"escrowDate":"2019-05-23",
"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId":null,
"transferGroup":"transferGroup000000",
"description":"Création transfer",
"status":"CANCEL",
"transferReversals":[],
"reversed":false,
"movementId":"c0a867d9-65b3-4131-b38b-efb0b37bb0ac",
"cancelMovementId":"9f9071ad-ad57-41ff-ba4f-01eb85926942",
"cancellationDate":"2018-08-03T17:44:38.885+02:00",
"additionalData":{"transfer":"transfer"}}
Cancel a Transfer
This function allows you to cancel a transfer with the transfer ID
|
transferId (URL) UUID (36) |
CentralPay ID of the Transfer
Required: yes Validation: Existing UUID belong to the merchant |
HTTP Request
POST https://test-api.centralpay.net/v2/rest/transfer/<transferId>/cancel
HTTP Response
OBJ Json Transfer type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transfer/43626afd-e8c5-4c42-a130-d40cdf97df2b/cancel \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"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,
"escrowDate":"2019-05-23",
"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId":null,
"transferGroup":"transferGroup000000",
"description":"Création transfer",
"status":"CANCEL",
"transferReversals":[],
"reversed":false,
"movementId":"c0a867d9-65b3-4131-b38b-efb0b37bb0ac",
"cancelMovementId":"9f9071ad-ad57-41ff-ba4f-01eb85926942",
"cancellationDate":"2018-08-03T17:44:38.885+02:00",
"additionalData":{"transfer":"transfer"}}
HTTP Request
GET https://test-api.centralpay.net/v2/rest/transfer/<transferId>
HTTP Response
OBJ Json Transfer type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transfer/43626afd-e8c5-4c42-a130-d40cdf97df2b \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"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,
"escrowDate":"2019-05-23",
"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId":null,
"transferGroup":"transferGroup000000",
"description":"Création transfer",
"status":"CANCEL",
"transferReversals":[],
"reversed":false,
"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 Tranfer
This function allows you to retrieve a transfer with the transfert ID.
| transferId (URL) transferId |
CentralPay ID of the Transfer Required: yes Validation: Existing UUID belong to the merchant |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/transfer/<transferId>
HTTP Response
OBJ Json Transfer type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transfer/43626afd-e8c5-4c42-a130-d40cdf97df2b \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"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,
"escrowDate":"2019-05-23",
"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId":null,
"transferGroup":"transferGroup000000",
"description":"Création transfer",
"status":"CANCEL",
"transferReversals":[],
"reversed":false,
"movementId":"c0a867d9-65b3-4131-b38b-efb0b37bb0ac",
"cancelMovementId":"9f9071ad-ad57-41ff-ba4f-01eb85926942",
"cancellationDate":"2018-08-03T17:44:38.885+02:00",
"additionalData":{"transfer":"transfer"}}
HTTP Request
GET https://test-api.centralpay.net/v2/rest/transfer
HTTP Response
List OBJ Json transfer type
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/transfer?status=PENDING \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list":[{"transferId":"937c23b3-f762-4c08-87c4-360717c59e0f",
"creationDate":"2018-08-07T10:09:18.612+02:00",
"merchantTransferId":null,
"currency":"EUR",
"amount":1,
"fee":0,
"net":1,
"escrowDate":"2019-10-01",
"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId":"c985f487-f8db-4691-91a8-d1e4369fcbca",
"sourceType":"TRANSACTION",
"transferGroup":null,
"description":null,
"status":"PENDING",
"transferReversals":[],
"reversed":false,
"movementId":"7529d128-dca3-4569-be96-fcd887c21bbf",
"cancelMovementId":null,
"cancellationDate":null,
"additionalData":{}}],
"totalCount":1}
List Transfer
This function allows you to search objects from a multi-criteria search.
« Transfer » specific parameters
| merchantTransferId String (100) |
Merchant transfert ID Required: no |
| destinationWalletID UUID (36) |
Destination Wallet IDRequired: no |
| transferGroup String (100) |
Transfer groupRequired: no |
| status Enum TransferStatus |
Transfer status Required: no Validation: PENDING | TRANSFERRED | CANCEL |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/transfer
HTTP Response
List OBJ Json transfer type
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/transfer?status=PENDING \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list":[{"transferId":"937c23b3-f762-4c08-87c4-360717c59e0f",
"creationDate":"2018-08-07T10:09:18.612+02:00",
"merchantTransferId":null,
"currency":"EUR",
"amount":1,
"fee":0,
"net":1,
"escrowDate":"2019-10-01",
"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"sourceId":"c985f487-f8db-4691-91a8-d1e4369fcbca",
"sourceType":"TRANSACTION",
"transferGroup":null,
"description":null,
"status":"PENDING",
"transferReversals":[],
"reversed":false,
"movementId":"7529d128-dca3-4569-be96-fcd887c21bbf",
"cancelMovementId":null,
"cancellationDate":null,
"additionalData":{}}],
"totalCount":1}
TransferReversal
The Json "TransferReversal" Object
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 transferReversal |
| 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 |
HTTP Request
POST https://test-api.centralpay.net/v2/rest/transferReversal
HTTP Response
OBJ Json transferReversal type
Example of curl code
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
Back to JSON Format
{
"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":{}}
Create a transferReversal
This function allows you to create a transferReversal
|
transferId String |
Identifier of the transfer Required : yes Validation : UUID Format Transfer status must be TRANSFERRED |
| merchantTransferReversalId Wallet |
Identifier of the merchant Required : no Validation : .{0,100} |
| amount Integer |
Amount to reverse
Required: no
Note: In cents |
|
refundFee Boolean |
Indicates whether the transfer fee is refunded Required : noBy Default true |
|
description String (256) |
Description Required : no Validation: .{0,256} |
|
additionalData String (256) |
Merchant data Required: no Sample: additionalData=[Key]Value Note : max 25 |
HTTP Request
POST https://test-api.centralpay.net/v2/rest/transferReversal
HTTP Response
OBJ Json transferReversal type
Example of curl code
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
Back to JSON Format
{
"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":{}}
HTTP Request
POST https://test-api.centralpay.net/v2/rest/transferReversal/<transferReversalId>
HTTP Response
OBJ Json TransferReversal type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transferReversal/e1140714-b59f-44f3-910d-2195ac61a106 \
-u 'doctest:4I9HJRTd' \
-d description=Description_Updated_1
Back to Json format
{
"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.
| 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. |
HTTP Request
POST https://test-api.centralpay.net/v2/rest/transferReversal/<transferReversalId>
HTTP Response
OBJ Json TransferReversal type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transferReversal/e1140714-b59f-44f3-910d-2195ac61a106 \
-u 'doctest:4I9HJRTd' \
-d description=Description_Updated_1
Back to Json format
{
"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":{}}
HTTP Request
GET https://test-api.centralpay.net/v2/rest/transferReversal/<transferReversalId>
HTTP Response
OBJ Json TransferReversal type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transferReversal/e1140714-b59f-44f3-910d-2195ac61a106 \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"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
| transferReversalId (URL) transferReversalId |
CentralPay identifier of the transfer reversal Required: yes Validation: UUID Format Existing UUID belong to the merchant |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/transferReversal/<transferReversalId>
HTTP Response
OBJ Json TransferReversal type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transferReversal/e1140714-b59f-44f3-910d-2195ac61a106 \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"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":{}}
HTTP Request
GET https://test-api.centralpay.net/v2/rest/transferReversal
HTTP Response
List OBJ Json transferReversal type
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/transferReversal?merchantTransferReversalId=test \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"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.
| merchantTransferReversalId String (100) |
Identifier of the merchant Required: noValidation : .{0,100} |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/transferReversal
HTTP Response
List OBJ Json transferReversal type
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/transferReversal?merchantTransferReversalId=test \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"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}
Payout
A "Payout" is moving money from Centralpay to the merchant's bank account for a specific currency.
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 , TRANSFER_ORDER_SENT , PAID , FAILED , CANCEL. |
|
| cancellationDate OffsetDateTime |
Cancellation date |
|
| failureType String |
Failure type Possible values: REVOCATION, REJECT, REFUSAL, REQUEST_FOR_CANCELLATION, REVERSAL, RETURN, REFUND. |
|
| 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 |
|
| failureMovementId String(36) |
Failure movement identifier Note: UUID Format |
|
| cancelMovementId String(36) |
Cancel movement identifier Note: UUID Format |
|
| additionalData[*] Map |
Merchant data |
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/payout \
-u 'doctest:4I9HJRTd' \
-d merchantPayoutId='test fmi' \
-d currency=EUR \
-d amount=1 \
-d description='payout service creation'
Back to JSON Format
{
"payoutId":"2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate":"2018-08-03T17:58:07.681+02:00",
"merchantPayoutId":"test fmi",
"currency":"EUR",
"amount":1,
"destinationBankAccountId":"cb40425a-8e61-4486-b88f-c568fd45d057",
"description":"payout service creation",
"status":"PENDING",
"cancellationDate":null,
"automatic":false,
"expectedArrivalDate":"2018-08-08",
"arrivalDate":null,
"payoutReference":"PAYOUT-1533311887663",
"movementId":"f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"failureMovementId":null,
"cancelMovementId":null,
"additionalData":{}}
Create a payout
This service allows you to create a payout.
Note: The create payout service, it can be called once a day, by merchant by currency .
|
merchantPayoutId String |
Identifier of the Merchant Required : no Min length : 0Max length : 100 |
| 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 merchant Required : noAuthorized by the merchantThe currency of the destination bank account must be equal to currency settedIf you dont set this HTTP parameter, the default value will be the default bank account of currency settedNote: UUID Format |
|
description String |
Description Required : noMin length : 0Max length : 256 |
|
payoutReference String |
Payout reference Required : no Min length : 1Max length : 35 If you dont set this HTTP parameter, the default value will be equal to PAYOUT-currentTimeMillis |
|
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. |
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/payout \
-u 'doctest:4I9HJRTd' \
-d merchantPayoutId='test fmi' \
-d currency=EUR \
-d amount=1 \
-d description='payout service creation'
Back to JSON Format
{
"payoutId":"2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate":"2018-08-03T17:58:07.681+02:00",
"merchantPayoutId":"test fmi",
"currency":"EUR",
"amount":1,
"destinationBankAccountId":"cb40425a-8e61-4486-b88f-c568fd45d057",
"description":"payout service creation",
"status":"PENDING",
"cancellationDate":null,
"automatic":false,
"expectedArrivalDate":"2018-08-08",
"arrivalDate":null,
"payoutReference":"PAYOUT-1533311887663",
"movementId":"f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"failureMovementId":null,
"cancelMovementId":null,
"additionalData":{}}
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/payout/2351c9fd-d09c-4bfb-a190-f87b2a458214 \
-u 'doctest:4I9HJRTd' \
-d merchantPayoutId=Up_test_fmi
Back to Json format
{
"payoutId":"2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate":"2018-08-03T17:58:07.681+02:00",
"merchantPayoutId":"Up_test_fmi",
"currency":"EUR","amount":1,
"destinationBankAccountId":"cb40425a-8e61-4486-b88f-c568fd45d057",
"description":"payout service creation",
"status":"PENDING","cancellationDate":null,
"automatic":false,"expectedArrivalDate":"2018-08-08",
"arrivalDate":null,"payoutReference":"PAYOUT-1533311887663",
"movementId":"f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"failureMovementId":null,"cancelMovementId":null,
"additionalData":{}
}Update a payout
This function allows you to update a payout.
| 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. |
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/payout/2351c9fd-d09c-4bfb-a190-f87b2a458214 \
-u 'doctest:4I9HJRTd' \
-d merchantPayoutId=Up_test_fmi
Back to Json format
{
"payoutId":"2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate":"2018-08-03T17:58:07.681+02:00",
"merchantPayoutId":"Up_test_fmi",
"currency":"EUR","amount":1,
"destinationBankAccountId":"cb40425a-8e61-4486-b88f-c568fd45d057",
"description":"payout service creation",
"status":"PENDING","cancellationDate":null,
"automatic":false,"expectedArrivalDate":"2018-08-08",
"arrivalDate":null,"payoutReference":"PAYOUT-1533311887663",
"movementId":"f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"failureMovementId":null,"cancelMovementId":null,
"additionalData":{}
}Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/payout/2351c9fd-d09c-4bfb-a190-f87b2a458214/cancel \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"payoutId":"2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate":"2018-08-03T17:58:07.681+02:00",
"merchantPayoutId":"Up_test_fmi",
"currency":"EUR",
"amount":1,
"destinationBankAccountId":"cb40425a-8e61-4486-b88f-c568fd45d057",
"description":"payout service creation",
"status":"CANCEL",
"cancellationDate":"2018-08-03T18:01:33.027+02:00",
"automatic":false,
"expectedArrivalDate":"2018-08-08",
"arrivalDate":null,
"payoutReference":"PAYOUT-1533311887663",
"movementId":"f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"failureMovementId":null,
"cancelMovementId":"cbfff894-be8b-4e90-8a43-9a62ad481859",
"additionalData":{}
}
Cancel a payout
This service allows you to cancel a payout with the payout ID
|
payoutId (URL) UUID (36) |
CentralPay ID of the Payout
Required: yes Validation: Existing UUID belong to the merchant |
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/payout/2351c9fd-d09c-4bfb-a190-f87b2a458214/cancel \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"payoutId":"2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate":"2018-08-03T17:58:07.681+02:00",
"merchantPayoutId":"Up_test_fmi",
"currency":"EUR",
"amount":1,
"destinationBankAccountId":"cb40425a-8e61-4486-b88f-c568fd45d057",
"description":"payout service creation",
"status":"CANCEL",
"cancellationDate":"2018-08-03T18:01:33.027+02:00",
"automatic":false,
"expectedArrivalDate":"2018-08-08",
"arrivalDate":null,
"payoutReference":"PAYOUT-1533311887663",
"movementId":"f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"failureMovementId":null,
"cancelMovementId":"cbfff894-be8b-4e90-8a43-9a62ad481859",
"additionalData":{}
}
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/payout/2351c9fd-d09c-4bfb-a190-f87b2a458214 \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"payoutId":"2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate":"2018-08-03T17:58:07.681+02:00",
"merchantPayoutId":"Up_test_fmi",
"currency":"EUR",
"amount":1,
"destinationBankAccountId":"cb40425a-8e61-4486-b88f-c568fd45d057",
"description":"payout service creation",
"status":"CANCEL",
"cancellationDate":"2018-08-03T18:01:33.027+02:00",
"automatic":false,
"expectedArrivalDate":"2018-08-08",
"arrivalDate":null,
"payoutReference":"PAYOUT-1533311887663",
"movementId":"f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"failureMovementId":null,
"cancelMovementId":"cbfff894-be8b-4e90-8a43-9a62ad481859",
"additionalData":{}
}
Retrieve a payout
This service allows you to retrieve a payout with the payout ID.
| payoutId UUID (36) |
CentralPay ID of the payout Required: yes Validation: UUID |
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/payout/2351c9fd-d09c-4bfb-a190-f87b2a458214 \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"payoutId":"2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate":"2018-08-03T17:58:07.681+02:00",
"merchantPayoutId":"Up_test_fmi",
"currency":"EUR",
"amount":1,
"destinationBankAccountId":"cb40425a-8e61-4486-b88f-c568fd45d057",
"description":"payout service creation",
"status":"CANCEL",
"cancellationDate":"2018-08-03T18:01:33.027+02:00",
"automatic":false,
"expectedArrivalDate":"2018-08-08",
"arrivalDate":null,
"payoutReference":"PAYOUT-1533311887663",
"movementId":"f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"failureMovementId":null,
"cancelMovementId":"cbfff894-be8b-4e90-8a43-9a62ad481859",
"additionalData":{}
}
HTTP Request
GET https://test-api.centralpay.net/v2/rest/payout
HTTP Response
List OBJ Json payout type
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/payout?merchantPayoutId=Up_test_fmi \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list":[{"payoutId":"2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate":"2018-08-03T17:58:07.681+02:00",
"merchantPayoutId":"Up_test_fmi",
"currency":"EUR",
"amount":1,
"destinationBankAccountId":"cb40425a-8e61-4486-b88f-c568fd45d057",
"description":"payout service creation",
"status":"CANCEL",
"cancellationDate":"2018-08-03T18:01:33.027+02:00",
"automatic":false,
"expectedArrivalDate":"2018-08-08",
"arrivalDate":null,
"payoutReference":"PAYOUT-1533311887663",
"movementId":"f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"failureMovementId":null,
"cancelMovementId":"cbfff894-be8b-4e90-8a43-9a62ad481859",
"additionalData":{}}],
"totalCount":1}
List payouts
This service allows you to search objects from a multi-criteria search.
« 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 |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/payout
HTTP Response
List OBJ Json payout type
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/payout?merchantPayoutId=Up_test_fmi \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list":[{"payoutId":"2351c9fd-d09c-4bfb-a190-f87b2a458214",
"creationDate":"2018-08-03T17:58:07.681+02:00",
"merchantPayoutId":"Up_test_fmi",
"currency":"EUR",
"amount":1,
"destinationBankAccountId":"cb40425a-8e61-4486-b88f-c568fd45d057",
"description":"payout service creation",
"status":"CANCEL",
"cancellationDate":"2018-08-03T18:01:33.027+02:00",
"automatic":false,
"expectedArrivalDate":"2018-08-08",
"arrivalDate":null,
"payoutReference":"PAYOUT-1533311887663",
"movementId":"f026052c-0bfc-4c5b-b7e0-a8a88f10a78b",
"failureMovementId":null,
"cancelMovementId":"cbfff894-be8b-4e90-8a43-9a62ad481859",
"additionalData":{}}],
"totalCount":1}