CORE FUNCTIONS
CentralPay provides a powerful payment processing API, enabling you to process multi-channel transactions at local and/or international levels.
There is currently no content classified with this term.
Introduction
CentralPay API is a REST based API that allows a fast and easy integration of the payment forms. The API uses HTTP to transport and return all responses encoded in JSON.
To simplify integration and testing, CentralPay provides a sandbox where you can carry out your tests.
Authorisations are simulated in test mode.
Test and production modes can be active at the same time - each mode having separate set of public keys and two API ENDPOINT.
We ensure that the data created in test mode will never reach your customers nor cost you any money.
API ENDPOINT
The following link is the core link used to test the API: https://test-api.centralpay.net/
Presentation
The purpose of this document is to present the features of the CentralPay REST API.
By using our Tokenization service and Token.js, sensitive data will not be handled on your servers. The service is fully secure and simplifies your obligations to comply with PCI DSS rules.
2 integration methods are available:
- Push & Pay and Smart Form: Ready-to-use services with automation and pre-integrated functions .
- Custom form: A set of tools that allows you to design your own payment form using our Token.js instructions.
Creation of "Customer" and "Card"
- "Customer" and "Card" allow you to perform recurring payments and track multiple transactions associated with a unique customer.
Marketplace & Plateforme features
- Advanced features to manage marketplaces
- Creation of sub-merchants with attributes management
- Access to a back office that allows to perform transactions analysis and export the results
This new architecture of the API allows us to continuously improve the platform's functionalities and offer new features such as:
- More information on cardholders (issuing country, type of card, category, etc.)
- Directing transactions to specific acquiring accounts
- Fraud detection
- Management of recurring payments
- Managing complex business rules
- Automation system with templates and prefifined actions.
Glossary
| cardTokenId | A dematerialized token of the credit card valid for 5 minutes. |
| Transaction | An accepted, refused or abandoned credit card transaction made by a Buyer |
| PoS | A physical, mobile, or online Point of Sale |
| Customer | A consumer or buyer for which means of payment have been registered |
| Card | A Payment Card : VISA, Visa Electron, Mastercard, Maestro, American Express, Diners, ... |
| Contrat | A Merchant Contract recognized by the card schemes identifying the transactions perfomed |
| Wallet |
A Wallet storing the monetary value |
Service access
The test platform url is: https://test-api.centralpay.net/v2/rest/
This test platform allows you to test all the services explained within this documentation.
CentralPay will provide you with connection logs to execute the existing functions.
Functions
All functions use the « MIME » type: "application/x-www-form-urlencoded".
Functions use the following methods:
- HTTP POST method for object creation or update
- HTTP GET method for object search
Authentication
CentralPay API uses "HTTP Basic authentication" for authentication. All requests to our API have to be authenticated (provide the username and the password given by the platform) and have to be made over HTTPS.
If you only plan on using Pop-in forms, you only need to use your "API Secret Key".
You can find your Secret Key in your account settings once you log into your account.
HTTP Request
Always use HTTP-Header for serialization formats (user_agent, ...)
The Content-Type (application/x-www-form-urlencoded or multipart/form-data) must be inquire for all the request in the header.
The use of the « Idempotence-Key » field in the HTTP header request allows to authenticate the request that has been sent.
If the same « Idempotence-Key » value is sent again, the request will be considered as already processed and will not be triggered again.
This check allows the merchant to avoid sending duplicate entries.
Note: The key of « Idempotence-Key » is valid for 24 hours.
HTTP Response
In each HTTP Response, the « Request-Id » field is written in the HTTP header.
Note: If you have a specific request to be sent via CentralPay REST API, please provide us with this information.
Test tools
All functions described in the documentation can be executed with a HTML form (See examples provided in the documentation)
In order to test CentralPay services, different tools are available to check the behaviour of the API (example: Firefox Rest Easy plugin).
Searching methods
Searching methods are the same for all objects.
Requests can use either common or specific parameters.
HTTP Request
GET https://test-api.centralpay.net/v2/rest/<type_objet>/<id_objet>
HTTP Response
OBJ Json <type_objet> type
Retrieve a single object
This function allows you to retrieve objects with the object ID.
| <id_objet> UUID (36) |
CentralPay object ID Required: yes Validation: UUID |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/<type_objet>/<id_objet>
HTTP Response
OBJ Json <type_objet> type
Retrieve multiple objects
This function allows you to search objects with multiple criteria.
Note: The field « totalCount » displays the total number of objects found from the search request.
Common parameters
| before Date ISO 8601 |
Before this date (included) Required: no Note: Included |
| after Date ISO 8601 |
After this date (included) Required: no Note: Included |
| limit Integer |
Maximum number of T Required: no Validation: > 0 and <= 100 Note: 10 by default |
| page Integer |
Page number Required: no Validation: > 0 Note: 1st page by default |
Hooks & Events
Webhook are set to receive Event notification when an action took place.
For example creation of new successful Transaction will result in TRANSACTION_CAPTURED event.
Each event belongs to an existing object:
- TRANSACTION_XXXX belongs to the TRANSACTION object.
- REFUND_XXXX belongs to the REFUND object.
- CUSTOMER_XXXX belongs to the CUSTOMER object.
For each event triggered by a change in the objet, you receive an update posted in JSON format.
You can simply create a page on your website and submit the appropriate URL of that page on your account. Then, each time a new event is created we will call your page back with information about the event.
When a new event is created we will POST to each configured webhook URL. Event data are encoded as JSON and are sent in request body.
To acknowledge receipt of a webhook, your endpoint should return a 2xx HTTP status code. Any other information returned in the request headers or request body is ignored. All response codes outside this range, including 3xx codes, will indicate to CentralPay that you did not receive the webhook. This means that a URL redirection or a "Not Modified" response will be treated as a failure. If your endpoint returns another value that a 2xx status code, we will send it again every 5 minutes during 2 hours.
Event Service
« Event» is a service used in the hook mecanism.
|
eventId String (36) |
Event identifier Note: UUID Format |
| type String |
Event type are always linked to an existing object
Note: For a list of hooks you can see it here |
| creationDate String |
Creation date Note: ISO 8601 |
| requestId String (36) |
Request Identifier
Note: UUID Format Request-Id HTTP Response header
|
| object |
Event Object Note: Depends of event type, for example it will be a JSON "transaction object" if the event type is "TRANSACTION_CAPTURED" |
Wallet
Wallet is an account with many currencies
HTTP Request
GET https://test-api.centralpay.net/v2/rest/wallet
HTTP Response
OBJ Json wallet type
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/wallet \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"available":[{"amount":10,"currency":"EUR"}],
"pending":[{"amount":9,"currency":"EUR"}]}
Retrieve a wallet
This service allows you to retrieve a wallet with the wallet ID. All the paramers used to search must be passed in the form of queries parameters.
| walletId UUID (36) |
CentralPay ID of the wallet Required: no Validation: UUID Wallet of the connected merchant or wallet of one of his sub-merchants By default, the wallet of the connected merchant |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/wallet
HTTP Response
OBJ Json wallet type
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/wallet \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"available":[{"amount":10,"currency":"EUR"}],
"pending":[{"amount":9,"currency":"EUR"}]}
Wallet Object
The Json "Wallet" Object
The "Wallet" object response represents a wallet situation at the moment
|
available List<WalletItem> |
Wallet available amounts |
| currency String |
Currency Note: Favourite format |
| amount Integer |
Amount Note: in cents |
| pending List<WalletItem> |
Wallet pending amounts Note: |
| currency String |
Currency Note: Favourite format |
| amount Integer |
Amount Note: in cents |
Movement
The movement are all the bank operation that happen in your wallet, with amount, fee and source associated.
HTTP Request
GET https://test-api.centralpay.net/v2/rest/movement/{{movementId}}
HTTP Response
OBJ Json wallet type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/movement/2cec85cc-5501-4516-9bdc-a31bdd47d79b \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"movementId": "2cec85cc-5501-4516-9bdc-a31bdd47d79b",
"creationDate": "2020-10-06T12:45:50.756330+02:00",
"expectedAvailabilityDate": "2020-10-08",
"availableDate": "2020-10-08",
"sourceId": "e0a3e218-4f13-4d85-9510-744ae8f0a0d6",
"emissionWalletId": null,
"amount": 1000,
"fee": 0,
"net": 1000,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": ""
}
Retrieve Movement
This service allows you to retrieve the movement in your account with the movement ID. All the paramers used to search must be passed in the form of queries parameters.
| movementId UUID (36) |
CentralPay ID of the movement Required: yes Validation: UUID |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/movement/{{movementId}}
HTTP Response
OBJ Json wallet type
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/movement/2cec85cc-5501-4516-9bdc-a31bdd47d79b \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"movementId": "2cec85cc-5501-4516-9bdc-a31bdd47d79b",
"creationDate": "2020-10-06T12:45:50.756330+02:00",
"expectedAvailabilityDate": "2020-10-08",
"availableDate": "2020-10-08",
"sourceId": "e0a3e218-4f13-4d85-9510-744ae8f0a0d6",
"emissionWalletId": null,
"amount": 1000,
"fee": 0,
"net": 1000,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": ""
}
HTTP Request
GET https://test-api.centralpay.net/v2/rest/movement
HTTP Response
List OBJ Json movement type
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/movement \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"list": [
{
"type": "MOVEMENT",
"movementId": "5c086774-8939-4a1a-866d-81a4435afa5e",
"creationDate": "2020-11-10T04:02:20.347647+01:00",
"expectedAvailabilityDate": "2020-11-12",
"availableDate": "2020-11-12",
"sourceId": "bc57e362-510f-4196-b13f-44d818148c80",
"emissionWalletId": null,
"amount": 2990,
"fee": 0,
"net": 2990,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": ""
},
{
"type": "MOVEMENT",
"movementId": "2decb7fd-0926-4a06-9642-536bef7498f6",
"creationDate": "2020-11-10T04:02:20.241197+01:00",
"expectedAvailabilityDate": "2020-11-12",
"availableDate": "2020-11-12",
"sourceId": "bc57e362-510f-4196-b13f-44d818148c80",
"emissionWalletId": null,
"amount": 0,
"fee": 0,
"net": 0,
"currency": "EUR",
"status": "AVAILABLE",
"type": "AUTHORIZATION",
"description": ""
}
],
"totalCount": 54531
}List Movement
This function allows you to retrieve all the movements registerered in your account.
| currency String (3) |
currency of the movement Required: no |
|
expectedAvailabilityDateBefore localDate |
Before the expectedAvailabilityDate, this date included.Required: no |
|
expectedAvailabilityDateAfter localeDate |
After the expectedAvailabilityDate, this date included.Required: no |
|
availableDateBefore localeDate |
Before the availableDate, this date included.Required: no |
| availableDateAfter LocalDate |
After the availableDate, this date included. Required: no |
| status Enum MovementStatus |
Arrival date
Required: no Validation: PENDING | PAID | CANCEL
|
| type Enum MovementType |
Payout status Required: no Validation: see the different type in the object. |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/movement
HTTP Response
List OBJ Json movement type
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/movement \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"list": [
{
"type": "MOVEMENT",
"movementId": "5c086774-8939-4a1a-866d-81a4435afa5e",
"creationDate": "2020-11-10T04:02:20.347647+01:00",
"expectedAvailabilityDate": "2020-11-12",
"availableDate": "2020-11-12",
"sourceId": "bc57e362-510f-4196-b13f-44d818148c80",
"emissionWalletId": null,
"amount": 2990,
"fee": 0,
"net": 2990,
"currency": "EUR",
"status": "AVAILABLE",
"type": "TRANSACTION",
"description": ""
},
{
"type": "MOVEMENT",
"movementId": "2decb7fd-0926-4a06-9642-536bef7498f6",
"creationDate": "2020-11-10T04:02:20.241197+01:00",
"expectedAvailabilityDate": "2020-11-12",
"availableDate": "2020-11-12",
"sourceId": "bc57e362-510f-4196-b13f-44d818148c80",
"emissionWalletId": null,
"amount": 0,
"fee": 0,
"net": 0,
"currency": "EUR",
"status": "AVAILABLE",
"type": "AUTHORIZATION",
"description": ""
}
],
"totalCount": 54531
}Movement Object
| movementId UUID |
Movement's id |
| creationDate LocalDate |
The date of creation of the movement |
| currency String (3) |
Currency of movement |
| amount Integer |
Gross amount |
| fee Integer |
fee |
| net Integer |
Net amount |
| description String |
Description |
| expectedAvailabilityDate LocalDate |
planned date of avaibility |
| availableDate LocalDate |
real date of availibility |
| status Enum MovementStatus |
Status of the movement Note: PENDING | PAID | CANCEL |
| sourceId UUID |
UUID of the original object |
| type Enum MovementType |
type of the movement
Note: TRANSACTION | TRANSACTION_CANCEL | REFUND | REFUND_CANCEL | DISPUTE | DISPUTE_WON | TRANSFER | TRANSFER_CANCEL | TRANSFER_REVERSAL | PAYOUT | PAYOUT_CANCEL | PAYOUT_FAILURE | DEPOSIT | WIRE_TRANSFER | WIRE_TRANSFER_CANCEL | CREDIT | CREDIT_CANCEL| CUSTOMER_CREATION | AUTHORIZATION
|
| emissionWalletId UUID |
Wallet of emission of the movement Note : used in the actions with a double movement (transfer and transferReversal) |
PAYMENT
Single Payment
A one-off transaction is a transaction that uses a debit/credit card for a single payment. There are two ways to process a debit/credit card in a one-off transaction:
- Use the sub-object « Card[*] »: it is necessary to fill in all the information of the card,
OR
- Use the field « cardTokenId »: we use a unique token to identify the card
Note: in this case, "Card" can only be used once.
« RECURRING » Payment
To process recurring transactions, first create a "Customer" and one or several "Cards" associated to this "Customer":
- Create a « Customer » object: it acts like an e-wallet including one or several cards (via token or not)
AND
- Use the « customerId » field: this links the payment to a client
Note: in this case, "Cards" can be used several times.
Card token
The Json "CardToken" object
The « CardToken » object represents a debit/credit card token.
Merchants usually want to be able to charge payment cards, IBAN or other without having to store sensitive data on their servers.
Token.js makes this easy in the browser, but you can use the same technique in other environments with our token API.
Tokens can be created with your publishable API key, which can safely be embedded in downloadable applications like iPhone and Android apps. You can then use a token anywhere in our API when a credit/debit card, bank account or any personal ID number is accepted.
| cardTokenId String (36) |
CentralPay token ID Note: UUID Format |
| creationDate String |
Creation date Note: ISO 8601 |
| card Card object |
Card Note: Refer to the JSON "Card" object |
| endUserIp String |
End-user IP |
| status String |
Token use status Note: UNUSED | USED | EXPIRED |
Example of curl code
curl --location --request POST 'https://test-api.centralpay.net/v2/rest/cardToken' \
-H 'Origin: https://example.centralpay.net' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-u 'doctest:4I9HJRTd' \
-d 'card[number]=4000000000000002' \
-d 'card[cvc]=123' \
-d 'card[expirationMonth]=12' \
-d 'card[expirationYear]=2022' \
-d 'card[check]=true' \
-d 'merchantPublicKey=d4cd748bb30526f9c9ea7d15d376c88b96743776fc9ba76b24e4da295a136935'
Back to Json format
{
"cardTokenId": "36f50fea-d849-405d-bdd1-8c419332e925",
"creationDate": "2020-09-22T11:24:13.026906+02:00",
"card": {
"cardId": "e9390090-ac95-4560-a1d5-98edeb8b7ccd",
"creationDate": "2020-09-22T11:24:13.026906+02:00",
"customerId": null,
"cardTokenId": "36f50fea-d849-405d-bdd1-8c419332e925",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": true,
"additionalData": {}
},
"endUserIp": "91.229.230.41",
"status": "UNUSED"
}
Create a card token
This function allows you to create a token for the card.
Note: The card token has a 5-minute lifetime.
| card[*] * |
Card data Required: yes |
| merchantPublicKey String |
CentralPay Merchant's public key Required: yes Validation: [0-9a-f]{64} - Key needs to match with a merchant Note: This key is provided by CentralPay |
Example of curl code
curl --location --request POST 'https://test-api.centralpay.net/v2/rest/cardToken' \
-H 'Origin: https://example.centralpay.net' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-u 'doctest:4I9HJRTd' \
-d 'card[number]=4000000000000002' \
-d 'card[cvc]=123' \
-d 'card[expirationMonth]=12' \
-d 'card[expirationYear]=2022' \
-d 'card[check]=true' \
-d 'merchantPublicKey=d4cd748bb30526f9c9ea7d15d376c88b96743776fc9ba76b24e4da295a136935'
Back to Json format
{
"cardTokenId": "36f50fea-d849-405d-bdd1-8c419332e925",
"creationDate": "2020-09-22T11:24:13.026906+02:00",
"card": {
"cardId": "e9390090-ac95-4560-a1d5-98edeb8b7ccd",
"creationDate": "2020-09-22T11:24:13.026906+02:00",
"customerId": null,
"cardTokenId": "36f50fea-d849-405d-bdd1-8c419332e925",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": true,
"additionalData": {}
},
"endUserIp": "91.229.230.41",
"status": "UNUSED"
}
Exemple of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/cardToken/dee96de9-07b6-4a41-ac25-b6d5b849ea64 \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"cardTokenId": "dee96de9-07b6-4a41-ac25-b6d5b849ea64",
"creationDate": "2020-08-10T09:21:00.988634+02:00",
"card": {
"cardId": "0ea5450a-996f-4c64-ae0d-71f8a656f796",
"creationDate": "2020-08-10T09:21:00.988634+02:00",
"customerId": null,
"cardTokenId": "dee96de9-07b6-4a41-ac25-b6d5b849ea64",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"endUserIp": "172.31.1.71",
"status": "EXPIRED"
}
Retrieve card token
This function allows you to retrieve a Card Token with the CardTokenID.
| cardTokenId UUID (36) |
CentralPay card token ID Required: yes Validation: UUID |
Exemple of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/cardToken/dee96de9-07b6-4a41-ac25-b6d5b849ea64 \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"cardTokenId": "dee96de9-07b6-4a41-ac25-b6d5b849ea64",
"creationDate": "2020-08-10T09:21:00.988634+02:00",
"card": {
"cardId": "0ea5450a-996f-4c64-ae0d-71f8a656f796",
"creationDate": "2020-08-10T09:21:00.988634+02:00",
"customerId": null,
"cardTokenId": "dee96de9-07b6-4a41-ac25-b6d5b849ea64",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"endUserIp": "172.31.1.71",
"status": "EXPIRED"
}
Card token object
The Json "CardToken" object
The « CardToken » object represents a debit/credit card token
| cardTokenId String (36) |
CentralPay token ID Note: UUID Format |
| creationDate String |
Creation date Note: ISO 8601 |
| card Card object |
Card |
| endUserIp String |
End-user IP |
| status String |
Token use status Note: UNUSED | USED | EXPIRED |
Transaction
A "Transaction" is the processing of a debit/credit card. Transactions are identified by a unique TransactionID.
Example of curl code without transfer[]
curl -v https://test-api.centralpay.net/v2/rest/transaction \
-u 'doctest:4I9HJRTd' \
-d card[number]=4000000000000085 \
-d card[cvc]=123 \
-d card[expirationMonth]=1 \
-d card[expirationYear]=2022 \
-d currency=EUR \
-d amount=100 \
-d endUserIp=245.100.1.15 \
-d additionalData=[key1]value1 \
-d additionalData=[key2]value2
Back to JSON Format without transfer[]
{
"transactionId": "c3a548ca-39b7-48ca-8484-d0a45f928e53",
"creationDate": "2020-09-16T16:27:57.557200+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "63f046d6-d533-4cd6-a74e-1b1d75f146fc",
"creationDate": "2020-09-16T16:27:49.692939+02:00",
"customerId": null,
"cardTokenId": "d4c7e857-b13a-4677-bfa7-348bc3df96ee",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CAPTURED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"breakdownPerSubMerchant": [],
"transactiontransfers": [],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-16T16:27:58.125966+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "baeb623a-4007-4acb-9497-45f5d1beb02a",
"authorizationMovementId": "66478221-4565-46e5-af51-f176fa90275e",
"cancelMovementId": null,
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}
Example of curl code with transfer[]
curl -v https://test-api.centralpay.net/v2/rest/transaction \
-u 'doctest:4I9HJRTd' \
-d card[number]=4000000000000002 \
-d card[cvc]=123 \
-d card[expirationMonth]=10 \
-d card[expirationYear]=2023 \
-d currency=EUR \
-d amount=10 \
-d endUserIp=8.8.8.8 \
-d transfer[]='{"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171", "amount":1, "fee":0, "escrowDate":"2025-10-01"}'Back to JSON Format
{
"transactionId": "2a76e817-92db-41b8-8765-c28904c32eb6",
"creationDate": "2020-09-16T16:29:37.006548+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "7bd7ee30-43a3-4201-be52-8e2cf35f40cf",
"creationDate": "2020-09-16T16:29:11.603121+02:00",
"customerId": null,
"cardTokenId": "933ce581-790d-4133-87d4-9268537b9d15",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CAPTURED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"breakdownPerSubMerchant": [],
"transactiontransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-09-18",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-16T16:29:37.488715+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "17934603-6357-46be-8c29-0e264c19d7e5",
"authorizationMovementId": "5a859c5a-3dc6-471a-840d-e73b39295f02",
"cancelMovementId": null,
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}Create a transaction
This function allows you to create a transaction.
Single Payment
A single transaction is a one time only payment. There are two ways to configure a single payment:
- Use the « Card[*] » sub-object: it is necessary to enter all the information of the card
OR
- Use the « cardTokenId » field: a unique token to identify the card is required
Note: in this case, "Card" can only be used once.
Multiple Payment
To process a multiple transactions, it is first necessary to enroll the customer with one or several debit/credit cards:
- Creation of a « Customer » object: creation of an e-wallet with one or several debit/credit cards per customer (via token or not)
AND
- Use of the « customerId » field to link the payment to a client
Note: in this case, "Card" can be used more than one time.
Transaction Transfer
When you set the HTTP parameter transfer[] in the transaction creation service, you call automatically the transfer creation service
| currency String (3) |
Currency Required: yes Validation: ISO4217 alpha format or num [A-Z}{3}|[0-9]{3} Existing Authorised (for the contract) |
| amount Integer |
Total amount of the transaction
Required: yes
Note: In cents |
| customerId UUID (36) |
CentralPay client ID Required: conditional Validation: UUID - Existing - Authorised (for the user) |
| cardId UUID (36) |
CentralPay card ID Required: conditional Validation: UUID - Existing - Authorised (for the customer) Note: customerID required |
| cardTokenId UUID (36) |
CentralPay token ID Required: conditional Validation: UUID - Existing - Authorised (for the user) - Status UNUSED |
| card[*] |
Card data
Required: conditional Note: Refer to "Card" sub-object |
|
otp String |
OTP Validation Required: conditional |
|
cvcValidation String |
CVC Validation Required: conditional |
| merchantTransactionId String (100) |
Merchant ID Required: no Validation: .{0,100} |
| pointOfSaleId UUID (36) |
CentralPay POS ID Required: no Validation: UUID - Existing - Authorised for the user |
| contractId UUID (36) |
CentralPay contract ID Required: no Validation: UUID - Existing - Authorised for the PoS |
| source Enum source |
Payment source Required: no Validation: EC | MO | TO | DP Note: DP: Deposit |
| description String (256) |
Description Required: no Validation: .{0,256} |
| breakdownPerSubMerchant Json objects table |
Breakdown amounts by sub-merchant Required: no Validation: [{"subMerchantId":"value","subAmount":value,"subMerchantReference":"value"}, ...] Note: Amount in cents |
| capture Boolean |
Indicate if the transaction has to be debited
Required: no Notes: True by default Can not capture by default if the source is DP |
| country Country |
Merchant's Country Required: no Validation: ISO3166 in format alpha2, apha3 or num - [0-9]{3}|[A-Z]{2}|[A-Z]{3} - Existing |
|
endUserLanguage
|
End user's language Required: no Validation: ISO 639-2 (3 char) ou ISO 639-1 (2 char) Default value: ENG |
| receiptEmail String (255) |
Email to send the receipt Required: no Validation: Email Note: Receipt email sent to this address, once the transaction is debited. By default, if the transaction is linked to a client, that is the client's email that will be used. If this parameter is given, it is used instead of client's one. If endUserLanguage is not used, then default value applied |
|
subMerchantId Sring (36) |
Sub merchant ID Required: no
Note: Authorised for the merchant |
|
from Object |
Actor "Debit" Required: no Validation: UUID (36)
Note: Authorised for the merchant |
|
to Object |
Actor "Credit" Required: no Validation: UUID (36) or "me" Authorised for the merchant
Note: Keyword "me" for "merchant" |
|
rate Number |
Pay rates Required: no Validation: Between 0 and 100
Note: In percentage |
|
fees Number |
Fixed fees Required: no Validation: Between 0 and 9999999
Note: In cents |
|
remunerationSource Object |
Source of remuneration Required: no |
|
browserUserAgent |
HTTP header user-agent of the client's browser |
|
browserAcceptLanguage String (255) |
HTTP header accept-language of the client's browser |
| additionalData String (303) |
Merchant data
Required: no
Note: Number of key/value combinations because can take multiple keys and values. |
| endUserIp String (39) |
Card holder Ip address
Required: yes |
| order[*] | Data of the order
Required: no Note: Refer to "Order" sub-object |
| 3ds[*] | 3-D Secure data Required: no Note: Refer to "3ds" sub-object |
| transfer[] Json objects table |
Automatic transfer Required: no Json format: '{"destinationWalletId":"value", "amount":value, "fee":value, "merchantTransferId":"value", "escrowDate":"value"}' Refer to: The Json "Transaction Transfer" Validations: The transaction must be captured. The sum of (amount transfer - fee transfer) must be less than or equal to the payoutAmount transaction. Notes: Amount in cents You can add as many transfer parameters as you need. Transfers are created in a queue and executed asynchronously |
| transferGroup String (100) |
Transfer group identifier |
Example of curl code without transfer[]
curl -v https://test-api.centralpay.net/v2/rest/transaction \
-u 'doctest:4I9HJRTd' \
-d card[number]=4000000000000085 \
-d card[cvc]=123 \
-d card[expirationMonth]=1 \
-d card[expirationYear]=2022 \
-d currency=EUR \
-d amount=100 \
-d endUserIp=245.100.1.15 \
-d additionalData=[key1]value1 \
-d additionalData=[key2]value2
Back to JSON Format without transfer[]
{
"transactionId": "c3a548ca-39b7-48ca-8484-d0a45f928e53",
"creationDate": "2020-09-16T16:27:57.557200+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "63f046d6-d533-4cd6-a74e-1b1d75f146fc",
"creationDate": "2020-09-16T16:27:49.692939+02:00",
"customerId": null,
"cardTokenId": "d4c7e857-b13a-4677-bfa7-348bc3df96ee",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CAPTURED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"breakdownPerSubMerchant": [],
"transactiontransfers": [],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-16T16:27:58.125966+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "baeb623a-4007-4acb-9497-45f5d1beb02a",
"authorizationMovementId": "66478221-4565-46e5-af51-f176fa90275e",
"cancelMovementId": null,
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}
Example of curl code with transfer[]
curl -v https://test-api.centralpay.net/v2/rest/transaction \
-u 'doctest:4I9HJRTd' \
-d card[number]=4000000000000002 \
-d card[cvc]=123 \
-d card[expirationMonth]=10 \
-d card[expirationYear]=2023 \
-d currency=EUR \
-d amount=10 \
-d endUserIp=8.8.8.8 \
-d transfer[]='{"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171", "amount":1, "fee":0, "escrowDate":"2025-10-01"}'Back to JSON Format
{
"transactionId": "2a76e817-92db-41b8-8765-c28904c32eb6",
"creationDate": "2020-09-16T16:29:37.006548+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "7bd7ee30-43a3-4201-be52-8e2cf35f40cf",
"creationDate": "2020-09-16T16:29:11.603121+02:00",
"customerId": null,
"cardTokenId": "933ce581-790d-4133-87d4-9268537b9d15",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CAPTURED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"breakdownPerSubMerchant": [],
"transactiontransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-09-18",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-16T16:29:37.488715+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "17934603-6357-46be-8c29-0e264c19d7e5",
"authorizationMovementId": "5a859c5a-3dc6-471a-840d-e73b39295f02",
"cancelMovementId": null,
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transaction/3d918ea4-bfb2-44b2-8d79-ca3929a8ff8a \
-u 'doctest:4I9HJRTd' \
-d receiptEmail=test@gmail.com
Back to Json format
{
"transactionId": "223aa3d0-e5a9-4d20-96ea-4d74c8173835",
"creationDate": "2020-09-10T17:19:34.032564+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "67a9b389-a997-4b55-b6bb-1a55ca515d65",
"creationDate": "2020-09-10T17:19:33.563280+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CANCELED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": "test@gmail.com",
"breakdownPerSubMerchant": [],
"transactiontransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-09-12",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-10T17:19:35.747860+02:00",
"clearingDate": null,
"captureCancellationDate": "2020-09-10T17:19:36.385614+02:00",
"3ds": false,
"enrollmentId": null,
"movementId": "efbd79ef-7cb3-43ad-9bb9-c5e93018181c",
"authorizationMovementId": "30897a45-3d5c-4a40-bd0c-bef05245538c",
"cancelMovementId": "0c21f7f9-44b4-41d7-a9f7-1289fb6e5ae7",
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}Update a transaction
This function allows you to update a transaction with the transaction ID.
| transactionId UUID (36) |
CentralPay ID of the transaction Required: yes |
| description String (256) |
Description Required: no Validation: .{0,256} |
| merchantTransactionId String (100) |
Merchant ID Required: no Validation: .{0,100} |
| transferGroup String (100) |
Transfer group identifier Required: no Validation: .{0,100} |
| receiptEmail String (255) |
Email to send the receipt Required: no Validation: Email |
| additionalData String (303) |
Merchant data Required: no Validation: Key : .{45} - Value : .{256} Sample : additionalData=[Key]Value
Note: Number of key/value combinations as it can have multiple keys and values. |
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transaction/3d918ea4-bfb2-44b2-8d79-ca3929a8ff8a \
-u 'doctest:4I9HJRTd' \
-d receiptEmail=test@gmail.com
Back to Json format
{
"transactionId": "223aa3d0-e5a9-4d20-96ea-4d74c8173835",
"creationDate": "2020-09-10T17:19:34.032564+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "67a9b389-a997-4b55-b6bb-1a55ca515d65",
"creationDate": "2020-09-10T17:19:33.563280+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CANCELED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": "test@gmail.com",
"breakdownPerSubMerchant": [],
"transactiontransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-09-12",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-10T17:19:35.747860+02:00",
"clearingDate": null,
"captureCancellationDate": "2020-09-10T17:19:36.385614+02:00",
"3ds": false,
"enrollmentId": null,
"movementId": "efbd79ef-7cb3-43ad-9bb9-c5e93018181c",
"authorizationMovementId": "30897a45-3d5c-4a40-bd0c-bef05245538c",
"cancelMovementId": "0c21f7f9-44b4-41d7-a9f7-1289fb6e5ae7",
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}Example of curl code
curl -v -X POST https://test-api.centralpay.net/v2/rest/transaction/9dd9d178-8a23-4219-a1de-94ee23e763a7/capture \
-u 'doctest:4I9HJRTd' \
-H 'Content-Type:application/x-www-form-urlencoded'
Back to JSON Format
{
"transactionId": "074985e2-611b-45db-8d6e-4cfe01bc7eb4",
"creationDate": "2020-09-16T16:35:18.549891+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "6ef2a056-f063-46e4-9343-7fc58232a615",
"creationDate": "2020-09-16T16:31:44.948119+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CAPTURED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"breakdownPerSubMerchant": [],
"transactiontransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-09-18",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-16T16:35:21.950312+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "fb89ac2c-f597-4e9d-a85c-d808eab57d64",
"authorizationMovementId": "bff2aabc-6694-4c04-b38c-02ad160188a3",
"cancelMovementId": null,
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}
Capture a transaction
This function allows you to capture a transaction with the transaction ID. If the transaction concerned is a transaction with transfer then the amount of the capture must be equal to the amount of the transaction.
| transactionId UUID (36) |
CentralPay ID of the transaction Required: yes Validation: UUID - Existing - Authorised (for the user) Note: - must be less than 30 days if source = DP |
| amount Integer |
Amount of debit Required: no Validation: > 0 and <= amount authorisation Note: Amount of the authorisation by default |
Example of curl code
curl -v -X POST https://test-api.centralpay.net/v2/rest/transaction/9dd9d178-8a23-4219-a1de-94ee23e763a7/capture \
-u 'doctest:4I9HJRTd' \
-H 'Content-Type:application/x-www-form-urlencoded'
Back to JSON Format
{
"transactionId": "074985e2-611b-45db-8d6e-4cfe01bc7eb4",
"creationDate": "2020-09-16T16:35:18.549891+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "6ef2a056-f063-46e4-9343-7fc58232a615",
"creationDate": "2020-09-16T16:31:44.948119+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CAPTURED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"breakdownPerSubMerchant": [],
"transactiontransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-09-18",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-16T16:35:21.950312+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "fb89ac2c-f597-4e9d-a85c-d808eab57d64",
"authorizationMovementId": "bff2aabc-6694-4c04-b38c-02ad160188a3",
"cancelMovementId": null,
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}
Example of curl code
curl -v -X POST https://test-api.centralpay.net/v2/rest/transaction/12da7379-ec3f-456d-9732-1c94be7cd2f7/cancel \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"transactionId":"9c667641-45aa-4c44-87c4-f050be2eef0e",
"creationDate":"2016-09-01T14:20:37.894+02:00",
"authorizationCancellationDate":null,
"customerId":null,
"captureDate":"2016-09-01T14:20:37.894+02:00",
"clearingDate":null,
"captureCancellationDate":"2016-09-01T14:24:02.535+02:00",
"pointOfSaleId":"ec3eaf8c-636a-44e1-bf9d-d01ac11771d4",
"contractId":"7acbd816-4cd2-44df-9d8f-00a151ae6fb1",
"affiliatedMemberId":null,
"enrollmentId":null,
"additionalData":{
},
"amount":100,
"amountCaptured":100,
"amountRefunded":0,
"authorizationCode":"000000",
"authorizationStatus":"SUCCESS",
"bankCode":"0",
"bankMessage":"Simulated authorization",
"breakdownPerSubMerchant":[
],
"captureStatus":"CANCELED",
"card":{
"cardId":"502c9396-e821-4683-a03c-cc659b6db241",
"creationDate":"2016-09-01T14:20:38.065+02:00",
"customerId":null,
"additionalData":{
},
"cardTokenId":null,
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"MASTERCARD",
"country":null,
"description":null,
"expirationMonth":1,
"expirationYear":2018,
"fingerprint":"266a0997088e7854d78a2d71040e40dddfc92fd0",
"first6":"510000",
"last4":"0032",
"merchantCardId":null
},
"country":null,
"currency":"EUR",
"description":"Test curl",
"endUserIp":null,
"merchantTransactionId":null,
"order":{
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cardCountry":null,
"cardholderEmail":null,
"cardholderName":null,
"city":null,
"country":null,
"email":null,
"firstName":null,
"lastName":null,
"phone":null,
"postalCode":null
},
"receiptEmail":null,
"refunded":false,
"refunds":[
],
"source":"EC",
"3DS":false
}
Cancel a transaction
This function allows you to cancel an authorisation or the debit order of a transaction with the transaction ID
| transactionId UUID (36) |
CentralPay ID of the transaction Required: yes Note: - AuthorizationStatus has to be = SUCCESS - Cancel an authorisation if captureStatus = UNCAPTURED - Cancel a debit if captureStatus = CAPTURED |
Example of curl code
curl -v -X POST https://test-api.centralpay.net/v2/rest/transaction/12da7379-ec3f-456d-9732-1c94be7cd2f7/cancel \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"transactionId":"9c667641-45aa-4c44-87c4-f050be2eef0e",
"creationDate":"2016-09-01T14:20:37.894+02:00",
"authorizationCancellationDate":null,
"customerId":null,
"captureDate":"2016-09-01T14:20:37.894+02:00",
"clearingDate":null,
"captureCancellationDate":"2016-09-01T14:24:02.535+02:00",
"pointOfSaleId":"ec3eaf8c-636a-44e1-bf9d-d01ac11771d4",
"contractId":"7acbd816-4cd2-44df-9d8f-00a151ae6fb1",
"affiliatedMemberId":null,
"enrollmentId":null,
"additionalData":{
},
"amount":100,
"amountCaptured":100,
"amountRefunded":0,
"authorizationCode":"000000",
"authorizationStatus":"SUCCESS",
"bankCode":"0",
"bankMessage":"Simulated authorization",
"breakdownPerSubMerchant":[
],
"captureStatus":"CANCELED",
"card":{
"cardId":"502c9396-e821-4683-a03c-cc659b6db241",
"creationDate":"2016-09-01T14:20:38.065+02:00",
"customerId":null,
"additionalData":{
},
"cardTokenId":null,
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"MASTERCARD",
"country":null,
"description":null,
"expirationMonth":1,
"expirationYear":2018,
"fingerprint":"266a0997088e7854d78a2d71040e40dddfc92fd0",
"first6":"510000",
"last4":"0032",
"merchantCardId":null
},
"country":null,
"currency":"EUR",
"description":"Test curl",
"endUserIp":null,
"merchantTransactionId":null,
"order":{
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cardCountry":null,
"cardholderEmail":null,
"cardholderName":null,
"city":null,
"country":null,
"email":null,
"firstName":null,
"lastName":null,
"phone":null,
"postalCode":null
},
"receiptEmail":null,
"refunded":false,
"refunds":[
],
"source":"EC",
"3DS":false
}
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/transaction/12da7379-ec3f-456d-9732-1c94be7cd2f7 \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"transactionId": "074985e2-611b-45db-8d6e-4cfe01bc7eb4",
"creationDate": "2020-09-16T16:35:18.549891+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "6ef2a056-f063-46e4-9343-7fc58232a615",
"creationDate": "2020-09-16T16:31:44.948119+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CAPTURED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"breakdownPerSubMerchant": [],
"transactiontransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-09-18",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-16T16:35:21.950312+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "fb89ac2c-f597-4e9d-a85c-d808eab57d64",
"authorizationMovementId": "bff2aabc-6694-4c04-b38c-02ad160188a3",
"cancelMovementId": null,
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}
Retrieve a transaction
This function allows you to retrieve a transaction with the transaction ID.
| transactionId UUID (36) |
CentralPay ID of the transaction Required: yes Validation: UUID |
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/transaction/12da7379-ec3f-456d-9732-1c94be7cd2f7 \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"transactionId": "074985e2-611b-45db-8d6e-4cfe01bc7eb4",
"creationDate": "2020-09-16T16:35:18.549891+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "6ef2a056-f063-46e4-9343-7fc58232a615",
"creationDate": "2020-09-16T16:31:44.948119+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CAPTURED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"breakdownPerSubMerchant": [],
"transactiontransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-09-18",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-16T16:35:21.950312+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "fb89ac2c-f597-4e9d-a85c-d808eab57d64",
"authorizationMovementId": "bff2aabc-6694-4c04-b38c-02ad160188a3",
"cancelMovementId": null,
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/transaction \
-u 'doctest:4I9HJRTd'
Back to Json format
{
{
"list": [
{
"transactionId": "074985e2-611b-45db-8d6e-4cfe01bc7eb4",
"creationDate": "2020-09-16T16:35:18.549891+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "6ef2a056-f063-46e4-9343-7fc58232a615",
"creationDate": "2020-09-16T16:31:44.948119+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CAPTURED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"breakdownPerSubMerchant": [],
"transactiontransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-09-18",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-16T16:35:21.950312+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "fb89ac2c-f597-4e9d-a85c-d808eab57d64",
"authorizationMovementId": "bff2aabc-6694-4c04-b38c-02ad160188a3",
"cancelMovementId": null,
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
},
{
"transactionId": "2a76e817-92db-41b8-8765-c28904c32eb6",
"creationDate": "2020-09-16T16:29:37.006548+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "7bd7ee30-43a3-4201-be52-8e2cf35f40cf",
"creationDate": "2020-09-16T16:29:11.603121+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CAPTURED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"breakdownPerSubMerchant": [],
"transactiontransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-09-18",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-16T16:29:37.488715+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "17934603-6357-46be-8c29-0e264c19d7e5",
"authorizationMovementId": "5a859c5a-3dc6-471a-840d-e73b39295f02",
"cancelMovementId": null,
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}
],
"totalCount":737
}
List transactions
This function allows you to search objects from a multi-criteria search.
All the paramers used to search must be passed in the form of queries parameters.
« Transaction » specific parameters
| merchantTransactionId String (100) |
Merchant ID Required: no Validation: .{0,100} |
| pointOfSaleId UUID (36) |
CentralPay POS ID Required: no Validation: UUID |
| contractId UUID (36) |
CentralPay contract ID Required: no Validation: UUID |
| affiliatedMemberId UUID (36) |
CentralPay Affiliate ID Required: no Validation: UUID |
| currency Currency ISO4217 |
Currency Required: no Validation: ISO4217 in format alpha or num - [A-Z}{3}|[0-9]{3} - Existing |
| customerId UUID (36) |
CentralPay Client ID Required: no Validation: UUID |
| cardId UUID (36) |
CentralPay Card ID Required: no Validation: UUID |
| authorizationStatus String |
Authorisation status Required: no Validation: SUCCESS | FAILURE | PENDING |
| captureStatus String |
Debit status Required: no Validation: UNCAPTURED | CAPTURED | CLEARED | CANCELED |
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/transaction \
-u 'doctest:4I9HJRTd'
Back to Json format
{
{
"list": [
{
"transactionId": "074985e2-611b-45db-8d6e-4cfe01bc7eb4",
"creationDate": "2020-09-16T16:35:18.549891+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "6ef2a056-f063-46e4-9343-7fc58232a615",
"creationDate": "2020-09-16T16:31:44.948119+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CAPTURED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"breakdownPerSubMerchant": [],
"transactiontransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-09-18",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-16T16:35:21.950312+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "fb89ac2c-f597-4e9d-a85c-d808eab57d64",
"authorizationMovementId": "bff2aabc-6694-4c04-b38c-02ad160188a3",
"cancelMovementId": null,
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
},
{
"transactionId": "2a76e817-92db-41b8-8765-c28904c32eb6",
"creationDate": "2020-09-16T16:29:37.006548+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"merchantTransactionId": null,
"transactionStatus": "SUCCESS",
"authorizationStatus": "SUCCESS",
"bankCode": "0",
"bankMessage": "Simulated authorization",
"authorizationCode": "000000",
"riskScore": null,
"source": "EC",
"description": null,
"currency": "EUR",
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"amount": 10,
"totalAmount": 10,
"card": {
"cardId": "7bd7ee30-43a3-4201-be52-8e2cf35f40cf",
"creationDate": "2020-09-16T16:29:11.603121+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
},
"captureStatus": "CAPTURED",
"amountCaptured": 10,
"refunded": false,
"amountRefunded": 0,
"refunds": [],
"endUserIp": "245.100.1.15",
"endUserLanguage": null,
"browserUserAgent": null,
"browserAcceptLanguage": null,
"country": null,
"receiptEmail": null,
"breakdownPerSubMerchant": [],
"transactiontransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-09-18",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"transferGroup": null,
"residualAmount": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"dispute": null,
"authorizationCancellationDate": null,
"customerId": null,
"captureDate": "2020-09-16T16:29:37.488715+02:00",
"clearingDate": null,
"captureCancellationDate": null,
"3ds": false,
"enrollmentId": null,
"movementId": "17934603-6357-46be-8c29-0e264c19d7e5",
"authorizationMovementId": "5a859c5a-3dc6-471a-840d-e73b39295f02",
"cancelMovementId": null,
"customAcceptanceData": {},
"additionalData": {
"key1": "value1",
"key2": "value2"
}
}
],
"totalCount":737
}
Transaction object
The Json "Transaction" Object
The "Transaction" object response represents an electronic bank transaction.
|
transactionId String(36) |
Transaction ID Note: UUID Format |
| merchantTransactionId String (100) |
CentralPay's merchant ID Note: Merchant internal reference for tracability purposes |
| creationDate String |
Creation date Note: ISO 8601 |
|
transactionStatus String |
Transaction status Note: SUCCESS | FAILURE | CANCELED | FRAUD | RISK | NOT_ACCEPTED | PENDING | OTP_INVALID |
|
clearingNumber string |
Identifier of the clearing
|
|
merchantCategoryCode String |
Identifier of the merchant category Note: see the official code |
|
paymentRequestBreakdownId UUID |
Identifier UUID of the PaymentRequestBreakdown Note: Not empty if the transaction is linked to a Payment Request |
|
paymentRequestId UUID |
Identifier UUID of the Payment Request Note: Not empty if the transaction is linked to a Payment Request |
|
payoutCurrency String |
Currency of the repayment Note: Currency of the repayment used by the Point Of Sale |
|
endUserLanguage String |
Language of the final customer Note: Format ISO 639-2 (3 characters) |
|
authorizationMovementId UUID |
UUID of the authorisation of the transfer movement |
|
receiptEmail String |
Email used for the sending of the receipt Note: favorite format |
|
dispute Dispute |
Dispute Note: Dispute object |
|
payoutCurrency String |
Currency of the repayment Note: Currency of the repayment used by the Point Of Sale |
|
commission Integer |
Commission |
|
payoutAmount Integer |
Amount after the rate of change or ajustment |
|
fee Integer |
Fee |
|
totalAmount Integer |
Total Amount |
| authorizationStatus String |
Authorisation status
Note: THREEDS_AUTH_FAILURE : 3DS Authentication falied (card holder submit wrong code) NOT_ACCEPTED : out of acceptance rules |
|
authorizationCancellationDate String |
Cancelled authorisation date Note: ISO 8601 |
| bankCode String(6) |
Bank return code Note: Return codes |
| bankMessage String(256) |
Bank message |
| authorizationCode String |
Authentication code |
|
riskScore Integer |
Anti-fraud score
|
| source String |
Payment source
Note: DP: Deposit (préautorization) |
| description String |
Description |
| currency String |
Currency Note: Favourite format |
| amount Integer |
Amount Note: in cents |
| customerId String (36) |
CentralPay client ID Note: UUID Format |
| card Card object |
Card Note: The Json "Card" sub-object |
| captureStatus String |
Debit status Note: UNCAPTURED | EXPIRED | CAPTURED | CLEARED | CANCELED |
| captureDate String |
Date of debit Note: ISO 8601 |
| amountCaptured Integer |
Amount debited |
| clearingDate String |
Clearing date Note: ISO 8601 |
| captureCancellationDate String |
Debit cancellation date Note: ISO 8601 |
| refunded Boolean |
Fully refunded Note: true if fully refunded |
| amountRefunded Integer |
Amount refunded |
| refunds Array of Refund object |
Refunds Note: The Json "Refund" object |
| 3DS Boolean |
3-D Secure |
| endUserIp String |
IP of the end user |
| country String |
Country of the merchant Note: Favourite format |
| endUserLanguage String |
Language used in exchanges with the Customer (receipt Email) |
| receiptEmail String |
Email receipt |
| pointOfSaleId String (36) |
POS ID Note: UUID Format |
| contractId String (36) |
CentralPay contract ID Note: UUID Format |
| browserUserAgent String (255) |
HTTP header user-agent of the client's browser |
| browserAcceptLanguage String (255) |
HTTP header accept-language of the client's browser |
| additionalData Object |
Merchant data Note: Contains keys/values |
| Order Order object |
Order information Note: The Json "Order" object |
| breakdownPerSubMerchant BreakdownPerSubMerchant object |
Breakdown of amounts by sub-merchant Note: [{ "subMerchantId": "value", "subAmount": value, "subMerchantReference": "value" }, ...] Cf. The Json "BreakdownPerSubMerchant" object |
|
enrollmentId String(36) |
Enrollment ID Note: UUID Format |
|
movementId String(36) |
Movement ID Note: UUID Format |
|
cancelMovementId String(36) |
Cancel movement ID Note: UUID Format |
| transfers Array of Transfer object |
Transfers Note: The Json "Transfer" object |
| transferGroup String |
Transfer group |
Transaction transfer JSON
This Parameter HTTP transfer[] allows you to create an automatic transfer via the transaction. It's content in JSON format.
| 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 Note: In cents |
|
fee Integer |
Fee Required : no Validation: Between 0 and the transfer amount |
|
merchantTransfertId String |
Merchant Traansfer Id Required : no |
|
escrowDate LocaleDate |
Escrow date Required : no Validation: The escrowDate must be equal to or greater than the transaction capture date + 2 days |
Transaction transfer Object
The object «transaction transfer» represents a transfer via a transaction (Json format).
|
destinationWalletId String(36) |
Destination wallet ID Note: UUID Format |
| amount Integer |
Transfer amount |
| fee Integer |
Fee |
| merchantTranferId String |
Merchant Transfer Id |
| escrowDate Local date |
Escrow date |
Order sub-object
The « Order » sub-object is a HTTP request that provides the details of the order.
| order[firstName] String |
First name Required: no Validation: .{0,35} |
| order[lastName] String |
Last name Required: no Validation: .{0,35} |
| order[addressLine1] String (255) |
Address line 1 Required: no Validation: .{0,255} |
| order[addressLine2] String (255) |
Address line 2 Required: no Validation: .{0,255} |
| order[addressLine3] String (255) |
Address line 3 Required: no Validation: .{0,255} |
| order[addressLine4] String (255) |
Address line 4 Required: no Validation: .{0,255} |
| order[postalCode] String (15) |
Postal code Required: no Validation: [a-zA-Z0-9 -]{0,15} |
| order[city] String (35) |
City Required: no Validation: .{0,35} |
| order[country] Country |
Country
Required: no Validation: ISO3166 in format alpha2, alpha3 or num [0-9]{3}|[A-Z]{2}|[A-Z]{3} Existing
|
| order[email] String (255) |
Email Required: no Validation: Email |
| order[phone] String |
Phone Required: no Validation: [0-9\\+\\.\\-\\ \\(\\)]{0,25} |
| order[cardCountry] Country |
Card issuing country
Required: no Validation: ISO3166 in format alpha2, alpha3 or num [0-9]{3}|[A-Z]{2}|[A-Z]{3} Existing
|
| order[holderName] String (35) |
Cardholder name Required: no Validation: .{0,35}
|
| order[holderEmail] String (255) |
Cardholder email Required: no Validation: Email
|
Card sub-object
The « Card » sub-object displays the debit/credit card details for the bank transaction.
| card[number] String |
Card number Required: yes Validation: CreditCardNumber
|
| card[cvc] String |
CVV/CVC2
Required: conditionnal Note: Not mandatory if transaction type is MO or TO |
| card[expirationMonth] String |
Card expiration month Required: yes Validation: [0-9]{2}
|
| card[expirationYear] String |
Card expiration year Required: yes Validation: [0-9]{2|4}
Note: 2 or 4 numbers are accepted (example : 19 or 2019) |
| card[country] String |
Card country
Required: no Validation: ISO3166 in format alpha2, alpha3 or num [0-9]{3}|[A-Z]{2}|[A-Z]{3} Existing
|
| card[holderName] String (36) |
Cardholder name Required: no Validation: .{0,35}
|
| card[holderEmail] String (255) |
Cardholder email Required: no Validation: Email
|
| card[description] String (256) |
Card description Required: no Validation: .{256}
|
3DS sub-object
The « 3DS » sub-object displays the information of a 3DS transaction.
| 3ds[enrollmentId] UUID (36) |
Enrollment ID Required: no UUID - Existing - Authorised (for the user) |
| 3ds[paRes] String |
PaRes
Required: conditional Note: PaRes OR xid/cavv/eci/status - If empty then considered as not present |
| 3ds[xid] String (20) |
XID Required: conditional Validation: .{0,20}
Note: PaRes OR xid/cavv/eci/status - If empty then considered as not present |
| 3ds[cavv] String |
CAVV Required: conditional Validation: [A-Za-z0-9+\/]{0,45}={0,2}
Note: PaRes OR xid/cavv/eci/status - If empty then considered as not present |
| 3ds[eci] String (2) |
CentralPay token ID Required: conditional Validation: [0-9]{2}
Note: PaRes OR xid/cavv/eci/status - If empty then considered as not present |
| 3ds[status] Enum ThreeDSStatus |
Statut Required: conditional Y | A | N | U Comment: Y: Authentication successful A: Proof of authentication attempt N: Authentication failed U: Authentication could not be completed
Note: PaRes OR xid/cavv/eci/status - If empty then considered as not present |
BreakdownPerSubMerchant object
The object « BreakdownPerSubMerchant » represents the breakdown of a transaction (Json format).
|
subMerchantTransactionId String(36) |
Sub-merchant transaction ID Note: UUID Format |
| subMerchantId String (36) |
CentralPay sub-merchant ID Note: UUID Format |
| subAmount Number |
Sub-merchant amount Note: In centre |
| subMerchantReference String |
Sub-merchant reference |
|
totalSubAmount Number |
Total of sub-merchant amount
|
|
breakdownPerSubMerchant Array of breakdownSubMerchant |
Sub-merchant breakdown |
|
refunds Array of UUID |
Refunds ID Note: List of refunds UUID |
|
refunded Boolean |
Is refunded Note: Always fully refunded |
|
remunerations Array of remunerations |
Remunerations |
Remuneration sub-object
|
rate Double |
Remuneration rate
|
|
fees Integer |
Fees
|
|
remunerationSource RemunerationSource |
Remuneration source (for calculation) AMOUNT|TOTAL_AMOUNT |
|
remunerationFromRate Integer |
Remuneration amount
|
|
totalRemuneration Integer |
Total remuneration
|
|
to UUID |
receiver of the remuneration
|
Order object
The « order » object in a sub-objet within the Transaction objet that returns a JSON response.
| firstName String (35) |
Client first name |
| lastName String (35) |
Client last name |
| addressLine1 String (255) |
Client address (line 1) |
| addressLine2 String (255) |
Client address (line 2) |
| addressLine3 String (255) |
Client address (line 3) |
| addressLine4 String (255) |
Client address (line 4) |
| postalCode String (15) |
Client postal code |
| City String (35) |
Client city |
| country String |
Client country Note: Favourite format (Refer to Country codes) |
| Email String (255) |
Client email |
| Phone String (25) |
Client phone number |
| cardCountry String |
Issuing country of the card Note: Favourite format (Refer to Country codes) |
| cardholderName String (35) |
Cardholder name |
| cardholderEmail String (255) |
Cardholder email |
Card
You can store multiple Cards per Customer in order to charge the customer later on (subscription, etc.). It can also be used to store multiple debit or credit cards on a recipient in order to transfer to these cards later.
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/card \
-u 'doctest:4I9HJRTd' \
-H Origin:https://example.centralpay.net \
-d card[number]=4000000000000010 \
-d card[cvc]=123 \
-d card[expirationMonth]=12 \
-d card[expirationYear]=2035 \
-d card[holderName]='jdoe' \
-d card[check]=true \
-d customerId='3feb0242-2594-44a3-a550-4790306dfcdf'
Back to JSON Format
{
"cardId": "f5c1598f-fff6-46c7-8b05-57723f07d637",
"creationDate": "2020-09-22T11:32:47.870048+02:00",
"customerId": "88dfd3c5-c034-4403-9b21-f14bed00436f",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 9,
"expirationYear": 2035,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "cac21ea48d5b703930ff688ade9a115aadda9d92",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": true,
"additionalData": {}
}
Create a card
This function allows you to create a card.
| cardTokenId UUID (36) |
CentralPay Token ID Required: yes - cardTokenId OR card[*] |
| card[*] * |
Card data
Required: yes - cardTokenId OR card[*] Child arguments : - Required: yes - card[number]=string without any separators - Required: no - card[check]=Check the validity of the card
|
| customerId UUID (36) |
CentralPay Client ID Required: yes |
| merchantCardId String (100) |
CentralPay Merchant ID Required: no Validation: .{0,100} |
| additionalData String (303) |
Merchant data
Required: no
Note: Number of key/value pairs as it can take multiple key and values. |
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/card \
-u 'doctest:4I9HJRTd' \
-H Origin:https://example.centralpay.net \
-d card[number]=4000000000000010 \
-d card[cvc]=123 \
-d card[expirationMonth]=12 \
-d card[expirationYear]=2035 \
-d card[holderName]='jdoe' \
-d card[check]=true \
-d customerId='3feb0242-2594-44a3-a550-4790306dfcdf'
Back to JSON Format
{
"cardId": "f5c1598f-fff6-46c7-8b05-57723f07d637",
"creationDate": "2020-09-22T11:32:47.870048+02:00",
"customerId": "88dfd3c5-c034-4403-9b21-f14bed00436f",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 9,
"expirationYear": 2035,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "cac21ea48d5b703930ff688ade9a115aadda9d92",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": true,
"additionalData": {}
}
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/card/3a9bfa88-816f-467b-aea3-f89dbd9c2157 \
-u 'doctest:4I9HJRTd' \
-d 'country=FRA'
Back to Json format
{
"cardId": "f5c1598f-fff6-46c7-8b05-57723f07d637",
"creationDate": "2020-09-22T11:32:47.870048+02:00",
"customerId": "88dfd3c5-c034-4403-9b21-f14bed00436f",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 9,
"expirationYear": 2035,
"country": "FRA",
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "cac21ea48d5b703930ff688ade9a115aadda9d92",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": true,
"additionalData": {}
}
Update a card
This function allows you to update the information of the card with the card ID.
| cardId UUID |
CentralPay card ID Required: yes |
| merchantCardId String (100) |
Merchant card ID Required: no Validation: .{0,100} |
| country ISO3166 |
Country Required: no Validation: ISO3166 au format alpha2, apha3 or num [0-9]{3}|[A-Z]{2}|[A-Z]{3} Existing |
| cardholderName String (35) |
Cardholder's name Required: no Validation: .{0,35} |
| cardholderEmail String (255) |
Cardholder's email Required: no Validation: Email |
| description String (256) |
Description Required: no Validation: .{256} |
|
additionalData String (303) |
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/card/3a9bfa88-816f-467b-aea3-f89dbd9c2157 \
-u 'doctest:4I9HJRTd' \
-d 'country=FRA'
Back to Json format
{
"cardId": "f5c1598f-fff6-46c7-8b05-57723f07d637",
"creationDate": "2020-09-22T11:32:47.870048+02:00",
"customerId": "88dfd3c5-c034-4403-9b21-f14bed00436f",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 9,
"expirationYear": 2035,
"country": "FRA",
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "cac21ea48d5b703930ff688ade9a115aadda9d92",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": true,
"additionalData": {}
}
Example of html code
curl -X GET -v https://test-api.centralpay.net/v2/rest/card/3a9bfa88-816f-467b-aea3-f89dbd9c2157 \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"cardId": "3a9bfa88-816f-467b-aea3-f89dbd9c2157",
"creationDate": "2020-08-11T11:57:18.686423+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 1,
"expirationYear": 2022,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "36c3da543d36020089ca151dc28cab87ccf36753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
}
Retrieve a card
This function allows you to retrieve a Card with the CardID.
| cardId UUID (36) |
CentralPay card ID Required: yes Validation: UUID |
Example of html code
curl -X GET -v https://test-api.centralpay.net/v2/rest/card/3a9bfa88-816f-467b-aea3-f89dbd9c2157 \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"cardId": "3a9bfa88-816f-467b-aea3-f89dbd9c2157",
"creationDate": "2020-08-11T11:57:18.686423+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 1,
"expirationYear": 2022,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "36c3da543d36020089ca151dc28cab87ccf36753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
}
Example of html code
curl -X GET -v https://test-api.centralpay.net/v2/rest/card \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list": [
{
"cardId": "00bdce25-081d-49e6-b0d5-27a0ad57a841",
"creationDate": "2020-08-11T12:26:46.805601+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0010",
"expirationMonth": 1,
"expirationYear": 2022,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": "test@test.com",
"description": null,
"fingerprint": "10721aca1a21d1db476611da0978073ab30b8c08",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
{
"cardId": "3a9bfa88-816f-467b-aea3-f89dbd9c2157",
"creationDate": "2020-08-11T11:57:18.686423+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 1,
"expirationYear": 2022,
"country": "FRA",
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "36c3da543d36020089ca151dc28cab87ccf36753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
{
"cardId": "a94d9def-025d-4631-84f4-d0a77ac88a3a",
"creationDate": "2020-08-11T11:53:29.301174+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0010",
"expirationMonth": 12,
"expirationYear": 2035,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "c20b2edda5bea300b995b678556e637b04657720",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
}
],
"totalCount": 2178
}
List cards
This function allows you to search objects from a multi-criteria search. All the paramers used to search must be passed in the form of queries parameters.
« Card » specific parameters
| merchantCardId String (100) |
Merchant ID
Required: no Validation: .{0,100} |
| fingerprint String (40) |
Fingerprint Required: no Validation: [0-9a-f]{40} |
| cardHolderEmail String (255) |
Cardholder's email Required: no Validation: Email |
Example of html code
curl -X GET -v https://test-api.centralpay.net/v2/rest/card \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list": [
{
"cardId": "00bdce25-081d-49e6-b0d5-27a0ad57a841",
"creationDate": "2020-08-11T12:26:46.805601+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0010",
"expirationMonth": 1,
"expirationYear": 2022,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": "test@test.com",
"description": null,
"fingerprint": "10721aca1a21d1db476611da0978073ab30b8c08",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
{
"cardId": "3a9bfa88-816f-467b-aea3-f89dbd9c2157",
"creationDate": "2020-08-11T11:57:18.686423+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 1,
"expirationYear": 2022,
"country": "FRA",
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "36c3da543d36020089ca151dc28cab87ccf36753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
{
"cardId": "a94d9def-025d-4631-84f4-d0a77ac88a3a",
"creationDate": "2020-08-11T11:53:29.301174+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0010",
"expirationMonth": 12,
"expirationYear": 2035,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "c20b2edda5bea300b995b678556e637b04657720",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
}
],
"totalCount": 2178
}
Card object
The Json "card" object
The « card » object represents a debit/credit card
| cardId String (36) |
CentralPay card ID Note: UUID Format |
| merchantCardId String (100) |
Merchant card ID |
| creationDate String |
Creation date Note: ISO 8601 |
| commercialBrand String |
Card type Note: VISA|MASTERCARD|AMEX MAESTRO has to be allocated as MASTERCARD |
| first6 String (6) |
First 6 digits |
| last4 String (4) |
Last 4 digits |
| expirationMonth Integer(2) |
Expiration month |
| expirationYear Integer(4) |
Expiration year |
| country String |
Country of the card |
| check Boolean |
Check the validity of the card |
| cardholderName String |
Cardholder name |
| cardholderEmail String (255) |
Cardholder email |
| description String (255) |
Description |
| customerId String (36) |
CentralPay customer ID Note: UUID Format |
| fingerprint String |
Card fingerprint |
| cardTokenId String |
Token linked to the card if needed Note: UUID |
| cardType String |
Type of card used
Note: CREDIT(Credit) DEBIT (Debit) CHARGE (Charge) PREPAYED (Prepayed) DIFF_DEBIT (Diff Debit) |
| region String |
Merchant data
Note: US (U.S) CANADA (Canada) EU (Europe) ASIA_PACIFIC (Asia Pacific) LATIN_AMERICA (Latin America) CEMEA (CEMEA Visa) |
| productType String |
Type of product
Note: CONSUMER (Consumer) CORPORATE (Corporate) |
| europeanEconomicArea Boolean |
European Economic Area |
| additionalData Object |
Merchant data Note: Contains keys/values |
Refund
Refund objects allow you to refund a processed transaction. The amount will be refunded to the debit/credit card used for the transaction.
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/refund/ \
-u 'doctest:4I9HJRTd' \
-d transactionId=5d780740-be73-4436-9117-a067d027e609
Back to JSON Format
{
"refundId": "ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d",
"creationDate": "2020-08-11T15:21:19.606403+02:00",
"transactionId": "5d780740-be73-4436-9117-a067d027e609",
"clearingDate": null,
"cancellationDate": null,
"merchantRefundId": null,
"currency": "EUR",
"amount": 100,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"description": null,
"status": "UNCLEARED",
"breakdownPerSubMerchant": [],
"movementId": "df230f89-9bde-414c-863e-b69ba520d145",
"cancelMovementId": null,
"additionalData": {}
}
Create a refund
Refund a single object
This function allows you to refund a processed transaction
You must enter a transaction amount to create a refund.
The amount will be refunded to the debit/credit card used for the transaction. The processing fees of the transaction are refunded to the merchant.
You can also partly refund the transaction. You can do so as many times as you want until the full transaction has been refunded.
Once entirely refunded, the transaction cannot be refunded anymore. If you intend to refund an amount superior to the amount of the initial transaction, you will get an error.
|
transactionId String(36) |
Transaction ID Required: yes Validation: Existing authorised for the user
Note: The transaction must be: - CaptureStatus = CLEARED - Expiration date of card |
|
merchantRefundId String(36) |
Merchant ID Required: no Validation: Between 0 and 100 |
|
subMerchantTransactionId String(36) |
sub transaction ID Required: no Validation: Linked to a refund
Note: Possibility to send several HTTP parameters |
|
amount String |
Amount to repay Required: no Validation: Existing Bind to a transaction to repay |
|
description String |
Description Required: no |
|
additionalData String (303) |
Merchant data Required: no Validation: Key {45} Value {256} Sample: additionalData=[Key]Value
Note: Number of key/value pairs as it can have multiple keys and values. |
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/refund/ \
-u 'doctest:4I9HJRTd' \
-d transactionId=5d780740-be73-4436-9117-a067d027e609
Back to JSON Format
{
"refundId": "ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d",
"creationDate": "2020-08-11T15:21:19.606403+02:00",
"transactionId": "5d780740-be73-4436-9117-a067d027e609",
"clearingDate": null,
"cancellationDate": null,
"merchantRefundId": null,
"currency": "EUR",
"amount": 100,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"description": null,
"status": "UNCLEARED",
"breakdownPerSubMerchant": [],
"movementId": "df230f89-9bde-414c-863e-b69ba520d145",
"cancelMovementId": null,
"additionalData": {}
}
Example of html code
curl -v https://test-api.centralpay.net/v2/rest/refund/ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d \
-u 'doctest:4I9HJRTd' \
-d description='ma description'
Back to Json format
{
"refundId": "ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d",
"creationDate": "2020-08-11T15:21:19.606403+02:00",
"transactionId": "5d780740-be73-4436-9117-a067d027e609",
"clearingDate": null,
"cancellationDate": null,
"merchantRefundId": null,
"currency": "EUR",
"amount": 100,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"description": "ma description",
"status": "UNCLEARED",
"breakdownPerSubMerchant": [],
"movementId": "df230f89-9bde-414c-863e-b69ba520d145",
"cancelMovementId": null,
"additionalData": {}
}
Update a refund
This function allows you to update a refund with the refund ID.
| refundId UUID (36) |
CentralPay Refund ID Required: yes |
| merchantRefundId String (36) |
Merchant ID Required: no Validation: .{0,100} |
| description String (36) |
Description Required: no Validation: .{0,256} |
| additionalData String (303) |
Merchant data
Required: no Sample : additionalData=[Key]Value |
Example of html code
curl -v https://test-api.centralpay.net/v2/rest/refund/ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d \
-u 'doctest:4I9HJRTd' \
-d description='ma description'
Back to Json format
{
"refundId": "ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d",
"creationDate": "2020-08-11T15:21:19.606403+02:00",
"transactionId": "5d780740-be73-4436-9117-a067d027e609",
"clearingDate": null,
"cancellationDate": null,
"merchantRefundId": null,
"currency": "EUR",
"amount": 100,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"description": "ma description",
"status": "UNCLEARED",
"breakdownPerSubMerchant": [],
"movementId": "df230f89-9bde-414c-863e-b69ba520d145",
"cancelMovementId": null,
"additionalData": {}
}
Example of curl code
curl -v -X POST https://test-api.centralpay.net/v2/rest/refund/ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d/cancel \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"refundId": "ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d",
"creationDate": "2020-08-11T15:21:19.606403+02:00",
"transactionId": "5d780740-be73-4436-9117-a067d027e609",
"clearingDate": null,
"cancellationDate": "2020-08-11T15:46:14.064173+02:00",
"merchantRefundId": null,
"currency": "EUR",
"amount": 100,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"description": "ma description",
"status": "CANCELED",
"breakdownPerSubMerchant": [],
"movementId": "df230f89-9bde-414c-863e-b69ba520d145",
"cancelMovementId": "bbcfd0f2-ad2c-4285-a951-4aebd7aba0c9",
"additionalData": {}
}
Cancel a refund
This function allows you to cancel a refund with the refund ID.
| refundId UUID (36) |
CentralPay Refund ID Required: yes Note: The refund has to be: - status = UNCLEARED |
Example of curl code
curl -v -X POST https://test-api.centralpay.net/v2/rest/refund/ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d/cancel \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"refundId": "ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d",
"creationDate": "2020-08-11T15:21:19.606403+02:00",
"transactionId": "5d780740-be73-4436-9117-a067d027e609",
"clearingDate": null,
"cancellationDate": "2020-08-11T15:46:14.064173+02:00",
"merchantRefundId": null,
"currency": "EUR",
"amount": 100,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"description": "ma description",
"status": "CANCELED",
"breakdownPerSubMerchant": [],
"movementId": "df230f89-9bde-414c-863e-b69ba520d145",
"cancelMovementId": "bbcfd0f2-ad2c-4285-a951-4aebd7aba0c9",
"additionalData": {}
}
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/refund/ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"refundId": "ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d",
"creationDate": "2020-08-11T15:21:19.606403+02:00",
"transactionId": "5d780740-be73-4436-9117-a067d027e609",
"clearingDate": null,
"cancellationDate": "2020-08-11T15:46:14.064173+02:00",
"merchantRefundId": null,
"currency": "EUR",
"amount": 100,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"description": "ma description",
"status": "CANCELED",
"breakdownPerSubMerchant": [],
"movementId": "df230f89-9bde-414c-863e-b69ba520d145",
"cancelMovementId": "bbcfd0f2-ad2c-4285-a951-4aebd7aba0c9",
"additionalData": {}
}
Retrieve a refund
This function allows you to retrieve a refund with the RefundID.
| refundId UUID (36) |
CentralPay Refund ID Required: yes Validation: UUID |
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/refund/ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"refundId": "ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d",
"creationDate": "2020-08-11T15:21:19.606403+02:00",
"transactionId": "5d780740-be73-4436-9117-a067d027e609",
"clearingDate": null,
"cancellationDate": "2020-08-11T15:46:14.064173+02:00",
"merchantRefundId": null,
"currency": "EUR",
"amount": 100,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"description": "ma description",
"status": "CANCELED",
"breakdownPerSubMerchant": [],
"movementId": "df230f89-9bde-414c-863e-b69ba520d145",
"cancelMovementId": "bbcfd0f2-ad2c-4285-a951-4aebd7aba0c9",
"additionalData": {}
}
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/refund \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list": [
{
"refundId": "ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d",
"creationDate": "2020-08-11T15:21:19.606403+02:00",
"transactionId": "5d780740-be73-4436-9117-a067d027e609",
"clearingDate": null,
"cancellationDate": "2020-08-11T15:46:14.064173+02:00",
"merchantRefundId": null,
"currency": "EUR",
"amount": 100,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"description": "ma description",
"status": "CANCELED",
"breakdownPerSubMerchant": [],
"movementId": "df230f89-9bde-414c-863e-b69ba520d145",
"cancelMovementId": "bbcfd0f2-ad2c-4285-a951-4aebd7aba0c9",
"additionalData": {}
},
{
"refundId": "0bc09507-8dd8-42de-9424-bbd296aae82d",
"creationDate": "2020-03-06T09:30:36.370591+01:00",
"transactionId": "c928162f-b405-4cd1-a466-6e63e40ec8b9",
"clearingDate": "2020-03-07",
"cancellationDate": null,
"merchantRefundId": null,
"currency": "EUR",
"amount": 1000,
"payoutCurrency": "EUR",
"payoutAmount": 1000,
"commission": 0,
"fee": 0,
"description": null,
"status": "CLEARED",
"breakdownPerSubMerchant": [],
"movementId": "0c4f18cc-5ed0-4734-ac4a-e7a828cdbd6c",
"cancelMovementId": null,
"additionalData": {}
}
],
"totalCount": 8
}
List refunds
This function allows you to search objects from a multi-criteria search. All the paramers used to search must be passed in the form of queries parameters.
« Refund » specific parameters
| merchantRefundId String (100) |
Merchant ID Required: no Validation: .{0,100} |
| status String |
Refund status Required: no Validation: UNCLEARED | CLEARED | CANCELED |
| pointOfSaleId UUID (36) |
CentralPay POS ID Required: no Validation: UUID |
| contractId UUID (36) |
CentralPay contract ID Required: no Validation: UUID |
| currency Currency ISO4217 |
Currency Required: no Validation: ISO4217 in format alpha or num - [A-Z}{3}|[0-9]{3} - Existing |
| customerId UUID (36) |
CentralPay Client ID Required: no Validation: UUID |
| cardId UUID (36) |
CentralPay Card ID Required: no Validation: UUID |
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/refund \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list": [
{
"refundId": "ce4f42ad-c875-4345-9b7a-1f64f1c5fc6d",
"creationDate": "2020-08-11T15:21:19.606403+02:00",
"transactionId": "5d780740-be73-4436-9117-a067d027e609",
"clearingDate": null,
"cancellationDate": "2020-08-11T15:46:14.064173+02:00",
"merchantRefundId": null,
"currency": "EUR",
"amount": 100,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"description": "ma description",
"status": "CANCELED",
"breakdownPerSubMerchant": [],
"movementId": "df230f89-9bde-414c-863e-b69ba520d145",
"cancelMovementId": "bbcfd0f2-ad2c-4285-a951-4aebd7aba0c9",
"additionalData": {}
},
{
"refundId": "0bc09507-8dd8-42de-9424-bbd296aae82d",
"creationDate": "2020-03-06T09:30:36.370591+01:00",
"transactionId": "c928162f-b405-4cd1-a466-6e63e40ec8b9",
"clearingDate": "2020-03-07",
"cancellationDate": null,
"merchantRefundId": null,
"currency": "EUR",
"amount": 1000,
"payoutCurrency": "EUR",
"payoutAmount": 1000,
"commission": 0,
"fee": 0,
"description": null,
"status": "CLEARED",
"breakdownPerSubMerchant": [],
"movementId": "0c4f18cc-5ed0-4734-ac4a-e7a828cdbd6c",
"cancelMovementId": null,
"additionalData": {}
}
],
"totalCount": 8
}
Refund object
The Json "Refund" Object
The « Refund » object represents the refund of a transaction.
| refundId String (36) |
CentralPay refund ID Note: UUID Format |
| merchantRefundId String |
CentralPay merchant ID |
| creationDate String |
Creation date Note: ISO 8601 |
| currency String |
Currency Note: currency of the transaction |
| amount Integer |
Global amount of the refund |
| payoutCurrency String |
Currency of the reversal Note: currency of the Point Of Sales |
| payoutAmount Integer |
Amount of the reversal |
| commission Integer |
Commission |
| fee Integer |
Fee |
| description String |
Description |
| transactionId String (36) |
CentralPay transaction ID Note: UUID Format |
| breakdownPerSubMerchant Object |
Breakdown of amounts by sub-merchant Note: [{ "subMerchantId": "value", "subAmount": value, "subMerchantReference": "value" }, ...] Cf. The Json "BreakdownPerSubMerchant" object |
| status Enum RefundStatus |
Status of the refund Note: UNCLEARED | CLEARED | CANCELED |
| clearingDate String |
Clearing date Note: ISO 8601 |
| cancellationDate String |
Cancellation date Note: ISO 8601 |
| additionalData Object |
Merchant data Note: Contains keys/values |
|
movementId String(36) |
Movement ID Note: UUID Format |
|
cancelMovementId String(36) |
Cancel Movement ID Note: UUID Format |
Credit
A "Credit" is the processing of a debit/credit card. Credits are identified by a unique CreditID.
curl -v https://test-api.centralpay.net/v2/rest/credit \
-u 'doctest:4I9HJRTd' \
-d card[number]=4000000000000002 \
-d card[expirationMonth]=10 \
-d card[expirationYear]=2025 \
-d currency=EUR \
-d merchantCreditId=MCID-01 \
-d additionalData=[city]Tours \
-d amount=100
Back to JSON Format
{
"creditId": "bd0004d3-10e2-4997-ad7d-22be54a6039a",
"creationDate": "2020-08-11T16:26:52.038969+02:00",
"merchantCreditId": "MCID-01",
"status": "UNCLEARED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "bf605fc5-23d1-4c05-b515-1488669b5fcf",
"creationDate": "2020-08-11T16:26:52.309150+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "e67c16dbf2dfd0d7c712755f6ac52d2a6653c6f7",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"receiptEmail": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "6a20c3bc-d4da-4aa6-979b-d59041fcd7d9",
"cancelMovementId": null,
"additionalData": {
"city": "Tours"
}
}
Create a credit
This function allows you to create a credit.
Credit
| currency String (3) |
Currency Required: yes Validation: ISO4217 alpha format or num [A-Z}{3}|[0-9]{3} Existing Authorised (for the contract) |
| amount Integer |
Total amount of the transaction
Required: yes
Note: In cents |
| customerId UUID (36) |
CentralPay client ID Required: conditional Validation: UUID - Existing - Authorised (for the user) |
| cardId UUID (36) |
CentralPay card ID Required: conditional Validation: UUID - Existing - Authorised (for the customer) Note: customerID compulsory |
| cardTokenId UUID (36) |
CentralPay token ID Required: conditional Validation: UUID - Existing - Authorised (for the user) - Status UNUSED |
| card[*] |
Card data
Required: conditional Note: Refer to "Card" sub-object |
| merchantCreditId String (100) |
Credit ID Required: no Validation: .{0,100} |
| pointOfSaleId UUID (36) |
CentralPay POS ID Required: no Validation: UUID - Existing - Authorised for the user |
| contractId UUID (36) |
CentralPay contract ID Required: no Validation: UUID - Existing - Authorised for the PoS |
| description String (256) |
Description Required: no Validation: .{0,256} |
| country Country |
Merchant's Country Required: no Validation: ISO3166 in format alpha2, apha3 or num - [0-9]{3}|[A-Z]{2}|[A-Z]{3} - Existing |
| receiptEmail String (255) |
Email to send the receipt Required: no Validation: Email Note: Receipt email sent to this address, once the credit is credited. By default, if the creditis linked to a client, that is the client's email that will be used. If this parameter is given, it is used instead of client's one. If endUserLanguage is not used, then default value applied |
| additionalData String (303) |
Merchant data
Required: no
Note: Number of key/value combinations because can take multiple keys and values. |
| transfer[] Json objects table |
Automatic transfer Required: no Json format: '{"destinationWalletId":"value", "amount":value, "fee":value, "merchantTransferId":"value","escrowDate":"value"}' Refer to: The Json "Transfer" Validations: The credit must be cleared. Notes: |
| transferGroup String (100) |
Transfer group identifier |
curl -v https://test-api.centralpay.net/v2/rest/credit \
-u 'doctest:4I9HJRTd' \
-d card[number]=4000000000000002 \
-d card[expirationMonth]=10 \
-d card[expirationYear]=2025 \
-d currency=EUR \
-d merchantCreditId=MCID-01 \
-d additionalData=[city]Tours \
-d amount=100
Back to JSON Format
{
"creditId": "bd0004d3-10e2-4997-ad7d-22be54a6039a",
"creationDate": "2020-08-11T16:26:52.038969+02:00",
"merchantCreditId": "MCID-01",
"status": "UNCLEARED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "bf605fc5-23d1-4c05-b515-1488669b5fcf",
"creationDate": "2020-08-11T16:26:52.309150+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "e67c16dbf2dfd0d7c712755f6ac52d2a6653c6f7",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"receiptEmail": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "6a20c3bc-d4da-4aa6-979b-d59041fcd7d9",
"cancelMovementId": null,
"additionalData": {
"city": "Tours"
}
}
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/credit/eb1d61d5-d1fb-4b54-b411-ae12f63b195c \
-u 'doctest:4I9HJRTd' \
-d additionalData=[address]16JeanJau
Back to Json format
{
"creditId": "eb1d61d5-d1fb-4b54-b411-ae12f63b195c",
"creationDate": "2019-10-02T16:57:09.836251+02:00",
"merchantCreditId": "MCID-02",
"status": "CANCELED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "7acbd816-4cd2-44df-9d8f-00a151ae6fb1",
"customerId": null,
"card": {
"cardId": "9e3abbbf-f806-4eb1-bbaf-d1ff393bb493",
"creationDate": "2019-10-02T16:57:11.278375+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "497010",
"last4": "0006",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "9d2fd576f467d48f392be3cb351c5ac63715be2a",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"receiptEmail": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": "2019-10-02T17:13:30.684008+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "817b047f-c129-41af-a71d-bb45398ebe00",
"cancelMovementId": "779e13c3-9e12-4763-983f-3873471ddc12",
"additionalData": {
"address": "16JeanJau",
"city": "Tours"
}
}
Update a credit
This function allows you to update a credit with the credit ID.
| creditId UUID (36) |
CentralPay ID of the credit Required: yes |
| description String (256) |
Description Required: no Validation: .{0,256} |
| merchantCreditId String (100) |
Merchant ID Required: no Validation: .{0,100} |
| additionalData String (303) |
Merchant data Required: no Validation: Key : .{45} - Value : .{256} Sample : additionalData=[Key]Value
Note: Number of key/value combinations as it can have multiple keys and values. |
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/credit/eb1d61d5-d1fb-4b54-b411-ae12f63b195c \
-u 'doctest:4I9HJRTd' \
-d additionalData=[address]16JeanJau
Back to Json format
{
"creditId": "eb1d61d5-d1fb-4b54-b411-ae12f63b195c",
"creationDate": "2019-10-02T16:57:09.836251+02:00",
"merchantCreditId": "MCID-02",
"status": "CANCELED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "7acbd816-4cd2-44df-9d8f-00a151ae6fb1",
"customerId": null,
"card": {
"cardId": "9e3abbbf-f806-4eb1-bbaf-d1ff393bb493",
"creationDate": "2019-10-02T16:57:11.278375+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "497010",
"last4": "0006",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "9d2fd576f467d48f392be3cb351c5ac63715be2a",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"receiptEmail": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": "2019-10-02T17:13:30.684008+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "817b047f-c129-41af-a71d-bb45398ebe00",
"cancelMovementId": "779e13c3-9e12-4763-983f-3873471ddc12",
"additionalData": {
"address": "16JeanJau",
"city": "Tours"
}
}
Example of curl code
curl -v -X POST https://test-api.centralpay.net/v2/rest/credit/bd0004d3-10e2-4997-ad7d-22be54a6039a/cancel \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"creditId": "bd0004d3-10e2-4997-ad7d-22be54a6039a",
"creationDate": "2020-08-11T16:26:52.038969+02:00",
"merchantCreditId": "MCID-01",
"status": "CANCELED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "bf605fc5-23d1-4c05-b515-1488669b5fcf",
"creationDate": "2020-08-11T16:26:52.309150+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "e67c16dbf2dfd0d7c712755f6ac52d2a6653c6f7",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"receiptEmail": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": "2020-08-11T16:43:30.191476+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "6a20c3bc-d4da-4aa6-979b-d59041fcd7d9",
"cancelMovementId": "ee7384ab-c0d6-44a5-a748-068c6b435e7a",
"additionalData": {
"city": "Tours"
}
}
Cancel a credit
This function allows you to cancel a credit with the credit ID
| creditId UUID (36) |
CentralPay ID of the credit Required: yes Note: - Cancel a credit if credit status = UNCLEARED |
Example of curl code
curl -v -X POST https://test-api.centralpay.net/v2/rest/credit/bd0004d3-10e2-4997-ad7d-22be54a6039a/cancel \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"creditId": "bd0004d3-10e2-4997-ad7d-22be54a6039a",
"creationDate": "2020-08-11T16:26:52.038969+02:00",
"merchantCreditId": "MCID-01",
"status": "CANCELED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "bf605fc5-23d1-4c05-b515-1488669b5fcf",
"creationDate": "2020-08-11T16:26:52.309150+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "e67c16dbf2dfd0d7c712755f6ac52d2a6653c6f7",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"receiptEmail": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": "2020-08-11T16:43:30.191476+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "6a20c3bc-d4da-4aa6-979b-d59041fcd7d9",
"cancelMovementId": "ee7384ab-c0d6-44a5-a748-068c6b435e7a",
"additionalData": {
"city": "Tours"
}
}
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/credit/eb1d61d5-d1fb-4b54-b411-ae12f63b195c \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"creditId": "eb1d61d5-d1fb-4b54-b411-ae12f63b195c",
"creationDate": "2019-10-02T16:57:09.836251+02:00",
"merchantCreditId": "MCID-02",
"status": "CANCELED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "7acbd816-4cd2-44df-9d8f-00a151ae6fb1",
"customerId": null,
"card": {
"cardId": "9e3abbbf-f806-4eb1-bbaf-d1ff393bb493",
"creationDate": "2019-10-02T16:57:11.278375+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "497010",
"last4": "0006",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "9d2fd576f467d48f392be3cb351c5ac63715be2a",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"receiptEmail": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": "2019-10-02T17:13:30.684008+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "817b047f-c129-41af-a71d-bb45398ebe00",
"cancelMovementId": "779e13c3-9e12-4763-983f-3873471ddc12",
"additionalData": {
"address": "16JeanJau",
"city": "Tours"
}
}
Retrieve a credit
This function allows you to retrieve a credit with the credit ID.
| creditId UUID (36) |
CentralPay ID of the credit Required: yes Validation: UUID |
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/credit/eb1d61d5-d1fb-4b54-b411-ae12f63b195c \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"creditId": "eb1d61d5-d1fb-4b54-b411-ae12f63b195c",
"creationDate": "2019-10-02T16:57:09.836251+02:00",
"merchantCreditId": "MCID-02",
"status": "CANCELED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "7acbd816-4cd2-44df-9d8f-00a151ae6fb1",
"customerId": null,
"card": {
"cardId": "9e3abbbf-f806-4eb1-bbaf-d1ff393bb493",
"creationDate": "2019-10-02T16:57:11.278375+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "497010",
"last4": "0006",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "9d2fd576f467d48f392be3cb351c5ac63715be2a",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"receiptEmail": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": "2019-10-02T17:13:30.684008+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "817b047f-c129-41af-a71d-bb45398ebe00",
"cancelMovementId": "779e13c3-9e12-4763-983f-3873471ddc12",
"additionalData": {
"address": "16JeanJau",
"city": "Tours"
}
}
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/credit \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list": [
{
"creditId": "bd0004d3-10e2-4997-ad7d-22be54a6039a",
"creationDate": "2020-08-11T16:26:52.038969+02:00",
"merchantCreditId": "MCID-01",
"status": "CANCELED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "bf605fc5-23d1-4c05-b515-1488669b5fcf",
"creationDate": "2020-08-11T16:26:52.309150+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "e67c16dbf2dfd0d7c712755f6ac52d2a6653c6f7",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"receiptEmail": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": "2020-08-11T16:43:30.191476+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "6a20c3bc-d4da-4aa6-979b-d59041fcd7d9",
"cancelMovementId": "ee7384ab-c0d6-44a5-a748-068c6b435e7a",
"additionalData": {
"city": "Tours"
}
},
{
"creditId": "f466554d-8a33-47e9-8d6d-78ae6e4c96d0",
"creationDate": "2019-12-04T09:47:37.499517+01:00",
"merchantCreditId": null,
"status": "CLEARED",
"description": null,
"currency": "EUR",
"amount": 10,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "b30dcafe-8484-456b-b12c-732236c1b61a",
"creationDate": "2019-12-04T09:47:37.795033+01:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "497010",
"last4": "0006",
"expirationMonth": 10,
"expirationYear": 2024,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "1540de1fcf93d1dcd36922af53c490f09b20b083",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"receiptEmail": null,
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-01-11",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"clearingDate": "2019-12-05",
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "61779870-a46e-4b15-8ceb-bf55ad297d4d",
"cancelMovementId": null,
"additionalData": {}
}
],
"totalCount": 3
}
List credits
This function allows you to search objects from a multi-criteria search. All the paramers used to search must be passed in the form of queries parameters.
« Credit » specific parameters
| merchantCreditId String (100) |
Merchant ID Required: no Validation: .{0,100} |
| pointOfSaleId UUID (36) |
CentralPay POS ID Required: no Validation: UUID |
| contractId UUID (36) |
CentralPay contract ID Required: no Validation: UUID |
| currency Currency ISO4217 |
Currency Required: no Validation: ISO4217 in format alpha or num - [A-Z}{3}|[0-9]{3} - Existing |
| customerId UUID (36) |
CentralPay Client ID Required: no Validation: UUID |
| status String |
Credit status Required: no Validation: UNCLEARED | CLEARED | CANCELED |
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/credit \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list": [
{
"creditId": "bd0004d3-10e2-4997-ad7d-22be54a6039a",
"creationDate": "2020-08-11T16:26:52.038969+02:00",
"merchantCreditId": "MCID-01",
"status": "CANCELED",
"description": null,
"currency": "EUR",
"amount": 100,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "bf605fc5-23d1-4c05-b515-1488669b5fcf",
"creationDate": "2020-08-11T16:26:52.309150+02:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 10,
"expirationYear": 2025,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "e67c16dbf2dfd0d7c712755f6ac52d2a6653c6f7",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"receiptEmail": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"clearingDate": null,
"cancellationDate": "2020-08-11T16:43:30.191476+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "6a20c3bc-d4da-4aa6-979b-d59041fcd7d9",
"cancelMovementId": "ee7384ab-c0d6-44a5-a748-068c6b435e7a",
"additionalData": {
"city": "Tours"
}
},
{
"creditId": "f466554d-8a33-47e9-8d6d-78ae6e4c96d0",
"creationDate": "2019-12-04T09:47:37.499517+01:00",
"merchantCreditId": null,
"status": "CLEARED",
"description": null,
"currency": "EUR",
"amount": 10,
"country": null,
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"customerId": null,
"card": {
"cardId": "b30dcafe-8484-456b-b12c-732236c1b61a",
"creationDate": "2019-12-04T09:47:37.795033+01:00",
"customerId": null,
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "497010",
"last4": "0006",
"expirationMonth": 10,
"expirationYear": 2024,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "1540de1fcf93d1dcd36922af53c490f09b20b083",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
"receiptEmail": null,
"payoutCurrency": "EUR",
"payoutAmount": 10,
"commission": 0,
"fee": 0,
"transferGroup": null,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": "2020-01-11",
"amount": 1,
"fee": 0,
"merchantTransferId": null
}
],
"clearingDate": "2019-12-05",
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"movementId": "61779870-a46e-4b15-8ceb-bf55ad297d4d",
"cancelMovementId": null,
"additionalData": {}
}
],
"totalCount": 3
}
Credit object
The Json "Credit" Object
The "Credit" object response represents an electronic bank credit.
|
creditId String(36) |
Credit ID Note: UUID Format |
| merchantCreditId String (100) |
CentralPay's merchant ID Note: Merchant internal reference for tracability purposes |
| creationDate String |
Creation date Note: ISO 8601 |
| status String |
Credit status
Note: UNCLEARED | CLEARED | CANCELED |
|
cancellationDate String |
Cancelled credit date Note: ISO 8601 |
| description String |
Description |
| currency String |
Currency Note: Favourite format |
| amount Integer |
Amount Note: in cents |
| payoutCurrency String |
Currency of the reverseal Note: Favourite format |
| payoutAmount Integer |
Amount after the rate of change / ajustement |
| commission Integer |
Commission |
| fee Integer |
Fee |
| customerId String (36) |
CentralPay client ID Note: UUID Format |
| card Card object |
Card Note: The Json "Card" object |
| clearingDate String |
Clearing date Note: ISO 8601 |
| country String |
Country of the merchant Note: Favourite format |
| receiptEmail String |
Email receipt |
| pointOfSaleId String (36) |
POS ID Note: UUID Format |
| contractId String (36) |
CentralPay contract ID Note: UUID Format |
| order Order object |
Informations about the order Note: The Json "Order" object |
| additionalData Object |
Merchant data Note: Contains keys/values |
| transfers Array of Transfer object |
Transfers Note: The Json "Credit Transfer" object |
| transferGroup String |
Transfer group |
|
movementId String(36) |
Movement ID Note: UUID Format |
|
cancelMovementId String(36) |
Cancel movement ID Note: UUID Format |
Wire transfer
Wiretransfer is a bank to bank transfer with a unique reference. Wiretransfers are identified by a unique wireTransferId.
Example of curl code
curl -v --noproxy '*' --insecure https://test-api.centralpay.net/v2/rest/wireTransfer \
-u 'doctest:4I9HJRTd' \
--data-urlencode currency=EUR \
--data-urlencode merchantWireTransferId=MWRID-01 \
--data-urlencode amount=100Back to JSON format
{
"wireTransferId": "545653b7-6842-43e7-b556-21717ab9241e",
"creationDate": "2020-08-12T09:20:19.414860+02:00",
"receiptDate": null,
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "MWRID-01",
"status": "PENDING",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "CV3OMUNLDABRZVR",
"description": null,
"currency": "EUR",
"amount": 100,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "6002ec81-6a00-4542-be83-dfa12f8618e7",
"cancelMovementId": null,
"additionalData": {}
}
Create a wireTransfer
Allowed for the PARTNER level or more
| merchantWireTransferId String |
Merchant Identification number Required: no Validation: .{0,100} |
||||||||||||||
| pointOfSaleId PointOfSale |
POS identification number Required: no Validation: - UUID - Existing - Authorized for the user Note: by default the POS is the user's POS by default |
||||||||||||||
| destinationBankAccountId BankAccount |
Identification number of Bank Account of destination
Required: no by default the bank account is the POS bank account and currency
|
||||||||||||||
| description String |
Description Required: no Validation: .{0,256} |
||||||||||||||
| currency Currency |
Currency Required: yes Validation: - ISO4217 alpha format or num - [A-Z}{3}|[0-9]{3} - Existing - Currency of the receiving Bank Account |
||||||||||||||
| amount Integer |
Amount Required: yes Validation: > 0 et <= 999999999 Note: in cents |
||||||||||||||
|
|||||||||||||||
| transferGroup String |
Identification number of the transfer group Required: no Validation: .{0,100} |
||||||||||||||
| customerId Customer |
Identification number of the customer Required: no Validation: - UUID - Existing - belongs to the merchant |
||||||||||||||
| additionalData[*] String |
Merchant data Required: no Validation: - Clé : .{45} - Valeur : .{256} Note: max 25 |
||||||||||||||
|
order[*] Order object |
Informations about the order Note: The JSON "Order" object |
||||||||||||||
| paymentRequestBreakdownId PaymentRequestBreakdown |
Identification of the PaymentRequestBreakdown Required: no Note: - UUID - Existant - belongs to the merchant - PaymentRequest.paymentRequestStatus = ACTIVE - PaymentRequestBreakdown.status != PAID |
||||||||||||||
[OBJ] WireTransfer
| wireTransferId UUID |
Wire transfer identification number |
| merchantWireTransferId String |
Merchant identification number |
| creationDate OffsetDateTime |
Creation date |
| status Enum WireTransferStatus |
Statut of the transfer Note: PENDING | RECEIVED | CANCELED |
| receiptDate OffsetDateTime |
Receipt date |
| cancellationDate OffsetDateTime |
Cancellation date |
| pointOfSaleId UUID |
POS Identification number |
| destinationBankAccountId UUID |
Identifiant of the receipt bank account |
| iban String |
IBAN of the receipt account Note: via the receipt account |
| bic String |
BIC of the receipt account Note: via the receipt account |
| sepaReference String |
Reference of the SEPA transfer |
| description String |
Description |
| currency String |
Currency Note: favorite format |
| amount Integer |
Amount |
| transfers List<TransactionTransfer> |
Transfers |
| transferGroup String |
Identification number of the group of transfer |
| customerId UUID |
Identification number of the customer |
| order Order |
Order's informations Note: The JSON "Order" object |
| commission Integer |
Commission |
| payoutAmount Integer |
Amount of repayment |
| fee Integer |
Fee |
| payoutCurrency String |
Currency of repayment Note: - favorite format - Currency of the receipt account |
| movementId UUID |
Identifiant number of the movement |
| cancelMovementId UUID |
Identifiant number of the cancellation movement |
| additionalData[*] Map |
Merchant data |
Example of curl code
curl -v --noproxy '*' --insecure https://test-api.centralpay.net/v2/rest/wireTransfer \
-u 'doctest:4I9HJRTd' \
--data-urlencode currency=EUR \
--data-urlencode merchantWireTransferId=MWRID-01 \
--data-urlencode amount=100Back to JSON format
{
"wireTransferId": "545653b7-6842-43e7-b556-21717ab9241e",
"creationDate": "2020-08-12T09:20:19.414860+02:00",
"receiptDate": null,
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "MWRID-01",
"status": "PENDING",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "CV3OMUNLDABRZVR",
"description": null,
"currency": "EUR",
"amount": 100,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "6002ec81-6a00-4542-be83-dfa12f8618e7",
"cancelMovementId": null,
"additionalData": {}
}
Example of curl code
curl -v --noproxy '*' --insecure https://test-api.centralpay.net/v2/rest/wireTransfer/1a61bc0f-4114-4f12-b02c-6f754bddc840 \
-u 'doctest:4I9HJRTd' \
--data-urlencode merchantWireTransferId=MWRID-02
Back to JSON format
{
"wireTransferId": "545653b7-6842-43e7-b556-21717ab9241e",
"creationDate": "2020-08-12T09:20:19.414860+02:00",
"receiptDate": null,
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "MWRID-02",
"status": "PENDING",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "CV3OMUNLDABRZVR",
"description": null,
"currency": "EUR",
"amount": 100,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "6002ec81-6a00-4542-be83-dfa12f8618e7",
"cancelMovementId": null,
"additionalData": {}
}
Update a wireTransfer
Allowed for the PARTNER level or more
| wireTransferId (URL) WireTransfer |
Identifiant number of the transfer Required: yes Validation: - UUID - Existing - Belongs to the merchant |
| merchantWireTransferId String |
Identification number of the merchant Required: no Validation: .{0,100} Note: unset with null value |
| description String |
Description Required: no Validation: .{0,256} Note: unset with null value |
| additionalData[*] String |
Merchant data Required: no Validation: - Key : .{45} - Value : .{256} - Max 25 in total Note: unset with null value |
| transferGroup String |
Identification number of the group of transfer Required: no Validation: .{0,100} Note: unset with null value |
Example of curl code
curl -v --noproxy '*' --insecure https://test-api.centralpay.net/v2/rest/wireTransfer/1a61bc0f-4114-4f12-b02c-6f754bddc840 \
-u 'doctest:4I9HJRTd' \
--data-urlencode merchantWireTransferId=MWRID-02
Back to JSON format
{
"wireTransferId": "545653b7-6842-43e7-b556-21717ab9241e",
"creationDate": "2020-08-12T09:20:19.414860+02:00",
"receiptDate": null,
"cancellationDate": null,
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "MWRID-02",
"status": "PENDING",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "CV3OMUNLDABRZVR",
"description": null,
"currency": "EUR",
"amount": 100,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "6002ec81-6a00-4542-be83-dfa12f8618e7",
"cancelMovementId": null,
"additionalData": {}
}
Example of curl code
curl -v --noproxy '*' --insecure -X POST https://test-api.centralpay.net/v2/rest/wireTransfer/545653b7-6842-43e7-b556-21717ab9241e/cancel \
-u 'doctest:4I9HJRTd'
Back to JSON format
"wireTransferId": "545653b7-6842-43e7-b556-21717ab9241e",
"creationDate": "2020-08-12T09:20:19.414860+02:00",
"receiptDate": null,
"cancellationDate": "2020-08-12T10:40:16.369698+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "MWRID-02",
"status": "CANCELED",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "CV3OMUNLDABRZVR",
"description": null,
"currency": "EUR",
"amount": 100,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "6002ec81-6a00-4542-be83-dfa12f8618e7",
"cancelMovementId": "a9e69521-e123-418a-a740-5bee05b6a895",
"additionalData": {}
}
Cancel a wireTransfer
Allowed for the PARTNER level or more
| wireTransferId (URL) WireTransfer |
Identifiant du virement Required: yes Validation: - UUID - Existing - Belongs to the merchant - status = PENDING |
Example of curl code
curl -v --noproxy '*' --insecure -X POST https://test-api.centralpay.net/v2/rest/wireTransfer/545653b7-6842-43e7-b556-21717ab9241e/cancel \
-u 'doctest:4I9HJRTd'
Back to JSON format
"wireTransferId": "545653b7-6842-43e7-b556-21717ab9241e",
"creationDate": "2020-08-12T09:20:19.414860+02:00",
"receiptDate": null,
"cancellationDate": "2020-08-12T10:40:16.369698+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "MWRID-02",
"status": "CANCELED",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "CV3OMUNLDABRZVR",
"description": null,
"currency": "EUR",
"amount": 100,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "6002ec81-6a00-4542-be83-dfa12f8618e7",
"cancelMovementId": "a9e69521-e123-418a-a740-5bee05b6a895",
"additionalData": {}
}
Example of curl code
curl -v --noproxy '*' --insecure https://test-api.centralpay.net/v2/rest/wireTransfer/545653b7-6842-43e7-b556-21717ab9241e \
-u 'doctest:4I9HJRTd'
Back to JSON format
{
"wireTransferId": "545653b7-6842-43e7-b556-21717ab9241e",
"creationDate": "2020-08-12T09:20:19.414860+02:00",
"receiptDate": null,
"cancellationDate": "2020-08-12T10:40:16.369698+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "MWRID-02",
"status": "CANCELED",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "CV3OMUNLDABRZVR",
"description": null,
"currency": "EUR",
"amount": 100,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "6002ec81-6a00-4542-be83-dfa12f8618e7",
"cancelMovementId": "a9e69521-e123-418a-a740-5bee05b6a895",
"additionalData": {}
}
Retrieve a wireTransfer
Allowed for the PARTNER level or more
| wireTransferId (URL) WireTransfer |
Identifiant du virement Required: yes Validation: - UUID - Existing - Belongs to the Merchant |
Example of curl code
curl -v --noproxy '*' --insecure https://test-api.centralpay.net/v2/rest/wireTransfer/545653b7-6842-43e7-b556-21717ab9241e \
-u 'doctest:4I9HJRTd'
Back to JSON format
{
"wireTransferId": "545653b7-6842-43e7-b556-21717ab9241e",
"creationDate": "2020-08-12T09:20:19.414860+02:00",
"receiptDate": null,
"cancellationDate": "2020-08-12T10:40:16.369698+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "MWRID-02",
"status": "CANCELED",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "CV3OMUNLDABRZVR",
"description": null,
"currency": "EUR",
"amount": 100,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "6002ec81-6a00-4542-be83-dfa12f8618e7",
"cancelMovementId": "a9e69521-e123-418a-a740-5bee05b6a895",
"additionalData": {}
}
Example of curl code
curl -X GET -v --noproxy '*' --insecure https://test-api.centralpay.net/v2/rest/wireTransfer \
-u 'doctest:4I9HJRTd'
Back to JSON format
{
"list": [
{
"wireTransferId": "545653b7-6842-43e7-b556-21717ab9241e",
"creationDate": "2020-08-12T09:20:19.414860+02:00",
"receiptDate": null,
"cancellationDate": "2020-08-12T10:40:16.369698+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "MWRID-02",
"status": "CANCELED",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "CV3OMUNLDABRZVR",
"description": null,
"currency": "EUR",
"amount": 100,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "6002ec81-6a00-4542-be83-dfa12f8618e7",
"cancelMovementId": "a9e69521-e123-418a-a740-5bee05b6a895",
"additionalData": {}
},
{
"wireTransferId": "1a61bc0f-4114-4f12-b02c-6f754bddc840",
"creationDate": "2020-04-23T08:59:38.075294+02:00",
"receiptDate": null,
"cancellationDate": "2020-04-23T09:10:08.777702+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "MWRID-02",
"status": "CANCELED",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "YYJIUKL8MKUNQHE",
"description": null,
"currency": "EUR",
"amount": 100,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "df985750-2409-4820-9512-c26ad57eb97b",
"cancelMovementId": "0a79a5c6-4d48-46f0-840a-1077a00fd8a8",
"additionalData": {}
}
],
"totalCount": 7
}
List wireTransfer
All the paramers used to search must be passed in the form of queries parameters.
Allowed for the PARTNER level or more
| merchantWireTransferId String |
Identification nulber of the merchant Required: no Validation: .{0,100} |
| status Enum WireTransferStatus |
Statut of the transfer Required: no |
| pointOfSaleId PointOfSale |
Identification number of the POS Required: no Validation: - UUID - Existing - Belongs to the merchant |
| destinationBankAccountId BankAccount |
Identification number of the Back Account Required: no Validation: - UUID - Existing - Is linked to the POS (Specific link to Wire Transfer) belonging to the merchant |
| sepaReference String |
Reference of the SEPA transfer Required: no Validation: [A-Z0-9]{15} |
| currency String |
Currency Required: no Validation: - ISO4217 in format alpha or num - [A-Z}{3}|[0-9]{3} - Existing |
| transferGroup String |
Identification number of the transfer group Required: no Validation: .{0,100} |
| customerId Customer |
Identification number of the customer Required: no Validation: - UUID - Existing - Belongs to the merchant |
Example of curl code
curl -X GET -v --noproxy '*' --insecure https://test-api.centralpay.net/v2/rest/wireTransfer \
-u 'doctest:4I9HJRTd'
Back to JSON format
{
"list": [
{
"wireTransferId": "545653b7-6842-43e7-b556-21717ab9241e",
"creationDate": "2020-08-12T09:20:19.414860+02:00",
"receiptDate": null,
"cancellationDate": "2020-08-12T10:40:16.369698+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "MWRID-02",
"status": "CANCELED",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "CV3OMUNLDABRZVR",
"description": null,
"currency": "EUR",
"amount": 100,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "6002ec81-6a00-4542-be83-dfa12f8618e7",
"cancelMovementId": "a9e69521-e123-418a-a740-5bee05b6a895",
"additionalData": {}
},
{
"wireTransferId": "1a61bc0f-4114-4f12-b02c-6f754bddc840",
"creationDate": "2020-04-23T08:59:38.075294+02:00",
"receiptDate": null,
"cancellationDate": "2020-04-23T09:10:08.777702+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6",
"customerId": null,
"merchantWireTransferId": "MWRID-02",
"status": "CANCELED",
"iban": "FR7618206002105487266700217",
"bic": "PSSTFRPPLIL",
"sepaReference": "YYJIUKL8MKUNQHE",
"description": null,
"currency": "EUR",
"amount": 100,
"transferGroup": null,
"payoutCurrency": "EUR",
"payoutAmount": 100,
"commission": 0,
"fee": 0,
"order": {
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"addressLine4": null,
"cardCountry": null,
"cardholderEmail": null,
"cardholderName": null,
"city": null,
"country": null,
"email": null,
"firstName": null,
"lastName": null,
"phone": null,
"postalCode": null
},
"transactionTransfers": [],
"movementId": "df985750-2409-4820-9512-c26ad57eb97b",
"cancelMovementId": "0a79a5c6-4d48-46f0-840a-1077a00fd8a8",
"additionalData": {}
}
],
"totalCount": 7
}
wireTransfer Object
Allowed for the PARTNER level or more
[OBJ] WireTransfer Object
| wireTransferId UUID |
Wire transfer identification number |
| merchantWireTransferId String |
Merchant identification number |
| creationDate OffsetDateTime |
Creation date |
|
paymentRequestBreakdownId UUID |
Identifier UUID of the PaymentRequestBreakdown Note: Not empty if the wiretransfer is linked to a Payment Request |
|
paymentRequestId UUID |
Identifier UUID of the Payment Request Note: Not empty if the wiretransfer is linked to a Payment Request |
| status Enum WireTransferStatus |
Statut of the transfer Note: PENDING | RECEIVED | CANCELED |
| receiptDate OffsetDateTime |
Receipt date |
| cancellationDate OffsetDateTime |
Cancellation date |
| pointOfSaleId UUID |
POS Identification number |
| destinationBankAccountId UUID |
Identifiant of the receipt bank account |
| iban String |
IBAN of the receipt account Note: via the receipt account |
| bic String |
BIC of the receipt account Note: via the receipt account |
| sepaReference String |
Reference of the SEPA transfer |
| description String |
Description |
| currency String |
Currency Note: favorite format |
| amount Integer |
Amount |
| transfers List<TransactionTransfer> |
Transfers |
| transferGroup String |
Identification number of the group of transfer |
| customerId UUID |
Identification number of the customer |
| order Order |
Order's informations Note: The JSON "Order" object |
| commission Integer |
Commission |
| payoutAmount Integer |
Amount of repayment |
| fee Integer |
Fee |
| payoutCurrency String |
Currency of repayment Note: - favorite format - Currency of the receipt account |
| movementId UUID |
Identifiant number of the movement |
| cancelMovementId UUID |
Identifiant number of the cancellation movement |
| additionalData[*] Map |
Merchant data |
Customer
Customer objects allow you to process recurring payments and track multiple payments associated to one customer. The API allows you to create, delete, and update your customers data. You can retrieve individual customers as well as a list of all your customers.
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/customer \
-u 'doctest:4I9HJRTd' \
-d merchantCustomerId='Client-0001' \
-d firstName='John' \
-d lastName='Doe' \
-d addressLine1='17 rue de la poste' \
-d addressLine2='Appt 51' \
-d postalCode='37000' \
-d city='Tours' \
-d country='FR' \
-d email='john.doe@gmail.com' \
-d cardTokenId='3f2cc44d-e7c1-4e18-a510-17cf9a33ce33'
Back to Json format
{
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"creationDate": "2020-08-12T14:00:16.021224+02:00",
"merchantCustomerId": "Client-0001",
"firstName": "JOHN",
"lastName": "DOE",
"email": "john.doe@gmail.com",
"phone": null,
"addressLine1": "17 RUE DE LA POSTE",
"addressLine2": "APPT 51",
"addressLine3": null,
"addressLine4": null,
"postalCode": "37000",
"city": "TOURS",
"country": "FRA",
"cards": [
{
"cardId": "ee01b15c-fa6e-41a7-98d2-7a61969db91f",
"creationDate": "2020-08-12T13:58:18.507694+02:00",
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"cardTokenId": "0b532d06-f780-41e5-9c7a-487667e4b8b9",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
}
],
"description": null,
"language": null,
"otpExpired": false,
"subscriptions": [],
"installmentPayments": [],
"fee": 0,
"totalCharge": 0,
"movementId": null,
"otpExpirationDate": null,
"additionalData": {}
}
Create a customer
This function allows you to create a customer (a valid email address is required). You need to register a card when you create a customer.
| cardTokenId UUID |
CentralPay token ID Required: yes - cardTokenId OR card[*] Validation: UUID |
| card[*] * |
Card data Required: yes - cardTokenId OR card[*] |
| merchantCustomerId String (100) |
Merchant ID Required: no Validation: .{0,100} |
| firstName String (35) |
First Name Required: no Validation: .{0,35} |
| lastName String (35) |
Last Name Required: no Validation: .{0,35} |
| addressLine1 String (255) |
Address (line 1) Required: no Validation: .{0,255} |
| addressLine2 String (255) |
Address (line 2) Required: no Validation: .{0,255} |
| addressLine3 String (255) |
Address (line 3) Required: no Validation: .{0,255} |
| addressLine4 String (255) |
Address (line 4) Required: no Validation: .{0,255} |
| postalCode String |
Postal code Required: no Validation: [a-zA-Z0-9{space}-]{0,15} |
| city String (35) |
City
Required: no |
| country Country |
Country Required: no Validation: ISO3166 in format alpha2, alpha3 or num [0-9]{3}|[A-Z]{2}|[A-Z]{3} Existing |
| email String (255) |
Email Required: YES Validation: Email |
| phone String |
Phone Required: no Validation: [0-9\\+\\.\\-\\ \\(\\)]{0,25} |
| language String |
Language of the customer
Required: no - ISO 639-2 (3charac) or ISO 639-1 (2charac) |
| description String (256) |
Description Required: no Validation: .{0,256} |
| additionalData String (303) |
Merchant data
Required: no Sample: additionalData=[Key]Value |
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/customer \
-u 'doctest:4I9HJRTd' \
-d merchantCustomerId='Client-0001' \
-d firstName='John' \
-d lastName='Doe' \
-d addressLine1='17 rue de la poste' \
-d addressLine2='Appt 51' \
-d postalCode='37000' \
-d city='Tours' \
-d country='FR' \
-d email='john.doe@gmail.com' \
-d cardTokenId='3f2cc44d-e7c1-4e18-a510-17cf9a33ce33'
Back to Json format
{
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"creationDate": "2020-08-12T14:00:16.021224+02:00",
"merchantCustomerId": "Client-0001",
"firstName": "JOHN",
"lastName": "DOE",
"email": "john.doe@gmail.com",
"phone": null,
"addressLine1": "17 RUE DE LA POSTE",
"addressLine2": "APPT 51",
"addressLine3": null,
"addressLine4": null,
"postalCode": "37000",
"city": "TOURS",
"country": "FRA",
"cards": [
{
"cardId": "ee01b15c-fa6e-41a7-98d2-7a61969db91f",
"creationDate": "2020-08-12T13:58:18.507694+02:00",
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"cardTokenId": "0b532d06-f780-41e5-9c7a-487667e4b8b9",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
}
],
"description": null,
"language": null,
"otpExpired": false,
"subscriptions": [],
"installmentPayments": [],
"fee": 0,
"totalCharge": 0,
"movementId": null,
"otpExpirationDate": null,
"additionalData": {}
}
Example of curl code
curl -X POST -v https://test-api.centralpay.net/v2/rest/customer/7934ff53-4515-4ec0-adda-2529f0cf373e \
-u 'doctest:4I9HJRTd' \
-d addressLine1='24 avenue de la promenade'
Back to Json format
{
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"creationDate": "2020-08-12T14:00:16.021224+02:00",
"merchantCustomerId": "Client-0001",
"firstName": "JOHN",
"lastName": "DOE",
"email": "john.doe@gmail.com",
"phone": null,
"addressLine1": "24 AVENUE DE LA PROMENADE",
"addressLine2": "APPT 51",
"addressLine3": null,
"addressLine4": null,
"postalCode": "37000",
"city": "TOURS",
"country": "FRA",
"cards": [
{
"cardId": "ee01b15c-fa6e-41a7-98d2-7a61969db91f",
"creationDate": "2020-08-12T13:58:18.507694+02:00",
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"cardTokenId": "0b532d06-f780-41e5-9c7a-487667e4b8b9",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
}
],
"description": null,
"language": null,
"otpExpired": false,
"subscriptions": [],
"installmentPayments": [],
"fee": 0,
"totalCharge": 0,
"movementId": null,
"otpExpirationDate": null,
"additionalData": {}
}
Update a customer
This function allows you to search and update the customer's information with the customer ID.
| customerId UUID (36) |
CentralPay client ID Required: yes |
| merchantCustomerId String (100) |
Merchant ID Required: no Validation: .{0,100} |
| firstName String (35) |
First name Required: no Validation: .{0,35} |
| lastName String (35) |
Last name Required: no Validation: .{0,35} |
| addressLine1 String (255) |
Address (line 1) Required: no Validation: .{0,255} |
| addressLine2 String (255) |
Address (line 2) Required: no Validation: .{0,255} |
| addressLine3 String (255) |
Address (line 3) Required: no Validation: .{0,255} |
| addressLine4 String (255) |
Address (line 4) Required: no Validation: .{0,255} |
| postalCode String |
Code postal Required: no Validation: [a-zA-Z0-9{space}-]{0,15} |
| city String (35) |
City Required: no Validation: .{0,35} |
| country ISO3166 |
Country Required: no Validation: ISO3166 in format alpha2, apha3 or num [0-9]{3}|[A-Z]{2}|[A-Z]{3} Existing |
| email String (255) |
Email Required: no Validation: Email |
| phone String |
Phone Required: no Validation: [0-9\\+\\.\\-\\ \\(\\)]{0,25} |
| language String |
Language
Required: no - ISO 639-2 (3 chara) or ISO 639-1 (2 chara) |
| cardTokenId UUID (36) |
CentralPay token ID Required: no - cardTokenId OR card[*] Validation: UUID |
| card[*] | Card data Required: no - cardTokenId OR card[*] Note: Cf. The sub-object "Card[*]" |
| description String (256) |
Description Required: no Validation: .{0,256} |
| additionalData String (303) |
Merchant data
Required: no Sample : additionalData=[Key]Value |
Example of curl code
curl -X POST -v https://test-api.centralpay.net/v2/rest/customer/7934ff53-4515-4ec0-adda-2529f0cf373e \
-u 'doctest:4I9HJRTd' \
-d addressLine1='24 avenue de la promenade'
Back to Json format
{
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"creationDate": "2020-08-12T14:00:16.021224+02:00",
"merchantCustomerId": "Client-0001",
"firstName": "JOHN",
"lastName": "DOE",
"email": "john.doe@gmail.com",
"phone": null,
"addressLine1": "24 AVENUE DE LA PROMENADE",
"addressLine2": "APPT 51",
"addressLine3": null,
"addressLine4": null,
"postalCode": "37000",
"city": "TOURS",
"country": "FRA",
"cards": [
{
"cardId": "ee01b15c-fa6e-41a7-98d2-7a61969db91f",
"creationDate": "2020-08-12T13:58:18.507694+02:00",
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"cardTokenId": "0b532d06-f780-41e5-9c7a-487667e4b8b9",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
}
],
"description": null,
"language": null,
"otpExpired": false,
"subscriptions": [],
"installmentPayments": [],
"fee": 0,
"totalCharge": 0,
"movementId": null,
"otpExpirationDate": null,
"additionalData": {}
}
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/customer/7934ff53-4515-4ec0-adda-2529f0cf373e \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"creationDate": "2020-08-12T14:00:16.021224+02:00",
"merchantCustomerId": "Client-0001",
"firstName": "JOHN",
"lastName": "DOE",
"email": "john.doe@gmail.com",
"phone": null,
"addressLine1": "24 AVENUE DE LA PROMENADE",
"addressLine2": "APPT 51",
"addressLine3": null,
"addressLine4": null,
"postalCode": "37000",
"city": "TOURS",
"country": "FRA",
"cards": [
{
"cardId": "ee01b15c-fa6e-41a7-98d2-7a61969db91f",
"creationDate": "2020-08-12T13:58:18.507694+02:00",
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"cardTokenId": "0b532d06-f780-41e5-9c7a-487667e4b8b9",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
}
],
"description": null,
"language": null,
"otpExpired": false,
"subscriptions": [],
"installmentPayments": [],
"fee": 0,
"totalCharge": 0,
"movementId": null,
"otpExpirationDate": null,
"additionalData": {}
}
Retrieve a customer
This function allows you to retrieve a Customer with a CustomerID.
| customerId UUID (36) |
CentralPay customer ID Required: yes Validation: UUID |
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/customer/7934ff53-4515-4ec0-adda-2529f0cf373e \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"creationDate": "2020-08-12T14:00:16.021224+02:00",
"merchantCustomerId": "Client-0001",
"firstName": "JOHN",
"lastName": "DOE",
"email": "john.doe@gmail.com",
"phone": null,
"addressLine1": "24 AVENUE DE LA PROMENADE",
"addressLine2": "APPT 51",
"addressLine3": null,
"addressLine4": null,
"postalCode": "37000",
"city": "TOURS",
"country": "FRA",
"cards": [
{
"cardId": "ee01b15c-fa6e-41a7-98d2-7a61969db91f",
"creationDate": "2020-08-12T13:58:18.507694+02:00",
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"cardTokenId": "0b532d06-f780-41e5-9c7a-487667e4b8b9",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"check": false,
"additionalData": {}
}
],
"description": null,
"language": null,
"otpExpired": false,
"subscriptions": [],
"installmentPayments": [],
"fee": 0,
"totalCharge": 0,
"movementId": null,
"otpExpirationDate": null,
"additionalData": {}
}
Example of curl code
curl -v 'https://test-api.centralpay.net/v2/rest/customer?email=john.doe@gmail.com' \
-u 'doctest:4I9HJRTd'
Back to Json format
{
{
"list": [
{
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"creationDate": "2020-08-12T14:00:16.021224+02:00",
"merchantCustomerId": "Client-0001",
"firstName": "JOHN",
"lastName": "DOE",
"email": "john.doe@gmail.com",
"phone": null,
"addressLine1": "24 AVENUE DE LA PROMENADE",
"addressLine2": "APPT 51",
"addressLine3": null,
"addressLine4": null,
"postalCode": "37000",
"city": "TOURS",
"country": "FRA",
"cards": [
{
"cardId": "ee01b15c-fa6e-41a7-98d2-7a61969db91f",
"creationDate": "2020-08-12T13:58:18.507694+02:00",
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"cardTokenId": "0b532d06-f780-41e5-9c7a-487667e4b8b9",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
}
],
"description": null,
"language": null,
"otpExpired": false,
"subscriptions": [],
"installmentPayments": [],
"fee": 0,
"totalCharge": 0,
"movementId": null,
"otpExpirationDate": null,
"additionalData": {}
},
{
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"creationDate": "2020-05-18T14:12:23.251530+02:00",
"merchantCustomerId": "Client-0001",
"firstName": "JOHN",
"lastName": "DOE",
"email": "john.doe@gmail.com",
"phone": null,
"addressLine1": "17 RUE DE LA POSTE",
"addressLine2": "APPT 51",
"addressLine3": null,
"addressLine4": null,
"postalCode": "37000",
"city": "TOURS",
"country": "FRA",
"cards": [
{
"cardId": "00bdce25-081d-49e6-b0d5-27a0ad57a841",
"creationDate": "2020-08-11T12:26:46.805601+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0010",
"expirationMonth": 1,
"expirationYear": 2022,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": "crichard@centralpay.eu",
"description": null,
"fingerprint": "10721aca1a21d1db476611da0978073ab30b8c08",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
{
"cardId": "3a9bfa88-816f-467b-aea3-f89dbd9c2157",
"creationDate": "2020-08-11T11:57:18.686423+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 1,
"expirationYear": 2022,
"country": "FRA",
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "36c3da543d36020089ca151dc28cab87ccf36753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
{
"cardId": "a94d9def-025d-4631-84f4-d0a77ac88a3a",
"creationDate": "2020-08-11T11:53:29.301174+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0010",
"expirationMonth": 12,
"expirationYear": 2035,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "c20b2edda5bea300b995b678556e637b04657720",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
{
"cardId": "377c3954-6053-427b-8c77-2605a53be71c",
"creationDate": "2020-05-18T14:12:23.499364+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2020,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "7d601480c486eb5445e72a4b4e53ff4084679bcb",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
}
],
"description": null,
"language": null,
"otpExpired": false,
"subscriptions": [],
"installmentPayments": [],
"fee": 0,
"totalCharge": 0,
"movementId": null,
"otpExpirationDate": null,
"additionalData": {}
}
],
"totalCount": 52
}
List customers
This function allows you to search objects from a multi-criteria search. All the paramers used to search must be passed in the form of queries parameters.
« Customer » specific parameters
| merchantCustomerId String (100) |
Merchant ID Required: no Validation: .{0,100} |
| email String (255) |
Email Required: no Validation: Email |
Example of curl code
curl -v 'https://test-api.centralpay.net/v2/rest/customer?email=john.doe@gmail.com' \
-u 'doctest:4I9HJRTd'
Back to Json format
{
{
"list": [
{
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"creationDate": "2020-08-12T14:00:16.021224+02:00",
"merchantCustomerId": "Client-0001",
"firstName": "JOHN",
"lastName": "DOE",
"email": "john.doe@gmail.com",
"phone": null,
"addressLine1": "24 AVENUE DE LA PROMENADE",
"addressLine2": "APPT 51",
"addressLine3": null,
"addressLine4": null,
"postalCode": "37000",
"city": "TOURS",
"country": "FRA",
"cards": [
{
"cardId": "ee01b15c-fa6e-41a7-98d2-7a61969db91f",
"creationDate": "2020-08-12T13:58:18.507694+02:00",
"customerId": "7934ff53-4515-4ec0-adda-2529f0cf373e",
"cardTokenId": "0b532d06-f780-41e5-9c7a-487667e4b8b9",
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2022,
"country": null,
"cardholderName": null,
"cardholderEmail": null,
"description": null,
"fingerprint": "c77148952008b395b27050bed6f1b127609cb753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
}
],
"description": null,
"language": null,
"otpExpired": false,
"subscriptions": [],
"installmentPayments": [],
"fee": 0,
"totalCharge": 0,
"movementId": null,
"otpExpirationDate": null,
"additionalData": {}
},
{
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"creationDate": "2020-05-18T14:12:23.251530+02:00",
"merchantCustomerId": "Client-0001",
"firstName": "JOHN",
"lastName": "DOE",
"email": "john.doe@gmail.com",
"phone": null,
"addressLine1": "17 RUE DE LA POSTE",
"addressLine2": "APPT 51",
"addressLine3": null,
"addressLine4": null,
"postalCode": "37000",
"city": "TOURS",
"country": "FRA",
"cards": [
{
"cardId": "00bdce25-081d-49e6-b0d5-27a0ad57a841",
"creationDate": "2020-08-11T12:26:46.805601+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0010",
"expirationMonth": 1,
"expirationYear": 2022,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": "crichard@centralpay.eu",
"description": null,
"fingerprint": "10721aca1a21d1db476611da0978073ab30b8c08",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
{
"cardId": "3a9bfa88-816f-467b-aea3-f89dbd9c2157",
"creationDate": "2020-08-11T11:57:18.686423+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 1,
"expirationYear": 2022,
"country": "FRA",
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "36c3da543d36020089ca151dc28cab87ccf36753",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
{
"cardId": "a94d9def-025d-4631-84f4-d0a77ac88a3a",
"creationDate": "2020-08-11T11:53:29.301174+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0010",
"expirationMonth": 12,
"expirationYear": 2035,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "c20b2edda5bea300b995b678556e637b04657720",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
},
{
"cardId": "377c3954-6053-427b-8c77-2605a53be71c",
"creationDate": "2020-05-18T14:12:23.499364+02:00",
"customerId": "3feb0242-2594-44a3-a550-4790306dfcdf",
"cardTokenId": null,
"merchantCardId": null,
"commercialBrand": "VISA",
"first6": "400000",
"last4": "0002",
"expirationMonth": 12,
"expirationYear": 2020,
"country": null,
"cardholderName": "JDOE",
"cardholderEmail": null,
"description": null,
"fingerprint": "7d601480c486eb5445e72a4b4e53ff4084679bcb",
"cardType": null,
"region": null,
"productType": null,
"europeanEconomicArea": null,
"additionalData": {}
}
],
"description": null,
"language": null,
"otpExpired": false,
"subscriptions": [],
"installmentPayments": [],
"fee": 0,
"totalCharge": 0,
"movementId": null,
"otpExpirationDate": null,
"additionalData": {}
}
],
"totalCount": 52
}
Customer object
The Json "customer" object
The « customer » object represents a customer
| customerId String (36) |
CentralPay customer ID Note: UUID Format |
| merchantCustomerId String (100) |
Client merchant ID |
| creationDate String |
Creation date Comment: ISO 8601 |
| firstName String (35) |
First name |
| lastName String (35) |
Last name |
| addressLine1 String |
Address (line 1) |
| addressLine2 String |
Address (line 2) |
| addressLine3 String |
Address (line |
| addressLine4 String |
Address (line 4) |
| postalCode String |
Postal code |
| city String |
City |
| country String |
Country Note: Favourite format (See Annex 4) |
| email String |
|
| phone String |
Phone |
| language String |
Language of the customer Note: Format ISO 639-2 (3 charac) |
| cards Array of Card object |
Cards Note: See Json "Card" object |
| subscriptions[*] List of the subscription object |
List of the subscribtions the customer applied |
| installmentPayments[*] List of the installementPayment object |
List of the installmentPayement the customer applied |
| description String |
Description |
| otpExpirationDate Date |
Date of the OTP's expiration |
| otpExpired Boolean |
OTP is expired |
| additionalData Object |
Merchant data Note: Contains keys/values |
| fee Integer |
Fee |
| totalCharge Integer |
Total charge |
| movementId String |
Identification number of the movement Note: UUID format |
Disputes
A dispute is opened when a customer questions a transaction with their bank or credit/debit card provider.
When the transaction is tagged as a dispute, you can respond to the dispute with evidence that shows the charge is legitimate. If the transaction cannot be proven legitimate, the dispute will become a chargeback.
HTTP Request
POST https://test-api.centralpay.net/v2/rest/dispute
HTTP Response
OBJ Json Dispute typeExemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/dispute \
-u 'doctest:4I9HJRTd' \
-d transactionId=f9dce593-2afd-4ecc-bab4-79bb8c45774d \
-d merchantDisputeId=REF_561 \
-d disputeDate=2020-01-04 \
-d amount=300 \
-d reason=FRAUDULENT \
-d status=RETRIEVAL_NOTICED \
-d evidencesDeadline=2035-02-07 \
-d description='Chargeback 01'Back to JSON Format
{
"disputeId": "095fa8de-0c90-45ee-96b7-cc1f34411398",
"creationDate": "2020-08-12T16:17:34.237354+02:00",
"transactionId": "f9dce593-2afd-4ecc-bab4-79bb8c45774d",
"disputeDate": "2020-01-04",
"merchantDisputeId": "REF_561",
"description": "Chargeback 01",
"amount": 300,
"currency": "EUR",
"reason": "FRAUDULENT",
"status": "RETRIEVAL_NOTICED",
"fee": 0,
"evidencesDeadline": "2035-02-07",
"movementId": null,
"wonMovementId": null,
"additionalData": {}
}Create a dispute
This function allows you to create a dispute.
| transactionId String |
Identification number of the transaction concerned by the dispute
Required: yes -The transaction must be cleared before a dispute can occur- Belongs to the merchant Note: Number of key/value pairs as it can take multiple key and values. |
| merchantDisputeId String (100) |
Merchant Identification number for the dispute
Required: no |
| disputeDate String |
Date of the dispute
Required: yes |
| description String |
Description
Required: no |
| amount Integer |
Merchant data
Required: yes Note : in cents |
| reason String |
Reason of the dispute
Required: yes Note: FRAUDULENT |
| status String |
Status of the dispute
Required: yes |
| evidencesDeadline String |
Deadline to provide an evidence
Required: no Note:ISO 8601 |
| additionalData String (303) |
Merchant data
Required: no Note: Number of key/value pairs as it can take multiple key and values. |
HTTP Request
POST https://test-api.centralpay.net/v2/rest/dispute
HTTP Response
OBJ Json Dispute typeExemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/dispute \
-u 'doctest:4I9HJRTd' \
-d transactionId=f9dce593-2afd-4ecc-bab4-79bb8c45774d \
-d merchantDisputeId=REF_561 \
-d disputeDate=2020-01-04 \
-d amount=300 \
-d reason=FRAUDULENT \
-d status=RETRIEVAL_NOTICED \
-d evidencesDeadline=2035-02-07 \
-d description='Chargeback 01'Back to JSON Format
{
"disputeId": "095fa8de-0c90-45ee-96b7-cc1f34411398",
"creationDate": "2020-08-12T16:17:34.237354+02:00",
"transactionId": "f9dce593-2afd-4ecc-bab4-79bb8c45774d",
"disputeDate": "2020-01-04",
"merchantDisputeId": "REF_561",
"description": "Chargeback 01",
"amount": 300,
"currency": "EUR",
"reason": "FRAUDULENT",
"status": "RETRIEVAL_NOTICED",
"fee": 0,
"evidencesDeadline": "2035-02-07",
"movementId": null,
"wonMovementId": null,
"additionalData": {}
}HTTP Request
POST https://test-api.centralpay.net/v2/rest/dispute/<disputeId>HTTP Response
OBJ Json Dispute typeExample of curl code
curl -v https://test-api.centralpay.net/v2/rest/dispute/095fa8de-0c90-45ee-96b7-cc1f34411398 \
-u 'doctest:4I9HJRTd' \
-d description='Chargeback 01 - Ref005' \
-d status=CHARGEBACK_NOTICEDBack to Json format
{
"disputeId": "095fa8de-0c90-45ee-96b7-cc1f34411398",
"creationDate": "2020-08-12T16:17:34.237354+02:00",
"transactionId": "f9dce593-2afd-4ecc-bab4-79bb8c45774d",
"disputeDate": "2020-01-04",
"merchantDisputeId": "REF_561",
"description": "Chargeback 01 - Ref005",
"amount": 300,
"currency": "EUR",
"reason": "FRAUDULENT",
"status": "CHARGEBACK_NOTICED",
"fee": 0,
"evidencesDeadline": "2035-02-07",
"movementId": "6cd3ae00-9f14-4703-9728-102e65a232c9",
"wonMovementId": null,
"additionalData": {}
}Update a dispute
This function allows you to update the information and status of the dispute with the dispute ID.
| disputeId String (100) |
Identification number of dispute
Required: yes (URL) - Authorized for the user Note : UUID |
| merchantDisputeId String (100) |
Merchant Identification number for the dispute
Required: no |
| description String |
Description
Required: no |
| status |
Status of the dispute Required: no Note: RETRIEVAL_NOTICED
RETRIEVAL_CLOSE
CHARGEBACK_NOTICED
CHARGEBACK_WON
CHARGEBACK_LOST
|
| additionalData String (303) |
Merchant data
Required: no Note: Number of key/value pairs as it can take multiple key and values. |
HTTP Request
POST https://test-api.centralpay.net/v2/rest/dispute/<disputeId>HTTP Response
OBJ Json Dispute typeExample of curl code
curl -v https://test-api.centralpay.net/v2/rest/dispute/095fa8de-0c90-45ee-96b7-cc1f34411398 \
-u 'doctest:4I9HJRTd' \
-d description='Chargeback 01 - Ref005' \
-d status=CHARGEBACK_NOTICEDBack to Json format
{
"disputeId": "095fa8de-0c90-45ee-96b7-cc1f34411398",
"creationDate": "2020-08-12T16:17:34.237354+02:00",
"transactionId": "f9dce593-2afd-4ecc-bab4-79bb8c45774d",
"disputeDate": "2020-01-04",
"merchantDisputeId": "REF_561",
"description": "Chargeback 01 - Ref005",
"amount": 300,
"currency": "EUR",
"reason": "FRAUDULENT",
"status": "CHARGEBACK_NOTICED",
"fee": 0,
"evidencesDeadline": "2035-02-07",
"movementId": "6cd3ae00-9f14-4703-9728-102e65a232c9",
"wonMovementId": null,
"additionalData": {}
}HTTP Request
GET https://test-api.centralpay.net/v2/dispute/<disputeId>HTTP Response
OBJ Json Dispute typeExample of html code
curl -X GET -v https://test-api.centralpay.net/v2/rest/dispute/095fa8de-0c90-45ee-96b7-cc1f34411398 \
-u 'doctest:4I9HJRTd'
{
"disputeId": "095fa8de-0c90-45ee-96b7-cc1f34411398",
"creationDate": "2020-08-12T16:17:34.237354+02:00",
"transactionId": "f9dce593-2afd-4ecc-bab4-79bb8c45774d",
"disputeDate": "2020-01-04",
"merchantDisputeId": "REF_561",
"description": "Chargeback 01 - Ref005",
"amount": 300,
"currency": "EUR",
"reason": "FRAUDULENT",
"status": "CHARGEBACK_NOTICED",
"fee": 0,
"evidencesDeadline": "2035-02-07",
"movementId": "6cd3ae00-9f14-4703-9728-102e65a232c9",
"wonMovementId": null,
"additionalData": {}
}Retrieve a dispute
This function allows you to retrieve a Dispute with the Dispute ID.
| disputeId UUID (36) |
CentralPay dispute ID Required: yes Validation: UUID |
HTTP Request
GET https://test-api.centralpay.net/v2/dispute/<disputeId>HTTP Response
OBJ Json Dispute typeExample of html code
curl -X GET -v https://test-api.centralpay.net/v2/rest/dispute/095fa8de-0c90-45ee-96b7-cc1f34411398 \
-u 'doctest:4I9HJRTd'
{
"disputeId": "095fa8de-0c90-45ee-96b7-cc1f34411398",
"creationDate": "2020-08-12T16:17:34.237354+02:00",
"transactionId": "f9dce593-2afd-4ecc-bab4-79bb8c45774d",
"disputeDate": "2020-01-04",
"merchantDisputeId": "REF_561",
"description": "Chargeback 01 - Ref005",
"amount": 300,
"currency": "EUR",
"reason": "FRAUDULENT",
"status": "CHARGEBACK_NOTICED",
"fee": 0,
"evidencesDeadline": "2035-02-07",
"movementId": "6cd3ae00-9f14-4703-9728-102e65a232c9",
"wonMovementId": null,
"additionalData": {}
}HTTP Request
GET https://test-api.centralpay.net/v2/rest/disputeHTTP Response
List OBJ Json Dispute typeExample of html code
curl -X GET -v https://test-api.centralpay.net/v2/rest/dispute?status=CHARGEBACK_NOTICED \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list": [
{
"disputeId": "095fa8de-0c90-45ee-96b7-cc1f34411398",
"creationDate": "2020-08-12T16:17:34.237354+02:00",
"transactionId": "f9dce593-2afd-4ecc-bab4-79bb8c45774d",
"disputeDate": "2020-01-04",
"merchantDisputeId": "REF_561",
"description": "Chargeback 01 - Ref005",
"amount": 300,
"currency": "EUR",
"reason": "FRAUDULENT",
"status": "CHARGEBACK_NOTICED",
"fee": 0,
"evidencesDeadline": "2035-02-07",
"movementId": "6cd3ae00-9f14-4703-9728-102e65a232c9",
"wonMovementId": null,
"additionalData": {}
},
{
"disputeId": "56848d84-f8ff-461d-9501-92df32da35c9",
"creationDate": "2019-10-30T14:20:18.352317+01:00",
"transactionId": "be8de5a0-2739-4e94-9c13-7c48bdf929c3",
"disputeDate": "2019-10-30",
"merchantDisputeId": null,
"description": null,
"amount": 299,
"currency": "EUR",
"reason": "FRAUDULENT",
"status": "CHARGEBACK_NOTICED",
"fee": 0,
"evidencesDeadline": "2019-10-30",
"movementId": "5654da4a-dbae-4cab-8b1e-442bc74b1dee",
"wonMovementId": null,
"additionalData": {}
}
],
"totalCount": 2
}List disputes
This function allows you to search objects from a multi-criteria search. All the paramers used to search must be passed in the form of queries parameters.
« Dispute » specific parameters
| merchantDisputeId String (100) |
Merchant Identification number for the dispute
Required: no |
| status |
Status of the dispute Required: no Note: RETRIEVAL_NOTICED
RETRIEVAL_CLOSE
CHARGEBACK_NOTICED
CHARGEBACK_WON
CHARGEBACK_LOST
|
| disputeDate String |
Date of dispute Required: no
Note: ISO 8601 |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/disputeHTTP Response
List OBJ Json Dispute typeExample of html code
curl -X GET -v https://test-api.centralpay.net/v2/rest/dispute?status=CHARGEBACK_NOTICED \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list": [
{
"disputeId": "095fa8de-0c90-45ee-96b7-cc1f34411398",
"creationDate": "2020-08-12T16:17:34.237354+02:00",
"transactionId": "f9dce593-2afd-4ecc-bab4-79bb8c45774d",
"disputeDate": "2020-01-04",
"merchantDisputeId": "REF_561",
"description": "Chargeback 01 - Ref005",
"amount": 300,
"currency": "EUR",
"reason": "FRAUDULENT",
"status": "CHARGEBACK_NOTICED",
"fee": 0,
"evidencesDeadline": "2035-02-07",
"movementId": "6cd3ae00-9f14-4703-9728-102e65a232c9",
"wonMovementId": null,
"additionalData": {}
},
{
"disputeId": "56848d84-f8ff-461d-9501-92df32da35c9",
"creationDate": "2019-10-30T14:20:18.352317+01:00",
"transactionId": "be8de5a0-2739-4e94-9c13-7c48bdf929c3",
"disputeDate": "2019-10-30",
"merchantDisputeId": null,
"description": null,
"amount": 299,
"currency": "EUR",
"reason": "FRAUDULENT",
"status": "CHARGEBACK_NOTICED",
"fee": 0,
"evidencesDeadline": "2019-10-30",
"movementId": "5654da4a-dbae-4cab-8b1e-442bc74b1dee",
"wonMovementId": null,
"additionalData": {}
}
],
"totalCount": 2
}The Dispute object
The Json "Dispute" Object
The «Dispute» object represents a potential chargeback on a transaction.
| disputeId String (36) |
CentralPay dispute ID Note: UUID Format |
| merchantDisputeId String |
Merchant ID |
| creationDate String |
Creation date Note: ISO 8601 |
| transactionId String (36) |
CentralPay transaction ID Note: UUID Format |
| disputeDate String |
Date of dispute Note: ISO 8601 |
| amount Integer |
Amount of the chargeback. It is usually the full amount of the disputed charge but it is not always the case (partially disputed or due to currency exchange) |
| description String |
Description |
| currency String |
Currency |
| reason |
Reason of the dispute
Note: FRAUDULENT |
| status |
Status of the dispute Note: RETRIEVAL_NOTICED
RETRIEVAL_CLOSE
CHARGEBACK_NOTICED
CHARGEBACK_WON
CHARGEBACK_LOST
|
| evidenceDeadline String |
Date by when the evidence must be submitted in order to successfully challenge the dispute Note: ISO 8601 |
| fee Integer |
Fee |
| additionalData Object |
Merchant data Note: Contains the keys/values |
|
movementId String(36) |
Movement ID Note: UUID Format |
|
wonMovementId String(36) |
Won Movement ID Note: UUID Format |
Payment Request
The payment request is a modular formula wich allows the user to choose the method of payment. It is used by the Smart Form.
Simple payment request
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='TRANSACTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F transfer[]='{"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171", "amount":100000, "email":"johnDoe@hotmail.com"}'
JSON response
{
"paymentRequestId": "cd80f9c9-d121-44a6-a6a9-3f775a5acff8",
"creationDate": "2020-08-13T15:34:02.004118+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": null,
"linkExpirationDate": null,
"endingDate": null,
"scenarioId": null,
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "ACTIVE",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"TRANSACTION"
],
"transaction": {
"paymentRequestTransactionId": "2f813571-dc15-4149-a39c-0a671d301bb2",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"receiptEmail": null,
"source": "EC"
},
"installment": null,
"subscription": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "4dc27147-4d46-4b68-ba2f-49f6f3a8871b",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 100000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/25cd87d7-2dd8-4f08-8b78-2f84f5496ffd",
"email": "johnDoe@hotmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": false,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": null,
"amount": 100000,
"fee": 0,
"merchantTransferId": null
}
],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": {}
}
Payment request in 3 times
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='INSTALLMENT' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=true \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F installment[depositAmount]=400 \
-F installment[intervalUnit]='MONTH' \
-F installment[intervalCount]=1 \
-F installment[iterationCount]=2
JSON response
{
"paymentRequestId": "5fe721c4-2273-472c-b937-2927f402280b",
"creationDate": "2020-08-13T16:59:24.006965+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": null,
"linkExpirationDate": null,
"endingDate": null,
"scenarioId": null,
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "ACTIVE",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"INSTALLMENT"
],
"transaction": null,
"installment": {
"paymentRequestInstallmentId": "a7d6b44a-eeb0-4f5d-b266-b2b724e76026",
"depositStartingDate": null,
"startingDate": null,
"depositAmount": 400,
"feeAmount": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 2
},
"subscription": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "3106aa7e-467f-4cff-bfbb-e2894d63377c",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 100000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/4f9b1799-6cfa-48de-bd1b-d62902b05e3b",
"email": "johnDoe@hotmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": false,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": {}
}
Payment request with 3 participants
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]=TRANSACTION \
-F currency=EUR \
-F totalAmount=100000 \
-F partial=true \
-F deadline='2050-02-25T12:00+01:00' \
-F linkExpirationDate='2050-03-25T12:00+01:00' \
-F breakdown[]='{"amount":40000, "email":"johnDoe@hotmail.com"}' \
-F breakdown[]='{"amount":30000, "email":"janeDoe@gmail.com"}' \
-F breakdown[]='{"amount":30000, "email":"Doe@yahoo.com"}'
JSON response
{
"paymentRequestId": "9033a61e-8964-4edc-924f-fef7555b4cd9",
"creationDate": "2020-08-14T10:19:09.461230+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": "2050-02-25T12:00+01:00",
"linkExpirationDate": "2050-03-25T12:00+01:00",
"endingDate": null,
"scenarioId": null,
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "ACTIVE",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"TRANSACTION"
],
"transaction": {
"paymentRequestTransactionId": "e1e6ea5c-b09e-428e-8d1b-848a6c62a51f",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"receiptEmail": null,
"source": "EC"
},
"installment": null,
"subscription": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "f2f38e06-ce65-411c-bdba-1407345e4f21",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 40000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/52e9a132-909d-4eef-ab14-d14ad2e013f3",
"email": "johnDoe@hotmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": false,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
},
{
"paymentRequestBreakdownId": "6687b656-156b-4f44-b19e-589be006aa18",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 30000,
"initiator": null,
"endpoint": "https://test-form.centralpay.net/8410eef8-47af-4ec9-a34a-884d68a01bcd",
"email": "janeDoe@gmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": false,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
},
{
"paymentRequestBreakdownId": "4afb5064-7c66-4fb6-9239-27f5b79c1bc0",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 30000,
"initiator": null,
"endpoint": "https://test-form.centralpay.net/c93de9ba-b169-440a-b6eb-c79c6ec6c131",
"email": "Doe@yahoo.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": false,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": {}
}
Adding a file
-F attachment[]=@/path/filename.pdf \
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='TRANSACTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F attachment[]=@/home/user/Pictures/2020-08-14_10-01.png \
-F transaction[receiptEmail]='johnDoe@hotmail.com'
Create a Payment Request
The following API request MUST be in multipart/form-data content type in the header.
| merchantPaymentRequestId String |
Merchant ID of the payment request Required: no Validation: .{0,100} |
| pointOfSaleId PointOfSale |
POS ID Required: no Validation: UUID, existing, authorized user Note: by default, the user default POS |
| description String |
Description Required: no Validation: .{0,256} |
| paymentMethod[] List<Enum PaymentMethod> |
The means of payment of the request Required: yes Validation: cannot combine SUBSCRIPTION with other means of payment Note: TRANSACTION | INSTALLMENT | SUBSCRIPTION |
| currency Currency |
Currency Required: yes Validation: ISO4217 in format alpha or num [A-Z}{3}|[0-9]{3}, existing, authorized for the POS |
| totalAmount Integer |
Total amount Required: yes Validation: > 0 and <= 999999999, must be equal to the sum of the breakdown if breakdown[]amount != null Note: in cents |
| partial Boolean |
Partial payment Required: yes Note: accepts partial payments in the case of a single amount |
| breakdown[] List<PaymentRequestBreakdownRequest> |
Distribution of the amounts Required: yes Validation: at least 1, equal to 1 if paymentMethod = SUBSCRIPTION Note: content in JSON format |
| breakdown[customerId] UUID |
Customer IDs Required: no Validation: mandatory if its breakdown[email] = null, inside the breakdown |
| breakdown[email] String |
Customer email Required: no Validation: mandatory if its breakdown[customerId] = null, inside the breakdown |
| breakdown[firstname] String(35) |
Customer firstname Required: no Validation: .{0,35} |
| breakdown[lastname] String(35) |
Customer lastname Required: no Validation: .{0,35} |
| language Language |
Language used in the application Required: no Validation: ISO 639-2 (3 carac) or ISO 639-1 (2carac), existing Note: by default the customer language (if available) or english |
| breakdown[amount] Integer |
Amount Required: no Validation: the sum of the amounts must be equal to totalAmount Note: if not specified, the totalAmount is applied to all distributed amounts |
| breakdown[initiator] Boolean |
Initiator Required: yes if nb breakdown[] > 1, no if nb breakdown[] = 1 Validation: only one breakdown[].initiator to true, the others to false Note: if only one breakdown[].initiator, then true by default |
| deadline OffsetDateTime |
Payment deadline Required: no Validation: today or after Note: permanent validity if not specified |
| linkExpirationDate OffsetDateTime |
Expiry date of the payment link Required: no Validation: today or after. If deadline != null: same day or after Note: permanent validity if not specified |
| createCustomer Boolean |
Create a customer Required: no Validation: must be false if the merchant does not have the OC option Note: false by default |
| transfer[] List<PaymentRequestTransferRequest> |
Required: no Validation: sum(transfer.amount - transfer.fee) <= totalAmount Note: content in JSON format |
| destinationWalletId Wallet |
The destination wallet ID Required: yes Validation: wallet of one of its sub-merchant |
| amount Integer |
Gross amount Required: yes Validation: > 0 et <= 999999999 |
| fee Integer |
Fee Required: no Validation: >= 0 and <= amount Note: 0 by default |
| merchantTransferId String(100) |
Identification number of the merchant Required: no Validation: .{0,100} |
| escrowDate LocalDate |
Escrow date Required: no Validation: now+5d or after |
| transferGroup String |
Transfer group ID Required: no Validation: .{0,100} Note: batch reference that allows the merchant to sort his transfers into group |
| scenarioId UUID |
Scenario ID Required: no Validation: UUID, existing, related to the merchant Note: optional, allows to link the request to an existing scenario |
| paymentFormTemplateId UUID |
Template ID Required: no Validation: UUID, existing, related to the merchant Note: optional, allows to link the request to an existing sending template |
| attachment[] List<FormDataBodyPart> |
Attachments Required: no Validation: 3 attachments maximum, 1 Mb each |
| additionalData[*] String |
Merchant data Required: no Validation: key: .{45}, value: .{256}, max 25 |
| transaction[source] String |
Payment source
EC: Electronic Commerce |
| transaction[contractId] Contract |
Contract ID Required: no Validation: UUID, existing, related to the POS |
| transaction[receiptEmail] String |
Email for sending the receipt Required: no POST treatment: trim Validation: email Note: holder's email |
| installment[depositAmount] Integer |
Amount of the deposit (included in amount) Required: no Validation: >= 0 et < amount |
| installment[feeAmount] Integer |
Fee of the X times (not included in amount) Required: no Validation: >= 0 et <= 9999999 |
| installment[intervalUnit] Enum IntervalUnit |
Interval unit Required: yes if paymentMethod = INSTALLMENT Validation: not YEAR Note: DAY, WEEK, MONTH, YEAR |
| installment[intervalCount] Integer |
Number of intervals Required: yes if paymentMethod = INSTALLMENT Validation: >= 1 |
| installment[iterationCount] Integer |
Number of iterations Required: yes if paymentMethod = INSTALLMENT Validation: > 1 and if DAY: <= 90 if WEEK: <= 12 if MONTH: <= 12 |
| installment[depositStartingDate] LocalDate |
Start date of the deposit Required: no Validation: depositAmount != 0, from today to + 30 days maximum included |
| installment[startingDate] LocalDate |
Start date of the X times Required: no Validation: If depositStartingDate = null then >= today If depositStartingDate != null then > depositStartingDate |
| redirectUrl String(255) |
Merchant website url of return Required: no |
| subscription[subscriptionModelId] SubscriptionModel |
Subscription model identifier Required: yes if paymentMethod = SUBSCRIPTION Validation: UUID, existing, owned by the merchant |
| subscription[startingDate] LocalDate |
Subscription starting date Required: no Validation: if startingDate != null: then Today or after |
| subscription[quantity] Integer |
Quantity Required: no Validation: if quantity != null, then >= 1 |
| wireTransfer[destinationBankAccountId] UUID |
Receipt account of the transfer
Required: no Notes : if payementMethod = WIRE_TRANSFER, by default the receipt account of the POS, with the linked currency |
Simple payment request
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='TRANSACTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F transfer[]='{"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171", "amount":100000, "email":"johnDoe@hotmail.com"}'
JSON response
{
"paymentRequestId": "cd80f9c9-d121-44a6-a6a9-3f775a5acff8",
"creationDate": "2020-08-13T15:34:02.004118+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": null,
"linkExpirationDate": null,
"endingDate": null,
"scenarioId": null,
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "ACTIVE",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"TRANSACTION"
],
"transaction": {
"paymentRequestTransactionId": "2f813571-dc15-4149-a39c-0a671d301bb2",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"receiptEmail": null,
"source": "EC"
},
"installment": null,
"subscription": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "4dc27147-4d46-4b68-ba2f-49f6f3a8871b",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 100000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/25cd87d7-2dd8-4f08-8b78-2f84f5496ffd",
"email": "johnDoe@hotmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": false,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [
{
"destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
"escrowDate": null,
"amount": 100000,
"fee": 0,
"merchantTransferId": null
}
],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": {}
}
Payment request in 3 times
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='INSTALLMENT' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=true \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F installment[depositAmount]=400 \
-F installment[intervalUnit]='MONTH' \
-F installment[intervalCount]=1 \
-F installment[iterationCount]=2
JSON response
{
"paymentRequestId": "5fe721c4-2273-472c-b937-2927f402280b",
"creationDate": "2020-08-13T16:59:24.006965+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": null,
"linkExpirationDate": null,
"endingDate": null,
"scenarioId": null,
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "ACTIVE",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"INSTALLMENT"
],
"transaction": null,
"installment": {
"paymentRequestInstallmentId": "a7d6b44a-eeb0-4f5d-b266-b2b724e76026",
"depositStartingDate": null,
"startingDate": null,
"depositAmount": 400,
"feeAmount": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 2
},
"subscription": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "3106aa7e-467f-4cff-bfbb-e2894d63377c",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 100000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/4f9b1799-6cfa-48de-bd1b-d62902b05e3b",
"email": "johnDoe@hotmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": false,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": {}
}
Payment request with 3 participants
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]=TRANSACTION \
-F currency=EUR \
-F totalAmount=100000 \
-F partial=true \
-F deadline='2050-02-25T12:00+01:00' \
-F linkExpirationDate='2050-03-25T12:00+01:00' \
-F breakdown[]='{"amount":40000, "email":"johnDoe@hotmail.com"}' \
-F breakdown[]='{"amount":30000, "email":"janeDoe@gmail.com"}' \
-F breakdown[]='{"amount":30000, "email":"Doe@yahoo.com"}'
JSON response
{
"paymentRequestId": "9033a61e-8964-4edc-924f-fef7555b4cd9",
"creationDate": "2020-08-14T10:19:09.461230+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": "2050-02-25T12:00+01:00",
"linkExpirationDate": "2050-03-25T12:00+01:00",
"endingDate": null,
"scenarioId": null,
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "ACTIVE",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"TRANSACTION"
],
"transaction": {
"paymentRequestTransactionId": "e1e6ea5c-b09e-428e-8d1b-848a6c62a51f",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"receiptEmail": null,
"source": "EC"
},
"installment": null,
"subscription": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "f2f38e06-ce65-411c-bdba-1407345e4f21",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 40000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/52e9a132-909d-4eef-ab14-d14ad2e013f3",
"email": "johnDoe@hotmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": false,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
},
{
"paymentRequestBreakdownId": "6687b656-156b-4f44-b19e-589be006aa18",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 30000,
"initiator": null,
"endpoint": "https://test-form.centralpay.net/8410eef8-47af-4ec9-a34a-884d68a01bcd",
"email": "janeDoe@gmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": false,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
},
{
"paymentRequestBreakdownId": "4afb5064-7c66-4fb6-9239-27f5b79c1bc0",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 30000,
"initiator": null,
"endpoint": "https://test-form.centralpay.net/c93de9ba-b169-440a-b6eb-c79c6ec6c131",
"email": "Doe@yahoo.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": false,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": {}
}
Adding a file
-F attachment[]=@/path/filename.pdf \
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='TRANSACTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F attachment[]=@/home/user/Pictures/2020-08-14_10-01.png \
-F transaction[receiptEmail]='johnDoe@hotmail.com'
HTTP Request
POST /paymentRequest/<paymentrequestid>/cancel return [OBJ] PaymentRequest</paymentrequestid>
curl -v -X POST https://test-api.centralpay.net/v2/rest/paymentRequest/5fe721c4-2273-472c-b937-2927f402280b/cancel \
-u 'doctest:4I9HJRTd' \
-d closeReason='OTHER'
curl -v -X POST https://test-api.centralpay.net/v2/rest/paymentRequest/5fe721c4-2273-472c-b937-2927f402280b/cancel \
-H 'Content-Type:application/x-www-form-urlencoded' \
-u 'doctest:4I9HJRTd'
Cancel a payment request
The following request will cancel the payment Request and all the possible ramifications of the payment request concerned.
|
paymentRequestId (URL) |
Payment request ID Required: yes Validation: UUID, existing, belongs to the merchant, status = ACTIVE |
|
closeReason |
The reason of the cancealment Required: no Validation: EXPIRED | OTHER |
|
closeComment |
The commentary about the cancealment Required: no |
HTTP Request
POST /paymentRequest/<paymentrequestid>/cancel return [OBJ] PaymentRequest</paymentrequestid>
curl -v -X POST https://test-api.centralpay.net/v2/rest/paymentRequest/5fe721c4-2273-472c-b937-2927f402280b/cancel \
-u 'doctest:4I9HJRTd' \
-d closeReason='OTHER'
curl -v -X POST https://test-api.centralpay.net/v2/rest/paymentRequest/5fe721c4-2273-472c-b937-2927f402280b/cancel \
-H 'Content-Type:application/x-www-form-urlencoded' \
-u 'doctest:4I9HJRTd'
HTML Request
POST /paymentRequest/<paymentrequestid>/close return [OBJ] PaymentRequest</paymentrequestid>
curl -v -X POST https://test-api.centralpay.net/v2/rest/paymentRequest/5fe721c4-2273-472c-b937-2927f402280b/close \
-H 'Content-Type:application/x-www-form-urlencoded' \
-u 'doctest:4I9HJRTd'
curl -v -X POST https://test-api.centralpay.net/v2/rest/paymentRequest/5fe721c4-2273-472c-b937-2927f402280b/close \
-u 'doctest:4I9HJRTd' \
-d closeReason='OTHER'
Close a Payement Request
The following request will close the Payment Request, without cancealing it.
|
paymentRequestId (URL) |
Payment request ID
Required: yes - existing, - belongs to the merchant, - status = ACTIVE, - paymentRequestStatus = PARTIALLY_PAID |
|
closeReason |
The reason of the closing Required: no Validation: EXPIRED | OTHER |
|
closeComment |
The commentary about the closing Required: no |
HTML Request
POST /paymentRequest/<paymentrequestid>/close return [OBJ] PaymentRequest</paymentrequestid>
curl -v -X POST https://test-api.centralpay.net/v2/rest/paymentRequest/5fe721c4-2273-472c-b937-2927f402280b/close \
-H 'Content-Type:application/x-www-form-urlencoded' \
-u 'doctest:4I9HJRTd'
curl -v -X POST https://test-api.centralpay.net/v2/rest/paymentRequest/5fe721c4-2273-472c-b937-2927f402280b/close \
-u 'doctest:4I9HJRTd' \
-d closeReason='OTHER'
HTTP Request
GET /paymentRequest/<paymentrequestid> return [OBJ] PaymentRequest</paymentrequestid>
curl -v -X GET https://test-api.centralpay.net/v2/rest/paymentRequest/5fe721c4-2273-472c-b937-2927f402280b \
-u 'doctest:4I9HJRTd'
JSON Response
{
"paymentRequestId": "5fe721c4-2273-472c-b937-2927f402280b",
"creationDate": "2020-08-13T16:59:24.006965+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": null,
"linkExpirationDate": null,
"endingDate": "2020-08-14T11:46:35.748660+02:00",
"scenarioId": null,
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "CANCELED",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"INSTALLMENT"
],
"transaction": null,
"installment": {
"paymentRequestInstallmentId": "a7d6b44a-eeb0-4f5d-b266-b2b724e76026",
"depositStartingDate": null,
"startingDate": null,
"depositAmount": 400,
"feeAmount": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 2
},
"subscription": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "3106aa7e-467f-4cff-bfbb-e2894d63377c",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 100000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/4f9b1799-6cfa-48de-bd1b-d62902b05e3b",
"email": "johnDoe@hotmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": true,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": {}
}
Retrieve a Payment Request
|
paymentRequestId (URL) |
Payment request ID Required: yes Validation: UUID, existing, belongs to the merchant |
HTTP Request
GET /paymentRequest/<paymentrequestid> return [OBJ] PaymentRequest</paymentrequestid>
curl -v -X GET https://test-api.centralpay.net/v2/rest/paymentRequest/5fe721c4-2273-472c-b937-2927f402280b \
-u 'doctest:4I9HJRTd'
JSON Response
{
"paymentRequestId": "5fe721c4-2273-472c-b937-2927f402280b",
"creationDate": "2020-08-13T16:59:24.006965+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": null,
"linkExpirationDate": null,
"endingDate": "2020-08-14T11:46:35.748660+02:00",
"scenarioId": null,
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "CANCELED",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"INSTALLMENT"
],
"transaction": null,
"installment": {
"paymentRequestInstallmentId": "a7d6b44a-eeb0-4f5d-b266-b2b724e76026",
"depositStartingDate": null,
"startingDate": null,
"depositAmount": 400,
"feeAmount": null,
"intervalUnit": "MONTH",
"intervalCount": 1,
"iterationCount": 2
},
"subscription": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "3106aa7e-467f-4cff-bfbb-e2894d63377c",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 100000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/4f9b1799-6cfa-48de-bd1b-d62902b05e3b",
"email": "johnDoe@hotmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": true,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": {}
}
curl -v -X GET https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd'
JSON Response
{
"list": [
{
"paymentRequestId": "3f217190-8611-41c6-a6eb-0bb50bf6995b",
"creationDate": "2020-08-14T11:11:31.138107+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": null,
"linkExpirationDate": null,
"endingDate": null,
"scenarioId": null,
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "ACTIVE",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"WIRE_TRANSFER"
],
"transaction": null,
"installment": null,
"subscription": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "6277df10-f999-4997-88a2-93351209fb41",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 100000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/60978bb1-19c8-4426-b8a9-383f6f3622b5",
"email": "johnDoe@hotmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": true,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [],
"wireTransfer": {
"paymentRequestWireTransferId": "bb7c87f0-d28f-4a8f-b173-747415fbfdb1",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6"
},
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": {}
},
{
"paymentRequestId": "9033a61e-8964-4edc-924f-fef7555b4cd9",
"creationDate": "2020-08-14T10:19:09.461230+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": "2050-02-25T12:00+01:00",
"linkExpirationDate": "2050-03-25T12:00+01:00",
"endingDate": null,
"scenarioId": null,
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "ACTIVE",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"TRANSACTION"
],
"transaction": {
"paymentRequestTransactionId": "e1e6ea5c-b09e-428e-8d1b-848a6c62a51f",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"receiptEmail": null,
"source": "EC"
},
"installment": null,
"subscription": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "4afb5064-7c66-4fb6-9239-27f5b79c1bc0",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 30000,
"initiator": null,
"endpoint": "https://test-form.centralpay.net/c93de9ba-b169-440a-b6eb-c79c6ec6c131",
"email": "Doe@yahoo.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": true,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
},
{
"paymentRequestBreakdownId": "6687b656-156b-4f44-b19e-589be006aa18",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 30000,
"initiator": null,
"endpoint": "https://test-form.centralpay.net/8410eef8-47af-4ec9-a34a-884d68a01bcd",
"email": "janeDoe@gmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": true,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
},
{
"paymentRequestBreakdownId": "f2f38e06-ce65-411c-bdba-1407345e4f21",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 40000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/52e9a132-909d-4eef-ab14-d14ad2e013f3",
"email": "johnDoe@hotmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": true,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": {}
}
],
"totalCount": 638
}
List payment requests
This function allows you to search objects from a multi-criteria search. All the paramers used to search must be passed in the form of queries parameters.
|
merchantPaymentRequestId |
Merchant ID of the payment request Required: no Validation: .{0,100} |
|
status |
Status of the payment request Required: no |
curl -v -X GET https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd'
JSON Response
{
"list": [
{
"paymentRequestId": "3f217190-8611-41c6-a6eb-0bb50bf6995b",
"creationDate": "2020-08-14T11:11:31.138107+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": null,
"linkExpirationDate": null,
"endingDate": null,
"scenarioId": null,
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "ACTIVE",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"WIRE_TRANSFER"
],
"transaction": null,
"installment": null,
"subscription": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "6277df10-f999-4997-88a2-93351209fb41",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 100000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/60978bb1-19c8-4426-b8a9-383f6f3622b5",
"email": "johnDoe@hotmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": true,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [],
"wireTransfer": {
"paymentRequestWireTransferId": "bb7c87f0-d28f-4a8f-b173-747415fbfdb1",
"destinationBankAccountId": "02f68144-b961-4639-a20c-af0d444033f6"
},
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": {}
},
{
"paymentRequestId": "9033a61e-8964-4edc-924f-fef7555b4cd9",
"creationDate": "2020-08-14T10:19:09.461230+02:00",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"deadline": "2050-02-25T12:00+01:00",
"linkExpirationDate": "2050-03-25T12:00+01:00",
"endingDate": null,
"scenarioId": null,
"paymentFormTemplateId": null,
"merchantPaymentRequestId": null,
"description": null,
"currency": "EUR",
"totalAmount": 100000,
"paymentRequestStatus": "ACTIVE",
"paymentStatus": "UNPAID",
"createCustomer": false,
"paymentMethods": [
"TRANSACTION"
],
"transaction": {
"paymentRequestTransactionId": "e1e6ea5c-b09e-428e-8d1b-848a6c62a51f",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"receiptEmail": null,
"source": "EC"
},
"installment": null,
"subscription": null,
"breakdowns": [
{
"paymentRequestBreakdownId": "4afb5064-7c66-4fb6-9239-27f5b79c1bc0",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 30000,
"initiator": null,
"endpoint": "https://test-form.centralpay.net/c93de9ba-b169-440a-b6eb-c79c6ec6c131",
"email": "Doe@yahoo.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": true,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
},
{
"paymentRequestBreakdownId": "6687b656-156b-4f44-b19e-589be006aa18",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 30000,
"initiator": null,
"endpoint": "https://test-form.centralpay.net/8410eef8-47af-4ec9-a34a-884d68a01bcd",
"email": "janeDoe@gmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": true,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
},
{
"paymentRequestBreakdownId": "f2f38e06-ce65-411c-bdba-1407345e4f21",
"customerId": null,
"lastEnteringDate": null,
"lastPaymentAttempt": null,
"amount": 40000,
"initiator": true,
"endpoint": "https://test-form.centralpay.net/52e9a132-909d-4eef-ab14-d14ad2e013f3",
"email": "johnDoe@hotmail.com",
"phone": null,
"firstName": null,
"lastName": null,
"entered": true,
"paymentAttempted": false,
"paid": null,
"view": 0,
"status": "UNPAID",
"payments": []
}
],
"transfers": [],
"wireTransfer": null,
"transferGroup": null,
"attachments": [],
"language": "eng",
"redirectUrl": null,
"closeComment": null,
"additionalData": {}
}
],
"totalCount": 638
}
HTTP Request
POST /paymentRequestBreakdown/<paymentRequestBreakdownId>/qrcode return [Image] QRCode image
curl -v -X POST https://test-api.centralpay.net/v2/rest/paymentRequestBreakdown/8ffc0691-a83f-47f6-be45-26fbf14f8bc1/qrcode \
-H 'Content-Type:application/x-www-form-urlencoded' \
-u 'doctest:4I9HJRTd' \
-d format='PNG'
Generate a QRCode image with a breakdown
This function allows you to create a QRCode with a successful request with a valid breakdown
|
paymentRequestBreakdownId (URL) UUID |
The identification number of the breakdown inside the concerned payment request Required: yesValidation : Existing, belongs to the merchant.Notes : in response to a successful creation |
| width Integer |
width of the image in pixels Required: no Validation : Between 50 and 1500 pixels ( .{50,1500} ) Notes : Default value 500 |
| height Integer |
height of the image in pixels Required: no Validation : Between 50 and 1500 pixels ( .{50,1500} ) Notes : Default value 500 |
| errorCorrectionLevel String |
Increase the density of the QRCode, and making it easier to read
Required: no
Validation : L | M | Q | H Notes : Default value L (Low)
|
| format String |
The format of the picture Required: no Validation : PNG | JPG Notes : Default value is PNG |
| qrCodeColor String |
Color of the QRCode, in hexadecimal format
Required: no
Validation : ^[0-9a-fA-F]{6}$ Notes: Default value Black (000000)
|
| qrCodeBackgroundColor String |
Color of the background, in hexadecimal format
Required: no Validation : ^[0-9a-fA-F]{6}$ Notes: Default value White (FFFFFF)
|
HTTP Request
POST /paymentRequestBreakdown/<paymentRequestBreakdownId>/qrcode return [Image] QRCode image
curl -v -X POST https://test-api.centralpay.net/v2/rest/paymentRequestBreakdown/8ffc0691-a83f-47f6-be45-26fbf14f8bc1/qrcode \
-H 'Content-Type:application/x-www-form-urlencoded' \
-u 'doctest:4I9HJRTd' \
-d format='PNG'
PaymentRequest Object
|
paymentRequestId |
Payment request ID |
|
merchantPaymentRequestId |
Merchant ID of the payment request |
|
creationDate |
Creation date |
|
pointOfSaleId |
POS ID |
|
description |
Description |
|
currency |
Currency Note: favorite format |
|
totalAmount |
Amount |
|
partial |
Partial payment |
|
paymentRequestStatus |
Status of the request for payment request Note: ACTIVE: The request is still active. The payment status can be UNPAID or PARTIALLY_PAID |
|
paymentStatus |
Status of the payment request Note: PAID: The payment has been completed |
|
deadLine |
Payment deadline |
|
linkExpirationDate |
Expiry date of the payment link |
|
createCustomer |
Create a customer |
|
breakdowns |
List of breakdowns |
|
transfers |
Transfers |
|
transferGroup |
Transfer group ID |
|
transaction |
Data on transaction Note: See Json "Payement Request Transaction" response object |
|
installment |
Data on X times Note: See Json "Payement Request Installment" response object |
|
scenarioId |
Scenario ID |
|
paymentFormTemplateId |
Form template ID |
|
attachment |
List of the names of the attachments |
|
endingDate |
Ending date (CANCELED or CLOSED) |
|
paymentMethods |
List<PaymentMethod> |
|
additionalData[*] |
Merchant data |
|
language |
Language used in the payement request Note: ISO 639-2 (3characters) |
|
subscription |
Subscription data Note: See Json "Payement Request Subscription" response object |
|
redirectUrl |
The URL used to redirect to the merchant site
|
|
wireTransfer |
Wire transfer data Note: See Json "Payement Request WireTransfer" response object |
Breakdown
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='TRANSACTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}'
Payment request breakdown response object
|
payementRequestBreakdownId |
UUID of the PaymentRequestBreakdown |
|
endpoint |
Endpoint of the formular of the breakdown |
|
customerId |
Customer ID |
| email String |
|
|
firstName |
firstname of the cutomer |
|
lastName |
lastname of the customer |
| amount Integer |
Amount |
| initiator Boolean |
Initiator |
|
entered |
Entered the form |
|
lastEnteringDate |
Date of the last form entry |
|
paymentAttempted |
Payment tried |
|
lastPaymentAttempt |
Date of the last payment attempt |
|
paid |
Paid |
| view Integer |
Number of views |
| payments
List<PaymentRequestBreakdownPaymentResponse> |
List of payments made |
| language String |
Language used in the request Note: ISO 639-2 format (3 characters) |
| uuid UUID |
UUID of the means of payment |
| paymentMethod PaymentMethod |
Method of the means of payment Note: TRANSACTION | INSTALLMENT | SUBSCRIPTION |
| creationDate String |
Date of creation Note: ISO 8601 |
Breakdown
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='TRANSACTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}'
Transfer
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='TRANSACTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F transfer[]='{"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171", "amount":100000, "email":"johnDoe@hotmail.com"}'
Payment request transfer response object
|
destinationWalletId |
Destination wallet ID Note : The destination Wallet must belongs to one of the sub-merchant of the user |
|
amount |
Gross amount |
|
fee |
Fee |
|
escrowDate |
Escow date |
|
merchantTransferId |
Merchant identifier |
Transfer
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='TRANSACTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F transfer[]='{"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171", "amount":100000, "email":"johnDoe@hotmail.com"}'
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='TRANSACTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F transaction[receiptEmail]='johnDoe@hotmail.com'
Payment request transaction response object
|
paymentRequestTransactionId |
Identification Number of the payement request transaction Note : UUID |
|
receiptEmail |
Email for sending the receipt |
| contractId UUID |
Contract ID
|
| source Enum Source |
Payment source Note : EC | DP |
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='TRANSACTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F transaction[receiptEmail]='johnDoe@hotmail.com'
Installment
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='INSTALLMENT' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=true \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F installment[depositAmount]=400 \
-F installment[intervalUnit]='MONTH' \
-F installment[intervalCount]=1 \
-F installment[iterationCount]=2
Payment request installment response object
|
depositAmount |
Amount of the deposit (included in amount) |
|
feeAmount |
Fee of the X times (NOT included in amount) |
|
intervalUnit |
Interval unitNote : DAY | WEEK | MONTH | YEAR |
|
intervalCount |
Number of intervals |
|
iterationCount |
Number of iterations |
|
depositStartingDate |
Start date of the deposit |
|
startingDate |
Start date of the X times |
Installment
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='INSTALLMENT' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=true \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F installment[depositAmount]=400 \
-F installment[intervalUnit]='MONTH' \
-F installment[intervalCount]=1 \
-F installment[iterationCount]=2
OBJ PaymentRequestSubscriptionResponse
Subscription
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='SUBSCRIPTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F subscription[subscriptionModelId]='7e849561-3ccc-444d-af04-dd3a5ee965eb'
Payment request subscription response object
|
paymentRequestSubscriptionId UUID |
Identification number of the paymentRequest Subscription Notes : in response to a successful creation |
| subscriptionModelId UUID |
Subscription model ID Required: yes, if the paymentMethod = SUBSCRIPTION Validation : Existing, belongs to the merchant. Notes : You can set a subscription in your Back Office Account |
| startingDate LocalDate |
Subscription starting date Required: no |
| quantity Integer |
Quantity Required: no |
OBJ PaymentRequestSubscriptionResponse
Subscription
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='SUBSCRIPTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F subscription[subscriptionModelId]='7e849561-3ccc-444d-af04-dd3a5ee965eb'
OBJ PaymentRequestWireTransferResponse
wireTransfer
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='WIRE_TRANSFER' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F wireTransfer[destinationBankAccountId]='02f68144-b961-4639-a20c-af0d444033f6'
Payement Request wireTransfer response object
|
paymentRequestWireTransferId |
identification number of the wire transfer payment requestNote : Response to a successful request |
|
destinationBankAccountId |
identification number of the receipt accountNote : By default the receipt account is the account of the POS |
OBJ PaymentRequestWireTransferResponse
wireTransfer
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-u 'doctest:4I9HJRTd' \
-F paymentMethod[]='WIRE_TRANSFER' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}' \
-F wireTransfer[destinationBankAccountId]='02f68144-b961-4639-a20c-af0d444033f6'
3DS enrollment
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/checkEnrollment \
-u 'doctest:4I9HJRTd' \
-d merchantTransactionIdentifier='REF001' \
-d currency='EUR' \
-d amount='1000' \
-d card[number]='4000000000000002' \
-d card[expirationMonth]='06' \
-d card[expirationYear]='2035'
Back to Json format
{
"enrollmentId": "4d7d508e-c94d-41f1-8c70-317beace01ab",
"creationDate": "2020-08-17T09:16:18.728779+02:00",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"additionalData": {},
"acsURL": "https://my-bank/acs",
"amount": 1000,
"cardFingerprint": null,
"currency": "EUR",
"first6": "400000",
"last4": "0002",
"merchantCountry": "FRA",
"merchantName": "POS Démo Centralpay",
"merchantTransactionIdentifier": "REF001",
"merchantURL": "https://centralpay.net",
"paReq": "eJxdUttSwjAQ/ZVO30uSlqYtsw2DMCoPKCPoe0x3oCNNoRenfJLf4Y+ZYLnoQyZ7dpOzJ2cD467YOZ9Y1XmpU5cNqOugVmWW603qvq7vvdh16kbqTO5Kjal7xNodC1hvK8TZClVboYAF1rXcoJNnqRvRmMfRe+hxytEbJlHgySRUXhxjIulQyoAmroDl5AUPAvrOwjQe+EDO0DBWait1I0Cqw938SRgiyhiQHkKB1XwmKPODYciB/ELQskCxfF45s++vonSmqJtK7vbyCORUAlW2JnUUfkiBnAG01U5sm2ZfjwhRlzsDjQ0QWwNy1bNsbVQbri7PxOvH28NiNunm08nm30qB2BOQyQaFT31KYxY5NBoxPmIxkFMeZGFFCEapEdQD2Nsek9vKbQaM6ZUZ0lEkkeG5IMBub2ZkThgnLzFkWCvzgn67yp8+WnNVY3w7q6MJ4yzm3Lc+nyqWMzcWBSHlJ1ILgNi7pB8h6advoj+/4gcsscN2",
"status": "SUCCESS"
}
Make a check enrollment
This function allows you to check the 3DS enrolment of a card.
| merchantTransactionIdentifier String (20) |
Merchant ID (XID) Required: yes Validation: .{1,20} |
| pointOfSaleId Uuid |
POS ID Required: no Validation: UUID, existing, authorized user Note: by default, the user default POS |
| contractId Uuid |
contact identification number Required: no Validation: UUID, existing, authorized user Note: by default, the user default POS |
| currency Currency |
Currency Required: yes Validation: ISO4217 in format alpha or num - [A-Z}{3}|[0-9]{3} - Existing Note: No validation regarding the contract |
| amount Integer |
Amount Required: yes Validation: > 0 and <= 9999999 - min and max limit per contract? Note: In cents |
| customerId UUID (36) |
CentralPay client ID Required: yes - cardTokenId OR card[*] OR customerId Validation: UUID - Existing - Authorised (for the user) |
| cardId UUID (36) |
CentralPay card ID
Required: conditional |
| cardTokenId UUID (36) |
Token ID Required: yes - cardTokenId OR card[*] OR customerId Validation: UUID - Existing - Authorised (for the user) - Status UNUSED Note: Do not put the token in "used" status in order to use it during the payment |
| card[*] * |
Card data Required: yes - cardTokenId OR card[*] OR customerId |
| additionalData String (303) |
Merchant data
Required: no Sample: additionalData=[Key]Value |
To access the ACS you must use the following parameters:
| PaReq |
Payer authentication request. The value received in the response to the CheckEnrollment response |
| TermUrl |
The URL to which the user will be directed at the conclusion of 3D secure authentication |
| MD |
Optional free text parameter that can be supplied and will be echoed back when the user is directed back to the TermUrl |
To access the ACS you must use the html code as follows:
<form id='downloadForm' name='downloadForm' method='POST' action='<ASC_bank_url>'>
<input type='hidden' id='PaReq' name='PaReq' value='<value_of_paReq>'>
<input type='hidden' id='TermUrl' name='TermUrl' value='<return_merchant_url>'>
<input type='hidden' id='MD' name='MD' value='<merchant_description>'>
</form>
<input type='hidden' id='PaReq' name='PaReq' value='<value_of_paReq>'>
<input type='hidden' id='TermUrl' name='TermUrl' value='<return_merchant_url>'>
<input type='hidden' id='MD' name='MD' value='<merchant_description>'>
</form>
The formula below can also be sent in the following way:
document.getElementById('downloadForm').submit();
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/checkEnrollment \
-u 'doctest:4I9HJRTd' \
-d merchantTransactionIdentifier='REF001' \
-d currency='EUR' \
-d amount='1000' \
-d card[number]='4000000000000002' \
-d card[expirationMonth]='06' \
-d card[expirationYear]='2035'
Back to Json format
{
"enrollmentId": "4d7d508e-c94d-41f1-8c70-317beace01ab",
"creationDate": "2020-08-17T09:16:18.728779+02:00",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"additionalData": {},
"acsURL": "https://my-bank/acs",
"amount": 1000,
"cardFingerprint": null,
"currency": "EUR",
"first6": "400000",
"last4": "0002",
"merchantCountry": "FRA",
"merchantName": "POS Démo Centralpay",
"merchantTransactionIdentifier": "REF001",
"merchantURL": "https://centralpay.net",
"paReq": "eJxdUttSwjAQ/ZVO30uSlqYtsw2DMCoPKCPoe0x3oCNNoRenfJLf4Y+ZYLnoQyZ7dpOzJ2cD467YOZ9Y1XmpU5cNqOugVmWW603qvq7vvdh16kbqTO5Kjal7xNodC1hvK8TZClVboYAF1rXcoJNnqRvRmMfRe+hxytEbJlHgySRUXhxjIulQyoAmroDl5AUPAvrOwjQe+EDO0DBWait1I0Cqw938SRgiyhiQHkKB1XwmKPODYciB/ELQskCxfF45s++vonSmqJtK7vbyCORUAlW2JnUUfkiBnAG01U5sm2ZfjwhRlzsDjQ0QWwNy1bNsbVQbri7PxOvH28NiNunm08nm30qB2BOQyQaFT31KYxY5NBoxPmIxkFMeZGFFCEapEdQD2Nsek9vKbQaM6ZUZ0lEkkeG5IMBub2ZkThgnLzFkWCvzgn67yp8+WnNVY3w7q6MJ4yzm3Lc+nyqWMzcWBSHlJ1ILgNi7pB8h6advoj+/4gcsscN2",
"status": "SUCCESS"
}
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/enrollment/4d7d508e-c94d-41f1-8c70-317beace01ab \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"enrollmentId": "4d7d508e-c94d-41f1-8c70-317beace01ab",
"creationDate": "2020-08-17T09:16:18.728779+02:00",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"additionalData": {},
"acsURL": "https://test-threedsecure.centralpay.net/acs",
"amount": 1000,
"cardFingerprint": null,
"currency": "EUR",
"first6": "400000",
"last4": "0002",
"merchantCountry": "FRA",
"merchantName": "POS Démo Centralpay",
"merchantTransactionIdentifier": "REF001",
"merchantURL": "https://centralpay.net",
"paReq": "eJxdUttSwjAQ/ZVO30uSlqYtsw2DMCoPKCPoe0x3oCNNoRenfJLf4Y+ZYLnoQyZ7dpOzJ2cD467YOZ9Y1XmpU5cNqOugVmWW603qvq7vvdh16kbqTO5Kjal7xNodC1hvK8TZClVboYAF1rXcoJNnqRvRmMfRe+hxytEbJlHgySRUXhxjIulQyoAmroDl5AUPAvrOwjQe+EDO0DBWait1I0Cqw938SRgiyhiQHkKB1XwmKPODYciB/ELQskCxfF45s++vonSmqJtK7vbyCORUAlW2JnUUfkiBnAG01U5sm2ZfjwhRlzsDjQ0QWwNy1bNsbVQbri7PxOvH28NiNunm08nm30qB2BOQyQaFT31KYxY5NBoxPmIxkFMeZGFFCEapEdQD2Nsek9vKbQaM6ZUZ0lEkkeG5IMBub2ZkThgnLzFkWCvzgn67yp8+WnNVY3w7q6MJ4yzm3Lc+nyqWMzcWBSHlJ1ILgNi7pB8h6advoj+/4gcsscN2",
"status": "SUCCESS"
}
Retrieve an enrollment
This function allows you to retrieve an enrolment with the enrollmentId.
| enrollmentId UUID (36) |
CentralPay enrollment ID Required: yes Validation: UUID |
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/enrollment/4d7d508e-c94d-41f1-8c70-317beace01ab \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"enrollmentId": "4d7d508e-c94d-41f1-8c70-317beace01ab",
"creationDate": "2020-08-17T09:16:18.728779+02:00",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"additionalData": {},
"acsURL": "https://test-threedsecure.centralpay.net/acs",
"amount": 1000,
"cardFingerprint": null,
"currency": "EUR",
"first6": "400000",
"last4": "0002",
"merchantCountry": "FRA",
"merchantName": "POS Démo Centralpay",
"merchantTransactionIdentifier": "REF001",
"merchantURL": "https://centralpay.net",
"paReq": "eJxdUttSwjAQ/ZVO30uSlqYtsw2DMCoPKCPoe0x3oCNNoRenfJLf4Y+ZYLnoQyZ7dpOzJ2cD467YOZ9Y1XmpU5cNqOugVmWW603qvq7vvdh16kbqTO5Kjal7xNodC1hvK8TZClVboYAF1rXcoJNnqRvRmMfRe+hxytEbJlHgySRUXhxjIulQyoAmroDl5AUPAvrOwjQe+EDO0DBWait1I0Cqw938SRgiyhiQHkKB1XwmKPODYciB/ELQskCxfF45s++vonSmqJtK7vbyCORUAlW2JnUUfkiBnAG01U5sm2ZfjwhRlzsDjQ0QWwNy1bNsbVQbri7PxOvH28NiNunm08nm30qB2BOQyQaFT31KYxY5NBoxPmIxkFMeZGFFCEapEdQD2Nsek9vKbQaM6ZUZ0lEkkeG5IMBub2ZkThgnLzFkWCvzgn67yp8+WnNVY3w7q6MJ4yzm3Lc+nyqWMzcWBSHlJ1ILgNi7pB8h6advoj+/4gcsscN2",
"status": "SUCCESS"
}
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/enrollment \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list": [
{
"enrollmentId": "ef66568d-1880-4092-a7f0-01829ee3b5aa",
"creationDate": "2020-08-17T09:25:34.507188+02:00",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"additionalData": {},
"acsURL": "https://test-threedsecure.centralpay.net/acs",
"amount": 1000,
"cardFingerprint": null,
"currency": "EUR",
"first6": "400000",
"last4": "0002",
"merchantCountry": "FRA",
"merchantName": "POS Démo Centralpay",
"merchantTransactionIdentifier": "REF001",
"merchantURL": "https://centralpay.net",
"paReq": "eJxdUttygjAQ/RWGd0yCQcBZ4liZtj7YOlX7HmGrTCEoYAc/qd/RH2uieGkfMtmzm909ezYwaovc+sKqzkoV2axHbQtVUqaZ2kT2avnoBLZVN1KlMi8VRvYRa3skYLmtEOMFJocKBcywruUGrSyN7HTghWufSSeV/trhVEondKXnyHXgfSCuGefMFjAfv+FeQNdZ6MY9F8gF6opVspWqESCT/cP0RfDQp4wB6SAUWE1jQZnb594AyBmCkgWK+evCin++i9KaoGoqme/kEcgpBEl50K6jcD0K5ALgUOVi2zS7ekhIcs3pKWyAmBiQG5/5wVi1rtVmqVh9vj/N4nE7nYw3/04ExLyAVDYoXOpSGjDfov7Q9YZ9DuTkB1kYEoJRqgl1AHamx/g+cu8BLXqll3QUoR/oKS4IsN3pHekXWsmrDSnWiZ6gu270J89G3KTRul3Y0dD1+pxzQ+UcMTUzLVHfo4NTUQOAmFzSrZB029fWn1/xC4ERxJo=",
"status": "SUCCESS"
},
{
"enrollmentId": "4d7d508e-c94d-41f1-8c70-317beace01ab",
"creationDate": "2020-08-17T09:16:18.728779+02:00",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"additionalData": {},
"acsURL": "https://test-threedsecure.centralpay.net/acs",
"amount": 1000,
"cardFingerprint": null,
"currency": "EUR",
"first6": "400000",
"last4": "0002",
"merchantCountry": "FRA",
"merchantName": "POS Démo Centralpay",
"merchantTransactionIdentifier": "REF001",
"merchantURL": "https://centralpay.net",
"paReq": "eJxdUttSwjAQ/ZVO30uSlqYtsw2DMCoPKCPoe0x3oCNNoRenfJLf4Y+ZYLnoQyZ7dpOzJ2cD467YOZ9Y1XmpU5cNqOugVmWW603qvq7vvdh16kbqTO5Kjal7xNodC1hvK8TZClVboYAF1rXcoJNnqRvRmMfRe+hxytEbJlHgySRUXhxjIulQyoAmroDl5AUPAvrOwjQe+EDO0DBWait1I0Cqw938SRgiyhiQHkKB1XwmKPODYciB/ELQskCxfF45s++vonSmqJtK7vbyCORUAlW2JnUUfkiBnAG01U5sm2ZfjwhRlzsDjQ0QWwNy1bNsbVQbri7PxOvH28NiNunm08nm30qB2BOQyQaFT31KYxY5NBoxPmIxkFMeZGFFCEapEdQD2Nsek9vKbQaM6ZUZ0lEkkeG5IMBub2ZkThgnLzFkWCvzgn67yp8+WnNVY3w7q6MJ4yzm3Lc+nyqWMzcWBSHlJ1ILgNi7pB8h6advoj+/4gcsscN2",
"status": "SUCCESS"
}
],
"totalCount": 638
}
List enrollments
This function allows you to search objects from a multi-criteria search. All the paramers used to search must be passed in the form of queries parameters.
« Enrolment » specific parameters
| merchantTransactionIdentifier String (20) |
Merchant ID (XID) |
| cardFingerprint String (40) |
Card fingerprint Required: no Validation: [0-9a-f]{40} |
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/enrollment \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list": [
{
"enrollmentId": "ef66568d-1880-4092-a7f0-01829ee3b5aa",
"creationDate": "2020-08-17T09:25:34.507188+02:00",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"additionalData": {},
"acsURL": "https://test-threedsecure.centralpay.net/acs",
"amount": 1000,
"cardFingerprint": null,
"currency": "EUR",
"first6": "400000",
"last4": "0002",
"merchantCountry": "FRA",
"merchantName": "POS Démo Centralpay",
"merchantTransactionIdentifier": "REF001",
"merchantURL": "https://centralpay.net",
"paReq": "eJxdUttygjAQ/RWGd0yCQcBZ4liZtj7YOlX7HmGrTCEoYAc/qd/RH2uieGkfMtmzm909ezYwaovc+sKqzkoV2axHbQtVUqaZ2kT2avnoBLZVN1KlMi8VRvYRa3skYLmtEOMFJocKBcywruUGrSyN7HTghWufSSeV/trhVEondKXnyHXgfSCuGefMFjAfv+FeQNdZ6MY9F8gF6opVspWqESCT/cP0RfDQp4wB6SAUWE1jQZnb594AyBmCkgWK+evCin++i9KaoGoqme/kEcgpBEl50K6jcD0K5ALgUOVi2zS7ekhIcs3pKWyAmBiQG5/5wVi1rtVmqVh9vj/N4nE7nYw3/04ExLyAVDYoXOpSGjDfov7Q9YZ9DuTkB1kYEoJRqgl1AHamx/g+cu8BLXqll3QUoR/oKS4IsN3pHekXWsmrDSnWiZ6gu270J89G3KTRul3Y0dD1+pxzQ+UcMTUzLVHfo4NTUQOAmFzSrZB029fWn1/xC4ERxJo=",
"status": "SUCCESS"
},
{
"enrollmentId": "4d7d508e-c94d-41f1-8c70-317beace01ab",
"creationDate": "2020-08-17T09:16:18.728779+02:00",
"contractId": "71602dd0-2790-4743-877b-e72530d7576d",
"pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
"additionalData": {},
"acsURL": "https://test-threedsecure.centralpay.net/acs",
"amount": 1000,
"cardFingerprint": null,
"currency": "EUR",
"first6": "400000",
"last4": "0002",
"merchantCountry": "FRA",
"merchantName": "POS Démo Centralpay",
"merchantTransactionIdentifier": "REF001",
"merchantURL": "https://centralpay.net",
"paReq": "eJxdUttSwjAQ/ZVO30uSlqYtsw2DMCoPKCPoe0x3oCNNoRenfJLf4Y+ZYLnoQyZ7dpOzJ2cD467YOZ9Y1XmpU5cNqOugVmWW603qvq7vvdh16kbqTO5Kjal7xNodC1hvK8TZClVboYAF1rXcoJNnqRvRmMfRe+hxytEbJlHgySRUXhxjIulQyoAmroDl5AUPAvrOwjQe+EDO0DBWait1I0Cqw938SRgiyhiQHkKB1XwmKPODYciB/ELQskCxfF45s++vonSmqJtK7vbyCORUAlW2JnUUfkiBnAG01U5sm2ZfjwhRlzsDjQ0QWwNy1bNsbVQbri7PxOvH28NiNunm08nm30qB2BOQyQaFT31KYxY5NBoxPmIxkFMeZGFFCEapEdQD2Nsek9vKbQaM6ZUZ0lEkkeG5IMBub2ZkThgnLzFkWCvzgn67yp8+WnNVY3w7q6MJ4yzm3Lc+nyqWMzcWBSHlJ1ILgNi7pB8h6advoj+/4gcsscN2",
"status": "SUCCESS"
}
],
"totalCount": 638
}
Enrollment object
The Json « Enrollment » object
The « Enrollment » object represents a 3D Secure debit/credit card enrolment
| enrollmentId UUID (36) |
CentralPay enrolment ID |
| merchantTransactionIdentifier String |
Merchant ID (XID) |
| creationDate String |
Creation date |
|
pointOfSaleId |
Indentification number of the POS |
| status Enum EnrollmentStatus |
Enrolment status Note: SUCCESS | FAILURE |
| currency String |
Currency Note: Favourite format |
| amount Integer |
Amount |
| first6 String |
The first 6 digits of the card |
| last4 String |
The last 4 digits of the card |
| cardFingerprint String |
Card fingerprint |
| paReq String (10000) |
PaReq Note: 10 000 max |
| acsURL String |
URL of ACS |
| additionalData Object |
Merchant data Note: Contains key/values |
3DS 2.0
Versioning
Service that allow you to know if a card is compatible with 3ds-2 and in this case create the 3DS Method.
| Méthode HTTP | POST |
| URL | /v2/rest/3ds2/versioning |
| Requête Content-Type | application/x-www-form-urlencoded |
| Réponse Content-Type | application/json |
| acctNumber String |
Card number Required: conditional Validation: card number Note: acctNumber or cardTokenId or customerId |
| cardTokenId UUID |
Token ID Required: conditional Validation: UUID - Existing - Belongs to the merchant - Not expired - Not used Note: acctNumber or cardTokenId or customerId |
| customerId UUID |
Customer ID Required: conditional Validation: UUID - Existing - Belongs to the merchant Note: acctNumber or cardTokenId or customerId |
| cardId UUID |
Customer card ID Required: conditional Validation: UUID - Existing - Belongs to the customer - Not expired Note: optional if customerId is present |
| threeDSServerTransID String |
3DS server ID Note: UUID |
| threeDSMethodURL String |
3DS method URL Note: URL |
| threeDSMethodDataForm Object |
3DS method data |
| threeDSMethodDataForm.threeDSMethodData String |
3DS method data Note: base64 - The merchant need to create a hidden iFrame in the card holder browser. This iframe need to contain and send a formular with an HTTP parameters named threeDSMethodData that will contain this data. The data can be retrieve by a HTTP POST request to the URL 3DS Method threeDSMethodURL |
| errorDetails Object |
Error details |
Authentication
Service that authentify the card holder as the real customer
| Méthode HTTP | POST |
| URL | /v2/rest/3ds2/authentication |
| Requête Content-Type | application/x-www-form-urlencoded |
| Réponse Content-Type | application/json |
| deviceChannel String |
Indicate the type of interface used to initiate the transactionRequired: yes Validation: permitted value Note: 01 = Application 02 = Browser 03 = Initiated by the merchant (3RI) |
| messageCategory String |
Identifiate the message category
Required: yes DeviceChannel : All |
| threeDSRequestorAuthenticationInd String |
Indicate the type of authentification request
Required: yes DeviceChannel : All |
| notificationURL URL |
URL that will receive the CRes message
Required: yes DeviceChannel : 02 |
| threeDSRequestorURL URL |
URL of the merchant site
Required: yes DeviceChannel : All |
| acctNumber String |
Card number
Required: conditional DeviceChannel : All
|
| cardTokenId UUID |
Token Identifier
Required: conditional DeviceChannel : All
|
| customerId UUID |
Client identifier
Required: conditional DeviceChannel : All |
| cardId UUID |
Identifier of the customer card
Required: conditional DeviceChannel : All |
| threeDSServerTransID UUID |
Identifier of the 3DS Server
Required: no DeviceChannel : All |
| pointOfSaleId UUID |
Identifier of the POS
Required: no DeviceChannel : All |
| contractId UUID |
Identifier of the contract
Required: no DeviceChannel : All |
| purchaseAmount Integer |
Amount in cents of the purchase
Required: PA - yes / NPA - no DeviceChannel : All |
| purchaseCurrency String |
Currency of the purchase amount
Required: PA - yes / NPA - no DeviceChannel : All |
| purchaseInstalData Integer |
Indicate the maximum number of the allowed authorizations for an installment payment
Required: conditional DeviceChannel : All |
| cardExpiryDate Date |
Expiration date of the card
Required: conditional DeviceChannel : All |
| recurringExpiry Date |
The date after which not another authorization can be realised.
Required: conditional DeviceChannel : All |
| recurringFrequency Integer |
Indicate the minimal number of days between the authorizations
Required: conditional DeviceChannel : All |
| transType String |
Identify the type of transaction that need to be authentified
Required: conditional DeviceChannel : All |
| threeRIInd String |
Indicate the type of 3RI request
Required: conditional Note: 01 = Subscription payment DeviceChannel : 03 |
| threeDSRequestorChallengeInd String |
Indicate if a challenge is asked for this transaction
Required: no DeviceChannel : All |
| browserLanguage String |
Browser language
Required: yes DeviceChannel : 02 |
| browserColorDepth String |
Depht of color for the picture display
Required: yes DeviceChannel : 02 |
| browserScreenHeight String |
In pixel, the screen height of the browser
Required: yes DeviceChannel : 02 |
| browserScreenWidth String |
In pixel, the screen width of the browser
Required: yes Device channel : 02
|
| browserTZ Integer |
Time differences between the UTC time and the local time, in minutes
Required: yes Device channel : 02
|
| browserUserAgent String |
Exact content of the HTTP header user-agent
Required: yes
Device channel : 02
|
| browserAcceptHeader String |
Exact content of the HTTP header accept
Required: yes
Device channel : 02
|
| browserIP String |
IP address of the browser
Required: conditional Device channel : 02 |
| chAccAgeInd String |
Period since the card holder have a customer account in the merchant site
Required: recommended
Device channel : All
|
| chAccChange Date |
Date of the last change in the customer account in the merchant site, including the facturation or shipping address, a new payment account, or a new user.
Required: recommended
Device channel : All |
| chAccChangeInd String |
Period since the last change in the customer account in the merchant site, including the facturation or shipping address, a new payment account, or a new user.
Required: recommended
Device channel : All
|
| chAccDate Date |
Date where the card holder opened a customer account
Required: recommended
Device channel : All
|
| chAccPwChange Date |
Date of the last password modification in the customer account
Required: recommended
Device channel : All
|
| chAccPwChangeInd String |
Period since the last password modification in the customer account
Required: recommended
Device channel : All
|
| nbPurchaseAccount Integer |
Number of purchase with the customer account since the last 6 months
Required: recommended Device channel : All |
| paymentAccAge Date |
Date where the payment account was enrolled within the merchant place
Required: recommended Device channel : All |
| paymentAccInd String |
Period since the payment account was enrolled within the merchant place
Required: recommended 03 = Less than 30 days
Device channel : All |
| provisionAttemptsDay Integer |
Number of card added and used since the last 24 hours
Required: recommended
Device channel : All |
| shipAddressUsage Date |
Last date of utilisation of the shipping address linked to the transaction
Required: recommended
Device channel : All
|
| shipAddressUsageInd String |
Period since the date of the last utilisation of the shipping address linked to the transaction
Required: recommended 03 = 30-60 days 04 = More than 60 days
Device channel : All
|
| shipNameIndicator String |
Indicate if the card holder name is the same as the name used in the shipping address Required: recommended Validation: permitted value Note: DeviceChannel : All |
| suspiciousAccActivity String |
Indicate if the card holder has experienced any suspicious activities
Required: recommended DeviceChannel : All |
| txnActivityDay Integer |
Number of transactions (successful and abandoned) for this cardholder account within the merchant place across all payment accounts in the previous 24 hours.
Required: recommended
DeviceChannel : All
|
| txnActivityYear Integer |
Number of transactions (successful and abandoned) for this cardholder account within the merchant place across all payment accounts in the previous year.
Required: recommended
DeviceChannel : All
|
| acctID String |
Identifier of the customer account, optionally provided by the merchant
Required: no
DeviceChannel : All
|
| acctType String |
Type of account
Required: conditional DeviceChannel : All |
| addrMatch String |
Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same.
Required: no DeviceChannel : 01 and 02 |
| billAddrCity String |
City of the billing address
Required: conditional
DeviceChannel : All
|
| billAddrCountry String |
Country of the billing address
Required: conditional
DeviceChannel : All
|
| billAddrLine1 String |
First line of the billing address
Required: conditional
DeviceChannel : All
|
| billAddrLine2 String |
Second line of the billing address
Required: conditional DeviceChannel : All
|
| billAddrLine3 String |
Third line of the billing address
Required: conditional DeviceChannel : All |
| billAddrPostCode String |
Postal code of the billing address
Required: conditional DeviceChannel : All |
| billAddrState String |
State or county of the billing address Required: conditional Validation: 3 characters maximum Note: Voir ISO 3166-2 Required unless the market or the regional mandate restricts the sending of this information DeviceChannel : All |
| cardholderName String |
Card holder name
Required: conditional
DeviceChannel : All
|
| email String |
Card holder email
Required: conditional DeviceChannel : All |
| homePhone[cc] String |
Card holder phone country code Required: conditional Validation: 1-3 characters Note: Voir ITU-E.164 Required unless the market or the regional mandate restricts the sending of this information DeviceChannel : All |
| homePhone[subscriber] String |
Card holder phone number Required: conditional Validation: 15 characters maximum Note: Voir ITU-E.164 Required unless the market or the regional mandate restricts the sending of this information DeviceChannel : All |
| mobilePhone[cc] String |
Card holder mobile phone country code Required: conditional Validation: 1-3 characters Note: Voir ITU-E.164 Required unless the market or the regional mandate restricts the sending of this information DeviceChannel : All |
| mobilePhone[subscriber] String |
Card holder mobile phone number Required: conditional Validation: 15 characters maximum Note: Voir ITU-E.164 Required unless the market or the regional mandate restricts the sending of this information DeviceChannel : All |
| workPhone[cc] String |
Card holder work phone country code Required: conditional Validation: 1-3 characters Note: Voir ITU-E.164 Required unless the market or the regional mandate restricts the sending of this information DeviceChannel : All |
| workPhone[subscriber] String |
Card holder work phone number Required: conditional Validation: 15 characters maximum Note: Voir ITU-E.164 Required unless the market or the regional mandate restricts the sending of this information DeviceChannel : All |
| shipAddrCity String |
City of the shipping address
Required: conditional DeviceChannel : All |
| shipAddrCountry String |
Country of the shipping address
Required: conditional DeviceChannel : All |
| shipAddrLine1 String |
First line of the shipping address
Required: conditional DeviceChannel : All |
| shipAddrLine2 String |
Second line of the shipping address
Required: conditional DeviceChannel : All |
| shipAddrLine3 String |
Third line of the shipping address
Required: conditional DeviceChannel : All
|
| shipAddrPostCode String |
Postal code of the shipping address
Required: conditional DeviceChannel : All |
| shipAddrState String |
State or county of the shipping address Required: conditional Validation: 3 characters maximum Note: Voir ISO 3166-2 Required unless the market or the regional mandate restricts the sending of this information DeviceChannel : All |
| threeDSReqAuthData String |
Data that documents and supports a specific authentication process.
Required: recommended
DeviceChannel : All
|
| threeDSReqAuthMethod String |
Mechanism used by the Cardholder to authenticate to the merchant
Required: recommended
DeviceChannel : All
|
| threeDSReqAuthTimestamp Date |
Date and time in UTC of the cardholder authentication.
Required: recommended
DeviceChannel : All
|
| threeDSReqPriorAuthData String |
Data that documents and supports a specific authentication process.
Required: recommended
DeviceChannel : All
|
| threeDSReqPriorAuthMethod String |
Mechanism used by the Cardholder to previously authenticate to the merchant
Required: recommended 01 = Frictionless authentication occurred by ACS 02 = Cardholder challenge occurred by ACS 03 = AVS verified (system of address verification) 04 = Other issuer methods DeviceChannel : All |
| threeDSReqPriorAuthTimestamp Date |
Date and time in UTC of the prior cardholder authentication.
Required: recommended
DeviceChannel : All
|
| threeDSReqPriorRef UUID |
This data element provides additional information to the ACS to determine the best approach for handing a request.
Required: recommended
DeviceChannel : All
|
| deliveryEmailAddress String |
For Electronic delivery, the email address to which the merchandise was delivered.
Required: recommended
DeviceChannel : All
|
| deliveryTimeframe String |
Indicates the merchandise delivery timeframe.
Required: recommended 03 = Overnight shipping
DeviceChannel : All
|
| giftCardAmount Integer |
For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major units
Required: recommended
DeviceChannel : All
|
| giftCardCount Integer |
For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
Required: recommended
DeviceChannel : All
|
| giftCardCurr String |
For prepaid or gift card purchase, the currency of the card
Required: recommended
DeviceChannel : All |
| preOrderDate Date |
For a pre-ordered purchase, the expected date that the merchandise will be available.
Required: recommended
DeviceChannel : All |
| preOrderPurchaseInd String |
Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
Required: recommended 01 = Merchandise available 02 = Future availability
DeviceChannel : All |
| reorderItemsInd String |
Indicates whether the cardholder is reordering previously purchased merchandise.
Required: recommended 01 = First time ordered 02 = Reordered
DeviceChannel : All
|
| shipIndicator UUID |
Indicates shipping method chosen for the transaction.
Required: recommended 01 = Ship to cardholder’s billing address
02 = Ship to another verified address on file with merchant03 = Ship to address that is different than the cardholder’s billing address04 =“Ship to Store” / Pick-up at local store (Store address shall be populated in shipping address fields)
DeviceChannel : All
|
| threeDSServerTransID String |
Identifier of the 3DS Server Note: UUID |
| transStatus String |
Indicate if a transaction is concidered as authenticated Note: Y = Authentication successful N = Non authenticate; Transaction declined U = The authentication cannot be completed; Technical problem A = Attempt perfomed; Non authenticated,but a proof of a authentication is provided. C = Challenge required;A additionnal authentication is required by using the CReq/CRes R = Authentication rejected; The issuer rejected the authentication and asks for the authentication doesn't be performed |
| authenticationValue String |
Specific data provided by the ACS. This value can bu used as a proof of authentication Note: base64 |
| eci String |
Specific data provided by the ACS to indicate the result of the authentication |
| acsURL String |
URL of the ACS. Use it for the challenge.Note: URL |
| acsChallengeMandated String |
Indicate if the challenge is required for the transacton to be permitted. Note: Y = Challenge required N = Challenge unrequired |
| base64EncodedChallengeRequest String |
Data provided if an additionnal authentication is required
Note: The merchant need to create an iframe in the card holder browser that need to contain and send an HTTP parameter named creq that contain this data by a HTTP POST request to the ACS URL of the acsURL. |
| errorDetails Object |
errors Detail |
Results
Service that allow to retrieve the result of a challenge
| Méthode HTTP | GET |
| URL | /v2/rest/3ds2/results/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| Requête Content-Type | application/x-www-form-urlencoded |
| Réponse Content-Type | application/json |
| threeDSServerTransID (URL) UUID |
Identifier 3DS Server Required: yes Validation: UUID - Existing - Belongs to the merchant |
| threeDSServerTransID String |
Identifiant 3DS Server Note: UUID |
| transStatus String |
Indicate if a transaction is concidered as authenticated Note: Y = Authentication successful N = Non authenticate; Transaction declined |
| authenticationValue String |
Specific data provided by the ACS. This value can be used as a proof of authentication Note: base64 |
| eci String |
Specific data provided by the ACS to indicate the result of the authentication |
| errorDetails Object |
errors Detail |
SDD Transaction
The SDD transaction help to perform a direct debit account-to-account. To do that, a few step are required and will be diplayed in this section.
First, a bank account identity must be created by the merchant (creditor) for the customer (debtor), with the informations provided by the customer. Once the identity created, a bank account must be created, also by the merchant (creditor), for the customer (debtor), with the informations provided by the customer. Please note the bank account created by the method will always be a debtor account. To create a paying or a merchant account, which can be creditor account, you must rely to our BackOffice and have a STANDARD level account or more.
When bank accounts are created, the merchant (creditor) must create a mandate, which will be sign with an OTP system by the customer (debtor). Once the mandate status will be ACTIVE, the merchant (creditor) can create SDD Transaction(s), in a recurring or in a one time pattern. The merchant (creditor) can ask to have an OTP send to the customer (debtor) at each new SDD Transaction.
Each OTP have a life time of 15 minutes.
Identity
The identity will be the identity of the bank account. It must be created by the merchant (creditor) with the informations displayed by the customer (debtor) for this purpose. The merchant must be STANDARD level or more.
HTTP Request
POST https://test-api.centralpay.net/v2/rest/identity
HTTP Response
OBJ Json Identity type
Example of curl code
curl -vX POST https://test-api.centralpay.net/v2/rest/identity \
-u 'doctest:4I9HJRTd' \
-H 'Content-Type:application/x-www-form-urlencoded' \
-d name='AXA' \
-d address='16 rue des Lavandes' \
-d postalCode=45650 \
-d city='St jean le blanc' \
-d country=FRA
Back to JSON Format
{
"name": "AXA",
"description": null,
"address": "16 RUE DES LAVANDES",
"postalCode": "45650",
"city": "ST JEAN LE BLANC",
"country": "FRA",
"identityId": "c957efdd-6660-40a3-9591-373b2e1295bb",
"creationDate": "2020-08-21T09:13:22.639549+02:00"
}
Create an identity
This function allow you to create an identity of bank account.
| name String (70) |
The name of the bank account actor Required : Yes |
|
description String (256) |
A mere description by the merchant Required : No |
| address String (255) |
the bank account address Required : Yes |
|
postalCode String (255) |
the postal code of the bank account Required : Yes |
|
city String (35) |
City of the bank account Required : Yes |
|
country String (35) |
Country of the bank account Required : Yes Note : ISO3166 in format alpha2, apha3 or num |
HTTP Request
POST https://test-api.centralpay.net/v2/rest/identity
HTTP Response
OBJ Json Identity type
Example of curl code
curl -vX POST https://test-api.centralpay.net/v2/rest/identity \
-u 'doctest:4I9HJRTd' \
-H 'Content-Type:application/x-www-form-urlencoded' \
-d name='AXA' \
-d address='16 rue des Lavandes' \
-d postalCode=45650 \
-d city='St jean le blanc' \
-d country=FRA
Back to JSON Format
{
"name": "AXA",
"description": null,
"address": "16 RUE DES LAVANDES",
"postalCode": "45650",
"city": "ST JEAN LE BLANC",
"country": "FRA",
"identityId": "c957efdd-6660-40a3-9591-373b2e1295bb",
"creationDate": "2020-08-21T09:13:22.639549+02:00"
}
The Identity Object
The "Identity" object represents an identity of a bank Account.
| name String (70) |
The name of the bank account |
|
description String (256) |
A mere description by the merchant
|
| address String (255) |
the bank account address |
|
postalCode String (255) |
the postal code of the bank account |
|
city String (35) |
City of the bank account |
|
country String (35) |
Country of the bank account
Note : ISO3166 in format alpha2, apha3 or num |
|
creationDate OffsetDate |
Date and hour of creation
|
Bank Account
Once the identity is created, the merchant can create the bank account linked to. The merchant (creditor) must create for their customers (debtors) bank account's with the information provided by the customers for this purpose.
It must be noted that only debtor account can be created this way. To become a creditor, you need to have a level STANDARD or more.