PLATFORM

Plateform

HTTP Request

POST https://test-api.centralpay.net/v2/rest/payout/byMarketplace

HTTP Response

OBJ Json payout type

Example of curl code

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'

Back to JSON Format

{
    "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 .

HTTP PARAMETERS
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 Validation: Key: .{45} - Value: .{256} 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/payout/byMarketplace

HTTP Response

OBJ Json payout type

Example of curl code

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'

Back to JSON Format

{
    "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.

HTTP Request

POST https://test-api.centralpay.net/v2/rest/wallets

BODY Parameters
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

BODY Parameters
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

HTTP Parameters
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

Body Parameters
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 Note: GET /api/nauth/enrollment-claim/activity-sector
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 Constraint: ^[a-zA-Z0-9\\p{L} ´'\\-]{1,255}$
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: Default true
allowedEmailCommunication bool	Allow mails communication. When value is false, no email is sent from the onboarding plateform Required : no Note: Default true
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