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
Use the following link for testing: 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: A ready-to-use service 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 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: TRANSACTION_CANCELED - - - - - - - - - - - - - - - - TRANSFER_SUCCEEDED - - - - - - - - - - - - - - - - REFUND_CANCELED - - - - - - - - - - - - - - - - CUSTOMER_CREATED CUSTOMER_UPDATED CUSTOMER_CARD_ADDED - - - - - - - - - - - - - - - - CARD_UPDATED CARDTOKEN_CREATED - - - - - - - - - - - - - - - - SUBMERCHANT_CREATED SUBMERCHANT_UPDATED - - - - - - - - - - - - - - - - CHECKENROLLMENT_CREATED - - - - - - - - - - - - - - - - RETRIEVAL_NOTICED RETRIEVAL_CLOSE CHARGEBACK_NOTICED CHARGEBACK_WON CHARGEBACK_LOST - - - - - - - - - - - - - - - - SUBSCRIPTIONMODEL_CREATED - - - - - - - - - - - - - - - - SUBSCRIPTION_CREATED - - - - - - - - - - - - - - - - INVOICEITEM_CREATED - - - - - - - - - - - - - - - - INVOICE_CREATED - - - - - - - - - - - - - - - - ENROLLMENT_CREATED - - - - - - - - - - - - - - - - PAYOUT_CREATED - - - - - - - - - - - - - - - - WIRETRANSFER_CREATED WIRETRANSFER_UPDATED WIRETRANSFER_RECEIVED WIRETRANSFER_CANCELED - - - - - - - - - - - - - - - - INSTALLMENTPAYMENT_CREATED INSTALLMENTPAYMENT_FAILED INSTALLMENTPAYMENT_UPDATED INSTALLMENTPAYMENT_CANCELED INSTALLMENTPAYMENT_ACTIVATED INSTALLMENTPAYMENT_FAILURE INSTALLMENTPAYMENT_PAID INSTALLMENTPAYMENT_UNPAID INSTALLMENT_TRANSACTION - - - - - - - - - - - - - - - - TRANSFER_SUCCEEDED TRANSFER_UPDATED TRANSFER_CANCELED - - - - - - - - - - - - - - - -
|
| 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
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 |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/wallet/<walletId>
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.
| walletId UUID (36) |
CentralPay ID of the wallet Required: yes Validation: UUID Wallet of the connected merchant or wallet of one of his sub-merchants By default, the wallet of the connected merchant |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/wallet/<walletId>
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"}]}
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, “cards" 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 |
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 |
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/cardToken \
-H "Origin:http://www.centralpay.dev" \
-d card[number]=4000000000000002 \
-d card[cvc]=123 \
-d card[expirationMonth]=12 \
-d card[expirationYear]=2018 \
-d merchantPublicKey=2a5a5fd5145e11b70d39bb4acb8cf6e18fa84115791116281c2123908530d254
Back to Json format
{
"cardTokenId":"db73e301-20e3-47c1-835c-dfc7efed1e35",
"creationDate":"2016-09-22T17:12:25.210+02:00",
"card":{
"cardId":"090f83f2-686b-4493-8644-dce70a12294b",
"merchantCardId":null,
"creationDate":"2016-09-22T17:12:25.210+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":12,
"expirationYear":2018,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"748f88a2e25f1db08fa3074269a0587a67c9970c",
"additionalData":{
},
"cardTokenId":"db73e301-20e3-47c1-835c-dfc7efed1e35"
},
"endUserIp":"172.31.1.71",
"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 -v https://test-api.centralpay.net/v2/rest/cardToken \
-H "Origin:http://www.centralpay.dev" \
-d card[number]=4000000000000002 \
-d card[cvc]=123 \
-d card[expirationMonth]=12 \
-d card[expirationYear]=2018 \
-d merchantPublicKey=2a5a5fd5145e11b70d39bb4acb8cf6e18fa84115791116281c2123908530d254
Back to Json format
{
"cardTokenId":"db73e301-20e3-47c1-835c-dfc7efed1e35",
"creationDate":"2016-09-22T17:12:25.210+02:00",
"card":{
"cardId":"090f83f2-686b-4493-8644-dce70a12294b",
"merchantCardId":null,
"creationDate":"2016-09-22T17:12:25.210+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":12,
"expirationYear":2018,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"748f88a2e25f1db08fa3074269a0587a67c9970c",
"additionalData":{
},
"cardTokenId":"db73e301-20e3-47c1-835c-dfc7efed1e35"
},
"endUserIp":"172.31.1.71",
"status":"UNUSED"
}
Exemple of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/cardToken/db73e301-20e3-47c1-835c-dfc7efed1e35 \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"cardTokenId":"db73e301-20e3-47c1-835c-dfc7efed1e35",
"creationDate":"2016-09-22T17:12:25.210+02:00",
"card":{
"cardId":"090f83f2-686b-4493-8644-dce70a12294b",
"merchantCardId":null,
"creationDate":"2016-09-22T17:12:25.210+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":12,
"expirationYear":2018,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"748f88a2e25f1db08fa3074269a0587a67c9970c",
"additionalData":{
},
"cardTokenId":"db73e301-20e3-47c1-835c-dfc7efed1e35"
},
"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/db73e301-20e3-47c1-835c-dfc7efed1e35 \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"cardTokenId":"db73e301-20e3-47c1-835c-dfc7efed1e35",
"creationDate":"2016-09-22T17:12:25.210+02:00",
"card":{
"cardId":"090f83f2-686b-4493-8644-dce70a12294b",
"merchantCardId":null,
"creationDate":"2016-09-22T17:12:25.210+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":12,
"expirationYear":2018,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"748f88a2e25f1db08fa3074269a0587a67c9970c",
"additionalData":{
},
"cardTokenId":"db73e301-20e3-47c1-835c-dfc7efed1e35"
},
"endUserIp":"172.31.1.71",
"status":"EXPIRED"
}
Transaction
A "Transaction" is the processing of a debit/credit card. Transactions are identified by a unique TransactionID.
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 |
| 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: EC: Electronic Commerce MO: Mail Order TO: Telephone Order EC by default |
| 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" object |
| captureStatus String |
Debit status Note: UNCAPTURED | 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 |
| affiliatedMemberId String (36) |
CentralPay affiliate ID Note: UUID Format |
| 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 |
| bvsCode Integer |
BVS code |
| bvsMessage String |
BVS message |
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 |
|
escrowDate LocaleDate |
Escrow date Required : no Validation: The escrowDate must be equal to or greater than the transaction capture date plus 5 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 Number |
Transfer amount |
| fee Number |
Fee |
| 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
|
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transaction \
-u 'doctest:4I9HJRTd' \
-d card[number]=4000000000000086 \
-d card[cvc]=123 \
-d card[expirationMonth]=1 \
-d card[expirationYear]=2018 \
-d currency=EUR \
-d amount=100 \
-d additionalData=[key1]value1 \
-d additionalData=[key2]value2
Back to JSON Format
{
"transactionId":"bf40ff1e-edd3-4a76-b97a-cccd983858bb",
"creationDate":"2016-08-31T12:09:01.725+02:00",
"authorizationCancellationDate":null,
"customerId":null,
"captureDate":null,
"clearingDate":null,
"captureCancellationDate":null,
"pointOfSaleId":"ec3eaf8c-636a-44e1-bf9d-d01ac11771d4",
"contractId":"7acbd816-4cd2-44df-9d8f-00a151ae6fb1",
"affiliatedMemberId":null,
"enrollmentId":null,
"additionalData":{
"key1":"value1",
"key2":"value2"
},
"amount":100,
"amountCaptured":0,
"amountRefunded":0,
"authorizationCode":null,
"authorizationStatus":"FAILURE",
"bankCode":"5",
"bankMessage":"Simulated authorization: do not continue",
"breakdownPerSubMerchant":[
],
"captureStatus":"UNCAPTURED",
"card":{
"cardId":"b3252a39-d4fc-439f-a2e1-e1eb5fddcce7",
"creationDate":"2016-08-31T12:09:01.920+02:00",
"customerId":null,
"additionalData":{
},
"cardTokenId":null,
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"description":null,
"expirationMonth":1,
"expirationYear":2018,
"fingerprint":"117350d239246408a2aceecf0491affd3e971c2e",
"first6":"400000",
"last4":"0085",
"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,
"endUserIp": "245.100.1.15",
"endUserLanguage": "eng",
"browserUserAgent": "mozilla/5.0 (windows nt 6.3; win64; x64; rv:55.0) gecko/20100101 firefox/55.0",
"browserAcceptLanguage": "en-US,en;q=0.5",
}
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":"2019-10-01"}'Back to JSON Format
{"transactionId":"c985f487-f8db-4691-91a8-d1e4369fcbca","merchantTransactionId":null,"creationDate":"2018-08-03T16:25:26.892+02:00","transactionStatus":"SUCCESS","authorizationStatus":"SUCCESS","authorizationCancellationDate":null,"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,"customerId":null,"card":{"cardId":"42fb5651-7142-46b4-901c-40e79b68ad70","merchantCardId":null,"creationDate":"2018-08-03T16:25:27.056+02:00","commercialBrand":"VISA","first6":"400000","last4":"0002","expirationMonth":10,"expirationYear":2023,"country":null,"cardholderName":null,"cardholderEmail":null,"description":null,"customerId":null,"fingerprint":"756eed226b0cdc8c240b5447b4a3425628c56d7f","additionalData":{},"cardTokenId":null},"captureStatus":"CAPTURED","captureDate":"2018-08-03T16:25:27.400+02:00","amountCaptured":10,"clearingDate":null,"captureCancellationDate":null,"refunded":false,"amountRefunded":0,"refunds":[],"3ds":false,"endUserIp":"8.8.8.8","endUserLanguage":null,"browserUserAgent":null,"browserAcceptLanguage":null,"country":null,"receiptEmail":null,"pointOfSaleId":"cfc0b3c7-e666-4c52-b77a-96f234b873fe","contractId":"7acbd816-4cd2-44df-9d8f-00a151ae6fb1","breakdownPerSubMerchant":[],"enrollmentId":null,"movementId":"e4a82adb-370a-4d8b-96c3-26f2a4bf8f90","cancelMovementId":null,"transactiontransfers":[{"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171","amount":1,"fee":0,"escrowDate":"2019-10-01"}],"transferGroup":null,"bvsCode":null,"bvsMessage":null,"additionalData":{},"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}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 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 |
|
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 Note: EC: Electronic Commerce MO: Mail Order TO: Telephone Order EC by default |
| 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 Note: True by default |
| 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, "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
curl -v https://test-api.centralpay.net/v2/rest/transaction \
-u 'doctest:4I9HJRTd' \
-d card[number]=4000000000000086 \
-d card[cvc]=123 \
-d card[expirationMonth]=1 \
-d card[expirationYear]=2018 \
-d currency=EUR \
-d amount=100 \
-d additionalData=[key1]value1 \
-d additionalData=[key2]value2
Back to JSON Format
{
"transactionId":"bf40ff1e-edd3-4a76-b97a-cccd983858bb",
"creationDate":"2016-08-31T12:09:01.725+02:00",
"authorizationCancellationDate":null,
"customerId":null,
"captureDate":null,
"clearingDate":null,
"captureCancellationDate":null,
"pointOfSaleId":"ec3eaf8c-636a-44e1-bf9d-d01ac11771d4",
"contractId":"7acbd816-4cd2-44df-9d8f-00a151ae6fb1",
"affiliatedMemberId":null,
"enrollmentId":null,
"additionalData":{
"key1":"value1",
"key2":"value2"
},
"amount":100,
"amountCaptured":0,
"amountRefunded":0,
"authorizationCode":null,
"authorizationStatus":"FAILURE",
"bankCode":"5",
"bankMessage":"Simulated authorization: do not continue",
"breakdownPerSubMerchant":[
],
"captureStatus":"UNCAPTURED",
"card":{
"cardId":"b3252a39-d4fc-439f-a2e1-e1eb5fddcce7",
"creationDate":"2016-08-31T12:09:01.920+02:00",
"customerId":null,
"additionalData":{
},
"cardTokenId":null,
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"description":null,
"expirationMonth":1,
"expirationYear":2018,
"fingerprint":"117350d239246408a2aceecf0491affd3e971c2e",
"first6":"400000",
"last4":"0085",
"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,
"endUserIp": "245.100.1.15",
"endUserLanguage": "eng",
"browserUserAgent": "mozilla/5.0 (windows nt 6.3; win64; x64; rv:55.0) gecko/20100101 firefox/55.0",
"browserAcceptLanguage": "en-US,en;q=0.5",
}
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":"2019-10-01"}'Back to JSON Format
{"transactionId":"c985f487-f8db-4691-91a8-d1e4369fcbca","merchantTransactionId":null,"creationDate":"2018-08-03T16:25:26.892+02:00","transactionStatus":"SUCCESS","authorizationStatus":"SUCCESS","authorizationCancellationDate":null,"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,"customerId":null,"card":{"cardId":"42fb5651-7142-46b4-901c-40e79b68ad70","merchantCardId":null,"creationDate":"2018-08-03T16:25:27.056+02:00","commercialBrand":"VISA","first6":"400000","last4":"0002","expirationMonth":10,"expirationYear":2023,"country":null,"cardholderName":null,"cardholderEmail":null,"description":null,"customerId":null,"fingerprint":"756eed226b0cdc8c240b5447b4a3425628c56d7f","additionalData":{},"cardTokenId":null},"captureStatus":"CAPTURED","captureDate":"2018-08-03T16:25:27.400+02:00","amountCaptured":10,"clearingDate":null,"captureCancellationDate":null,"refunded":false,"amountRefunded":0,"refunds":[],"3ds":false,"endUserIp":"8.8.8.8","endUserLanguage":null,"browserUserAgent":null,"browserAcceptLanguage":null,"country":null,"receiptEmail":null,"pointOfSaleId":"cfc0b3c7-e666-4c52-b77a-96f234b873fe","contractId":"7acbd816-4cd2-44df-9d8f-00a151ae6fb1","breakdownPerSubMerchant":[],"enrollmentId":null,"movementId":"e4a82adb-370a-4d8b-96c3-26f2a4bf8f90","cancelMovementId":null,"transactiontransfers":[{"destinationWalletId":"10cfe034-ba9a-457e-b13d-fc68a5bfd171","amount":1,"fee":0,"escrowDate":"2019-10-01"}],"transferGroup":null,"bvsCode":null,"bvsMessage":null,"additionalData":{},"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}Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transaction/bf40ff1e-edd3-4a76-b97a-cccd983858bb \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"transactionId":"bf40ff1e-edd3-4a76-b97a-cccd983858bb",
"creationDate":"2016-08-31T12:09:01.725+02:00",
"authorizationCancellationDate":null,
"customerId":null,
"captureDate":null,
"clearingDate":null,
"captureCancellationDate":null,
"pointOfSaleId":"ec3eaf8c-636a-44e1-bf9d-d01ac11771d4",
"contractId":"7acbd816-4cd2-44df-9d8f-00a151ae6fb1",
"affiliatedMemberId":null,
"enrollmentId":null,
"additionalData":{
},
"amount":100,
"amountCaptured":0,
"amountRefunded":0,
"authorizationCode":null,
"authorizationStatus":"FAILURE",
"bankCode":"5",
"bankMessage":"Simulated authorization: do not continue",
"breakdownPerSubMerchant":[
],
"captureStatus":"UNCAPTURED",
"card":{
"cardId":"b3252a39-d4fc-439f-a2e1-e1eb5fddcce7",
"creationDate":"2016-08-31T12:09:01.920+02:00",
"customerId":null,
"additionalData":{
},
"cardTokenId":null,
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"description":null,
"expirationMonth":1,
"expirationYear":2018,
"fingerprint":"117350d239246408a2aceecf0491affd3e971c2e",
"first6":"400000",
"last4 ":"0085 ",
"merchantCardId ":null
},
"country ":null,
"currency ":"EUR ",
"description ":"Commande CMD0001 - M.Doe ",
"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
}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/bf40ff1e-edd3-4a76-b97a-cccd983858bb \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"transactionId":"bf40ff1e-edd3-4a76-b97a-cccd983858bb",
"creationDate":"2016-08-31T12:09:01.725+02:00",
"authorizationCancellationDate":null,
"customerId":null,
"captureDate":null,
"clearingDate":null,
"captureCancellationDate":null,
"pointOfSaleId":"ec3eaf8c-636a-44e1-bf9d-d01ac11771d4",
"contractId":"7acbd816-4cd2-44df-9d8f-00a151ae6fb1",
"affiliatedMemberId":null,
"enrollmentId":null,
"additionalData":{
},
"amount":100,
"amountCaptured":0,
"amountRefunded":0,
"authorizationCode":null,
"authorizationStatus":"FAILURE",
"bankCode":"5",
"bankMessage":"Simulated authorization: do not continue",
"breakdownPerSubMerchant":[
],
"captureStatus":"UNCAPTURED",
"card":{
"cardId":"b3252a39-d4fc-439f-a2e1-e1eb5fddcce7",
"creationDate":"2016-08-31T12:09:01.920+02:00",
"customerId":null,
"additionalData":{
},
"cardTokenId":null,
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"description":null,
"expirationMonth":1,
"expirationYear":2018,
"fingerprint":"117350d239246408a2aceecf0491affd3e971c2e",
"first6":"400000",
"last4 ":"0085 ",
"merchantCardId ":null
},
"country ":null,
"currency ":"EUR ",
"description ":"Commande CMD0001 - M.Doe ",
"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
}Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transaction/bdf615b4-4229-4d82-9c3a-d350dce16944/capture \
-u 'doctest:4I9HJRTd' \
-d currency=EUR \
-d amount=100 \
-d capture=true
Back to JSON Format
{
"transactionId":"5701ab34-01dd-455a-8fca-77a91b432bd1",
"merchantTransactionId":null,
"creationDate":"2016-09-22T12:14:10.361+02:00",
"authorizationStatus":"SUCCESS",
"authorizationCancellationDate":null,
"bankCode":"0",
"bankMessage":"Simulated authorization",
"authorizationCode":"000000",
"riskScore":null,
"source":"EC",
"description":"Test LPU",
"currency":"978",
"amount":100,
"totalAmount":100,
"customerId":null,
"card":{
"cardId":"9983ef12-689a-4a46-b0d3-b4d9908dcef4",
"merchantCardId":null,
"creationDate":"2016-09-22T12:14:10.931+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":1,
"expirationYear":2018,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"7e192bd4cc6107f962185447b5305d676ef5bd47",
"additionalData":{
},
"cardTokenId":null
},
"captureStatus":"CAPTURED",
"captureDate":"2016-09-22T12:14:11.077+02:00",
"amountCaptured":100,
"clearingDate":null,
"captureCancellationDate":null,
"refunded":false,
"amountRefunded":0,
"refunds":[
],
"3DS":false,
"endUserIp":null,
"country":null,
"receiptEmail":null,
"pointOfSaleId":"556b5936-e83a-4895-a0d1-4984be45dbb4",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"breakdownPerSubMerchant":[
],
"enrollmentId":null,
"additionalData":{
},
"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
}
}
Capture a transaction
This function allows you to capture a transaction with the transaction ID.
| transactionId UUID (36) |
CentralPay ID of the transaction Required: yes Validation: UUID - Existing - Authorised (for the user) Note: The transaction SHOULD be: - authorizationStatus = SUCCESS - captureStatus = UNCAPTURED - must be less than 7 days |
| 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 https://test-api.centralpay.net/v2/rest/transaction/bdf615b4-4229-4d82-9c3a-d350dce16944/capture \
-u 'doctest:4I9HJRTd' \
-d currency=EUR \
-d amount=100 \
-d capture=true
Back to JSON Format
{
"transactionId":"5701ab34-01dd-455a-8fca-77a91b432bd1",
"merchantTransactionId":null,
"creationDate":"2016-09-22T12:14:10.361+02:00",
"authorizationStatus":"SUCCESS",
"authorizationCancellationDate":null,
"bankCode":"0",
"bankMessage":"Simulated authorization",
"authorizationCode":"000000",
"riskScore":null,
"source":"EC",
"description":"Test LPU",
"currency":"978",
"amount":100,
"totalAmount":100,
"customerId":null,
"card":{
"cardId":"9983ef12-689a-4a46-b0d3-b4d9908dcef4",
"merchantCardId":null,
"creationDate":"2016-09-22T12:14:10.931+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":1,
"expirationYear":2018,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"7e192bd4cc6107f962185447b5305d676ef5bd47",
"additionalData":{
},
"cardTokenId":null
},
"captureStatus":"CAPTURED",
"captureDate":"2016-09-22T12:14:11.077+02:00",
"amountCaptured":100,
"clearingDate":null,
"captureCancellationDate":null,
"refunded":false,
"amountRefunded":0,
"refunds":[
],
"3DS":false,
"endUserIp":null,
"country":null,
"receiptEmail":null,
"pointOfSaleId":"556b5936-e83a-4895-a0d1-4984be45dbb4",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"breakdownPerSubMerchant":[
],
"enrollmentId":null,
"additionalData":{
},
"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
}
}
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/transaction/9c667641-45aa-4c44-87c4-f050be2eef0e/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 https://test-api.centralpay.net/v2/rest/transaction/9c667641-45aa-4c44-87c4-f050be2eef0e/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/bf40ff1e-edd3-4a76-b97a-cccd983858bb \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"transactionId":"bf40ff1e-edd3-4a76-b97a-cccd983858bb",
"merchantTransactionId":null,
"creationDate":"2016-08-31T12:09:01.725+02:00",
"authorizationStatus":"FAILURE",
"authorizationCancellationDate":null,
"bankCode":"5",
"bankMessage":"Simulated authorization: do not continue",
"authorizationCode":null,
"riskScore":null,
"source":"EC",
"description":"Commande CMD0001 - M. Doe",
"currency":"EUR",
"amount":100,
"customerId":null,
"card":{
"cardId":"b3252a39-d4fc-439f-a2e1-e1eb5fddcce7",
"merchantCardId":null,
"creationDate":"2016-08-31T12:09:01.920+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0085",
"expirationMonth":1,
"expirationYear":2018,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"117350d239246408a2aceecf0491affd3e971c2e",
"additionalData":{
},
"cardTokenId":null
},
"captureStatus":"UNCAPTURED",
"captureDate":null,
"amountCaptured":0,
"clearingDate":null,
"captureCancellationDate":null,
"refunded":false,
"amountRefunded":0,
"refunds":[
],
"3DS":false,
"endUserIp":null,
"country":null,
"receiptEmail":null,
"pointOfSaleId":"ec3eaf8c-636a-44e1-bf9d-d01ac11771d4",
"contractId":"7acbd816-4cd2-44df-9d8f-00a151ae6fb1",
"affiliatedMemberId":null,
"breakdownPerSubMerchant":[
],
"enrollmentId":null,
"additionalData":{
},
"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
}
}
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/bf40ff1e-edd3-4a76-b97a-cccd983858bb \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"transactionId":"bf40ff1e-edd3-4a76-b97a-cccd983858bb",
"merchantTransactionId":null,
"creationDate":"2016-08-31T12:09:01.725+02:00",
"authorizationStatus":"FAILURE",
"authorizationCancellationDate":null,
"bankCode":"5",
"bankMessage":"Simulated authorization: do not continue",
"authorizationCode":null,
"riskScore":null,
"source":"EC",
"description":"Commande CMD0001 - M. Doe",
"currency":"EUR",
"amount":100,
"customerId":null,
"card":{
"cardId":"b3252a39-d4fc-439f-a2e1-e1eb5fddcce7",
"merchantCardId":null,
"creationDate":"2016-08-31T12:09:01.920+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0085",
"expirationMonth":1,
"expirationYear":2018,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"117350d239246408a2aceecf0491affd3e971c2e",
"additionalData":{
},
"cardTokenId":null
},
"captureStatus":"UNCAPTURED",
"captureDate":null,
"amountCaptured":0,
"clearingDate":null,
"captureCancellationDate":null,
"refunded":false,
"amountRefunded":0,
"refunds":[
],
"3DS":false,
"endUserIp":null,
"country":null,
"receiptEmail":null,
"pointOfSaleId":"ec3eaf8c-636a-44e1-bf9d-d01ac11771d4",
"contractId":"7acbd816-4cd2-44df-9d8f-00a151ae6fb1",
"affiliatedMemberId":null,
"breakdownPerSubMerchant":[
],
"enrollmentId":null,
"additionalData":{
},
"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
}
}
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":"ebdb16be-75a2-4b3d-bf57-f390765c94ed",
"customerId":null,
"pointOfSaleId":"872ff5b9-7b66-4b4d-b18f-1287061244a2",
"contractId":"a6d95e35-2a4a-1572-63d5-696f3f9b742b",
"affiliatedMemberId":null,
"additionalData":{
},
"amount":2000,
"amountCaptured":2000,
"amountRefunded":2000,
"authorizationCancellationDate":null,
"authorizationCode":"161129",
"authorizationStatus":"SUCCESS",
"bankCode":"00",
"bankMessage":"Approved",
"captureCancellationDate":null,
"captureDate":"2016-03-09T17:43:24.636+01:00",
"captureStatus":"CLEARED",
"card":{
"cardId":"1930860f-1439-4252-ad1c-f91013fdc1ec",
"customerId":null,
"additionalData":{
},
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"creationDate":"2016-03-09T17:43:25.004+01:00",
"description":null,
"expirationMonth":12,
"expirationYear":2016,
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"first6":"461787",
"last4":"9012",
"merchantCardId":null
},
"clearingDate":null,
"country":null,
"creationDate":"2016-03-09T17:43:24.636+01:00",
"currency":"EUR",
"description":null,
"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":[
{
"refundId":"b2cc2ac5-d33e-4341-bbc0-91f2ba04dacb",
"transactionId":"ebdb16be-75a2-4b3d-bf57-f390765c94ed",
"additionalData":{
},
"amount":1536,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:28.963+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
},
{
"refundId":"28483cb3-01c7-49c7-9dee-55e9585ff6bc",
"transactionId":"ebdb16be-75a2-4b3d-bf57-f390765c94ed",
"additionalData":{
},
"amount":47,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:27.700+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
},
{
"refundId":"fcced231-3976-41b5-abb5-c896749f5e4b",
"transactionId":"ebdb16be-75a2-4b3d-bf57-f390765c94ed",
"additionalData":{
},
"amount":332,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:26.337+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
},
{
"refundId":"5ed69ed3-993a-43fd-8bad-923e37dc2100",
"transactionId":"ebdb16be-75a2-4b3d-bf57-f390765c94ed",
"additionalData":{
},
"amount":85,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:25.116+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
}
],
"source":"EC",
"3DS":false
},
{
"transactionId":"ab594f41-b78f-4b5f-a4e9-e4adfc173b9c",
"customerId":null,
"pointOfSaleId":"872ff5b9-7b66-4b4d-b18f-1287061244a2",
"contractId":"a6d95e35-2a4a-1572-63d5-696f3f9b742b",
"affiliatedMemberId":null,
"additionalData":{
},
"amount":2000,
"amountCaptured":2000,
"amountRefunded":1464,
"authorizationCancellationDate":null,
"authorizationCode":"292043",
"authorizationStatus":"SUCCESS",
"bankCode":"00",
"bankMessage":"Approved",
"captureCancellationDate":null,
"captureDate":"2016-03-09T17:43:16.840+01:00",
"captureStatus":"CLEARED",
"card":{
"cardId":"efc3395f-82db-45c1-9152-8135194b1d04",
"customerId":null,
"additionalData":{
},
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"creationDate":"2016-03-09T17:43:17.203+01:00",
"description":null,
"expirationMonth":12,
"expirationYear":2016,
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"first6":"461787",
"last4":"9012",
"merchantCardId":null
},
"clearingDate":null,
"country":null,
"creationDate":"2016-03-09T17:43:16.840+01:00",
"currency":"EUR",
"description":null,
"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":[
{
"refundId":"764c74f8-f883-4df6-b8e1-ae6efadca40a",
"transactionId":"ab594f41-b78f-4b5f-a4e9-e4adfc173b9c",
"additionalData":{
},
"amount":1047,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:20.276+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
},
{
"refundId":"cf86d43a-72fe-41c2-b608-1a46169bcd8a",
"transactionId":"ab594f41-b78f-4b5f-a4e9-e4adfc173b9c",
"additionalData":{
},
"amount":333,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:18.958+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
},
{
"refundId":"2502d31e-588a-4a30-b8b7-d4b743b4d0ee",
"transactionId":"ab594f41-b78f-4b5f-a4e9-e4adfc173b9c",
"additionalData":{
},
"amount":84,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:17.336+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
}
],
"source":"EC",
"3DS":false
},
{
"transactionId":"26286674-856a-42c2-875a-ca48ed7be306",
"customerId":null,
"pointOfSaleId":"872ff5b9-7b66-4b4d-b18f-1287061244a2",
"contractId":"a6d95e35-2a4a-1572-63d5-696f3f9b742b",
"affiliatedMemberId":null,
"additionalData":{
},
"amount":2000,
"amountCaptured":2000,
"amountRefunded":2000,
"authorizationCancellationDate":null,
"authorizationCode":"317238",
"authorizationStatus":"SUCCESS",
"bankCode":"00",
"bankMessage":"Approved",
"captureCancellationDate":null,
"captureDate":"2016-03-09T17:43:12.482+01:00",
"captureStatus":"CLEARED",
"card":{
"cardId":"f6f0a98b-e077-4945-bd74-5ca4a60f970e",
"customerId":null,
"additionalData":{
},
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"creationDate":"2016-03-09T17:43:12.884+01:00",
"description":null,
"expirationMonth":12,
"expirationYear":2016,
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"first6":"461787",
"last4":"9012",
"merchantCardId":null
},
"clearingDate":null,
"country":null,
"creationDate":"2016-03-09T17:43:12.483+01:00",
"currency":"EUR",
"description":null,
"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":[
{
"refundId":"4882343c-5bb0-4133-8281-f4d605260d31",
"transactionId":"26286674-856a-42c2-875a-ca48ed7be306",
"additionalData":{
},
"amount":2000,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:12.997+01:00",
"description":null,
"merchantRefundId":"mon merchantRefundId",
"status":"UNCLEARED"
}
],
"source":"EC",
"3DS":false
},
{
"transactionId":"b146db85-3e8a-4167-a1a4-4c75ffc64f79",
"customerId":null,
"pointOfSaleId":"872ff5b9-7b66-4b4d-b18f-1287061244a2",
"contractId":"a6d95e35-2a4a-1572-63d5-696f3f9b742b",
"affiliatedMemberId":null,
"additionalData":{
},
"amount":2000,
"amountCaptured":2000,
"amountRefunded":2000,
"authorizationCancellationDate":null,
"authorizationCode":"318357",
"authorizationStatus":"SUCCESS",
"bankCode":"00",
"bankMessage":"Approved",
"captureCancellationDate":null,
"captureDate":"2016-03-09T17:43:07.933+01:00",
"captureStatus":"CLEARED",
"card":{
"cardId":"21be337b-723f-40a8-941e-14483b079fc3",
"customerId":null,
"additionalData":{
},
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"creationDate":"2016-03-09T17:43:08.295+01:00",
"description":null,
"expirationMonth":12,
"expirationYear":2016,
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"first6":"461787",
"last4":"9012",
"merchantCardId":null
},
"clearingDate":null,
"country":null,
"creationDate":"2016-03-09T17:43:07.934+01:00",
"currency":"EUR",
"description":null,
"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":[
{
"refundId":"31bd4508-b41c-40d2-ad61-3853994eb24a",
"transactionId":"b146db85-3e8a-4167-a1a4-4c75ffc64f79",
"additionalData":{
},
"amount":2000,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:08.406+01:00",
"description":"ces données concerne le remboursement",
"merchantRefundId":null,
"status":"UNCLEARED"
}
],
"source":"EC",
"3DS":false
},
{
"transactionId":"5fe45be8-13d9-42b5-90e4-30839bfda296",
"customerId":null,
"pointOfSaleId":"872ff5b9-7b66-4b4d-b18f-1287061244a2",
"contractId":"a6d95e35-2a4a-1572-63d5-696f3f9b742b",
"affiliatedMemberId":null,
"additionalData":{
},
"amount":2000,
"amountCaptured":2000,
"amountRefunded":0,
"authorizationCancellationDate":null,
"authorizationCode":"667413",
"authorizationStatus":"SUCCESS",
"bankCode":"00",
"bankMessage":"Approved",
"captureCancellationDate":null,
"captureDate":"2016-03-09T17:43:04.545+01:00",
"captureStatus":"CLEARED",
"card":{
"cardId":"ef9118ac-b21c-4aa0-91f8-6117cb831d3a",
"customerId":null,
"additionalData":{
},
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"creationDate":"2016-03-09T17:43:04.930+01:00",
"description":null,
"expirationMonth":12,
"expirationYear":2016,
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"first6":"461787",
"last4":"9012",
"merchantCardId":null
},
"clearingDate":null,
"country":null,
"creationDate":"2016-03-09T17:43:04.546+01:00",
"currency":"EUR",
"description":null,
"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
}
],
"totalCount":737
}
List transactions
This function allows you to search objects from a multi-criteria search.
« 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":"ebdb16be-75a2-4b3d-bf57-f390765c94ed",
"customerId":null,
"pointOfSaleId":"872ff5b9-7b66-4b4d-b18f-1287061244a2",
"contractId":"a6d95e35-2a4a-1572-63d5-696f3f9b742b",
"affiliatedMemberId":null,
"additionalData":{
},
"amount":2000,
"amountCaptured":2000,
"amountRefunded":2000,
"authorizationCancellationDate":null,
"authorizationCode":"161129",
"authorizationStatus":"SUCCESS",
"bankCode":"00",
"bankMessage":"Approved",
"captureCancellationDate":null,
"captureDate":"2016-03-09T17:43:24.636+01:00",
"captureStatus":"CLEARED",
"card":{
"cardId":"1930860f-1439-4252-ad1c-f91013fdc1ec",
"customerId":null,
"additionalData":{
},
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"creationDate":"2016-03-09T17:43:25.004+01:00",
"description":null,
"expirationMonth":12,
"expirationYear":2016,
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"first6":"461787",
"last4":"9012",
"merchantCardId":null
},
"clearingDate":null,
"country":null,
"creationDate":"2016-03-09T17:43:24.636+01:00",
"currency":"EUR",
"description":null,
"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":[
{
"refundId":"b2cc2ac5-d33e-4341-bbc0-91f2ba04dacb",
"transactionId":"ebdb16be-75a2-4b3d-bf57-f390765c94ed",
"additionalData":{
},
"amount":1536,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:28.963+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
},
{
"refundId":"28483cb3-01c7-49c7-9dee-55e9585ff6bc",
"transactionId":"ebdb16be-75a2-4b3d-bf57-f390765c94ed",
"additionalData":{
},
"amount":47,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:27.700+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
},
{
"refundId":"fcced231-3976-41b5-abb5-c896749f5e4b",
"transactionId":"ebdb16be-75a2-4b3d-bf57-f390765c94ed",
"additionalData":{
},
"amount":332,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:26.337+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
},
{
"refundId":"5ed69ed3-993a-43fd-8bad-923e37dc2100",
"transactionId":"ebdb16be-75a2-4b3d-bf57-f390765c94ed",
"additionalData":{
},
"amount":85,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:25.116+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
}
],
"source":"EC",
"3DS":false
},
{
"transactionId":"ab594f41-b78f-4b5f-a4e9-e4adfc173b9c",
"customerId":null,
"pointOfSaleId":"872ff5b9-7b66-4b4d-b18f-1287061244a2",
"contractId":"a6d95e35-2a4a-1572-63d5-696f3f9b742b",
"affiliatedMemberId":null,
"additionalData":{
},
"amount":2000,
"amountCaptured":2000,
"amountRefunded":1464,
"authorizationCancellationDate":null,
"authorizationCode":"292043",
"authorizationStatus":"SUCCESS",
"bankCode":"00",
"bankMessage":"Approved",
"captureCancellationDate":null,
"captureDate":"2016-03-09T17:43:16.840+01:00",
"captureStatus":"CLEARED",
"card":{
"cardId":"efc3395f-82db-45c1-9152-8135194b1d04",
"customerId":null,
"additionalData":{
},
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"creationDate":"2016-03-09T17:43:17.203+01:00",
"description":null,
"expirationMonth":12,
"expirationYear":2016,
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"first6":"461787",
"last4":"9012",
"merchantCardId":null
},
"clearingDate":null,
"country":null,
"creationDate":"2016-03-09T17:43:16.840+01:00",
"currency":"EUR",
"description":null,
"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":[
{
"refundId":"764c74f8-f883-4df6-b8e1-ae6efadca40a",
"transactionId":"ab594f41-b78f-4b5f-a4e9-e4adfc173b9c",
"additionalData":{
},
"amount":1047,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:20.276+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
},
{
"refundId":"cf86d43a-72fe-41c2-b608-1a46169bcd8a",
"transactionId":"ab594f41-b78f-4b5f-a4e9-e4adfc173b9c",
"additionalData":{
},
"amount":333,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:18.958+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
},
{
"refundId":"2502d31e-588a-4a30-b8b7-d4b743b4d0ee",
"transactionId":"ab594f41-b78f-4b5f-a4e9-e4adfc173b9c",
"additionalData":{
},
"amount":84,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:17.336+01:00",
"description":null,
"merchantRefundId":null,
"status":"UNCLEARED"
}
],
"source":"EC",
"3DS":false
},
{
"transactionId":"26286674-856a-42c2-875a-ca48ed7be306",
"customerId":null,
"pointOfSaleId":"872ff5b9-7b66-4b4d-b18f-1287061244a2",
"contractId":"a6d95e35-2a4a-1572-63d5-696f3f9b742b",
"affiliatedMemberId":null,
"additionalData":{
},
"amount":2000,
"amountCaptured":2000,
"amountRefunded":2000,
"authorizationCancellationDate":null,
"authorizationCode":"317238",
"authorizationStatus":"SUCCESS",
"bankCode":"00",
"bankMessage":"Approved",
"captureCancellationDate":null,
"captureDate":"2016-03-09T17:43:12.482+01:00",
"captureStatus":"CLEARED",
"card":{
"cardId":"f6f0a98b-e077-4945-bd74-5ca4a60f970e",
"customerId":null,
"additionalData":{
},
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"creationDate":"2016-03-09T17:43:12.884+01:00",
"description":null,
"expirationMonth":12,
"expirationYear":2016,
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"first6":"461787",
"last4":"9012",
"merchantCardId":null
},
"clearingDate":null,
"country":null,
"creationDate":"2016-03-09T17:43:12.483+01:00",
"currency":"EUR",
"description":null,
"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":[
{
"refundId":"4882343c-5bb0-4133-8281-f4d605260d31",
"transactionId":"26286674-856a-42c2-875a-ca48ed7be306",
"additionalData":{
},
"amount":2000,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:12.997+01:00",
"description":null,
"merchantRefundId":"mon merchantRefundId",
"status":"UNCLEARED"
}
],
"source":"EC",
"3DS":false
},
{
"transactionId":"b146db85-3e8a-4167-a1a4-4c75ffc64f79",
"customerId":null,
"pointOfSaleId":"872ff5b9-7b66-4b4d-b18f-1287061244a2",
"contractId":"a6d95e35-2a4a-1572-63d5-696f3f9b742b",
"affiliatedMemberId":null,
"additionalData":{
},
"amount":2000,
"amountCaptured":2000,
"amountRefunded":2000,
"authorizationCancellationDate":null,
"authorizationCode":"318357",
"authorizationStatus":"SUCCESS",
"bankCode":"00",
"bankMessage":"Approved",
"captureCancellationDate":null,
"captureDate":"2016-03-09T17:43:07.933+01:00",
"captureStatus":"CLEARED",
"card":{
"cardId":"21be337b-723f-40a8-941e-14483b079fc3",
"customerId":null,
"additionalData":{
},
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"creationDate":"2016-03-09T17:43:08.295+01:00",
"description":null,
"expirationMonth":12,
"expirationYear":2016,
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"first6":"461787",
"last4":"9012",
"merchantCardId":null
},
"clearingDate":null,
"country":null,
"creationDate":"2016-03-09T17:43:07.934+01:00",
"currency":"EUR",
"description":null,
"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":[
{
"refundId":"31bd4508-b41c-40d2-ad61-3853994eb24a",
"transactionId":"b146db85-3e8a-4167-a1a4-4c75ffc64f79",
"additionalData":{
},
"amount":2000,
"cancellationDate":null,
"clearingDate":null,
"creationDate":"2016-03-09T17:43:08.406+01:00",
"description":"ces données concerne le remboursement",
"merchantRefundId":null,
"status":"UNCLEARED"
}
],
"source":"EC",
"3DS":false
},
{
"transactionId":"5fe45be8-13d9-42b5-90e4-30839bfda296",
"customerId":null,
"pointOfSaleId":"872ff5b9-7b66-4b4d-b18f-1287061244a2",
"contractId":"a6d95e35-2a4a-1572-63d5-696f3f9b742b",
"affiliatedMemberId":null,
"additionalData":{
},
"amount":2000,
"amountCaptured":2000,
"amountRefunded":0,
"authorizationCancellationDate":null,
"authorizationCode":"667413",
"authorizationStatus":"SUCCESS",
"bankCode":"00",
"bankMessage":"Approved",
"captureCancellationDate":null,
"captureDate":"2016-03-09T17:43:04.545+01:00",
"captureStatus":"CLEARED",
"card":{
"cardId":"ef9118ac-b21c-4aa0-91f8-6117cb831d3a",
"customerId":null,
"additionalData":{
},
"cardholderEmail":null,
"cardholderName":null,
"commercialBrand":"VISA",
"country":null,
"creationDate":"2016-03-09T17:43:04.930+01:00",
"description":null,
"expirationMonth":12,
"expirationYear":2016,
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"first6":"461787",
"last4":"9012",
"merchantCardId":null
},
"clearingDate":null,
"country":null,
"creationDate":"2016-03-09T17:43:04.546+01:00",
"currency":"EUR",
"description":null,
"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
}
],
"totalCount":737
}
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.
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 |
| 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 |
| additionalData Object |
Merchant data Note: Contains keys/values |
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/card \
-u 'doctest:4I9HJRTd' \
-H Origin:https://www.centralpay.dev \
-d card[number]=4000000000000002 \
-d card[cvc]=123 \
-d card[expirationMonth]=12 \
-d card[expirationYear]=2018 \
-d card[holderName]='jdoe' \
-d customerId='59e2f51c-3cd7-4902-940a-2b7021fdafd2'
Back to JSON Format
{
"cardId":"22192513-663e-41e1-8427-58611494cecf",
"merchantCardId":null,
"creationDate":"2016-09-26T10:04:28.853+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":12,
"expirationYear":2018,
"country":null,
"cardholderName":"JDOE",
"cardholderEmail":null,
"description":null,
"customerId":"59e2f51c-3cd7-4902-940a-2b7021fdafd2",
"fingerprint":"748f88a2e25f1db08fa3074269a0587a675d970c",
"additionalData":{
},
"cardTokenId":null
}
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[*] - Required: yes - card[number]=string without any separators
|
| 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://www.centralpay.dev \
-d card[number]=4000000000000002 \
-d card[cvc]=123 \
-d card[expirationMonth]=12 \
-d card[expirationYear]=2018 \
-d card[holderName]='jdoe' \
-d customerId='59e2f51c-3cd7-4902-940a-2b7021fdafd2'
Back to JSON Format
{
"cardId":"22192513-663e-41e1-8427-58611494cecf",
"merchantCardId":null,
"creationDate":"2016-09-26T10:04:28.853+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":12,
"expirationYear":2018,
"country":null,
"cardholderName":"JDOE",
"cardholderEmail":null,
"description":null,
"customerId":"59e2f51c-3cd7-4902-940a-2b7021fdafd2",
"fingerprint":"748f88a2e25f1db08fa3074269a0587a675d970c",
"additionalData":{
},
"cardTokenId":null
}
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/card/22192513-663e-41e1-8427-58611494cecf \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"cardId":"22192513-663e-41e1-8427-58611494cecf",
"merchantCardId":null,
"creationDate":"2016-09-26T10:04:28.853+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":12,
"expirationYear":2018,
"country":null,
"cardholderName":"FDOUMAS",
"cardholderEmail":null,
"description":"ma description",
"customerId":"59e2f51c-3cd7-4902-940a-2b7021fdafd2",
"fingerprint":"748f88a2e25f1db08fa3074269a0587a67c9970c",
"additionalData":{
},
"cardTokenId":null
}
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/22192513-663e-41e1-8427-58611494cecf \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"cardId":"22192513-663e-41e1-8427-58611494cecf",
"merchantCardId":null,
"creationDate":"2016-09-26T10:04:28.853+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":12,
"expirationYear":2018,
"country":null,
"cardholderName":"FDOUMAS",
"cardholderEmail":null,
"description":"ma description",
"customerId":"59e2f51c-3cd7-4902-940a-2b7021fdafd2",
"fingerprint":"748f88a2e25f1db08fa3074269a0587a67c9970c",
"additionalData":{
},
"cardTokenId":null
}
Example of html code
curl -X GET -v https://test-api.centralpay.net/v2/rest/card/22192513-663e-41e1-8427-58611494cecf \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"cardId":"22192513-663e-41e1-8427-58611494cecf",
"merchantCardId":null,
"creationDate":"2016-09-26T10:04:28.853+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":12,
"expirationYear":2018,
"country":null,
"cardholderName":"doe",
"cardholderEmail":null,
"description":"ma description",
"customerId":"59e2f51c-3cd7-4902-940a-2b7021fdafd2",
"fingerprint":"748f88a2e25f1db08fa3074269a0587a67c9970c",
"additionalData":{
},
"cardTokenId":null
}
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/22192513-663e-41e1-8427-58611494cecf \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"cardId":"22192513-663e-41e1-8427-58611494cecf",
"merchantCardId":null,
"creationDate":"2016-09-26T10:04:28.853+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":12,
"expirationYear":2018,
"country":null,
"cardholderName":"doe",
"cardholderEmail":null,
"description":"ma description",
"customerId":"59e2f51c-3cd7-4902-940a-2b7021fdafd2",
"fingerprint":"748f88a2e25f1db08fa3074269a0587a67c9970c",
"additionalData":{
},
"cardTokenId":null
}
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":"4b8d3f2c-efb7-4573-bae1-a5ff6e5f8681",
"merchantCardId":null,
"creationDate":"2016-09-22T11:31:02.033+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"2cc5d3c5-d3ec-440f-bf50-6d18762c0b09",
"merchantCardId":null,
"creationDate":"2016-09-22T11:29:35.439+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"d56d5aca-28e6-4e3b-afa5-7d93fdc7d71c",
"merchantCardId":null,
"creationDate":"2016-09-22T11:09:51.711+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"849b9acb-64f3-4804-a3cd-9d94596e7208",
"merchantCardId":null,
"creationDate":"2016-09-22T11:05:20.396+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"c535d2a7-86a2-45a1-b36f-0b33a168ec0c",
"merchantCardId":null,
"creationDate":"2016-09-22T10:54:41.082+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"33ee519d-a54e-4ca5-a792-a3b85dccff5b",
"merchantCardId":null,
"creationDate":"2016-09-22T10:52:43.416+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":1,
"expirationYear":2018,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"7e192bd4cc6107f962185447b5305d676ef5bd47",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"e543ce69-0fa4-4a3c-9047-df095920aee6",
"merchantCardId":null,
"creationDate":"2016-09-22T10:44:18.818+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"93222940-9e78-4ac5-a177-15d08526dac9",
"merchantCardId":null,
"creationDate":"2016-09-22T10:33:37.415+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":12,
"expirationYear":2018,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"748f88a2e25f1db08fa3074269a0587a67c9970c",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"d77e2618-8825-4efe-9ab2-212e6f912454",
"merchantCardId":null,
"creationDate":"2016-09-22T10:03:20.958+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"e16aa8d1-7a62-48f3-b71a-0f7c9439624d",
"merchantCardId":null,
"creationDate":"2016-09-22T09:39:59.794+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
}
],
"totalCount":48272
}
List cards
This function allows you to search objects from a multi-criteria search.
« 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":"4b8d3f2c-efb7-4573-bae1-a5ff6e5f8681",
"merchantCardId":null,
"creationDate":"2016-09-22T11:31:02.033+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"2cc5d3c5-d3ec-440f-bf50-6d18762c0b09",
"merchantCardId":null,
"creationDate":"2016-09-22T11:29:35.439+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"d56d5aca-28e6-4e3b-afa5-7d93fdc7d71c",
"merchantCardId":null,
"creationDate":"2016-09-22T11:09:51.711+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"849b9acb-64f3-4804-a3cd-9d94596e7208",
"merchantCardId":null,
"creationDate":"2016-09-22T11:05:20.396+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"c535d2a7-86a2-45a1-b36f-0b33a168ec0c",
"merchantCardId":null,
"creationDate":"2016-09-22T10:54:41.082+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"33ee519d-a54e-4ca5-a792-a3b85dccff5b",
"merchantCardId":null,
"creationDate":"2016-09-22T10:52:43.416+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":1,
"expirationYear":2018,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"7e192bd4cc6107f962185447b5305d676ef5bd47",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"e543ce69-0fa4-4a3c-9047-df095920aee6",
"merchantCardId":null,
"creationDate":"2016-09-22T10:44:18.818+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"93222940-9e78-4ac5-a177-15d08526dac9",
"merchantCardId":null,
"creationDate":"2016-09-22T10:33:37.415+02:00",
"commercialBrand":"VISA",
"first6":"400000",
"last4":"0002",
"expirationMonth":12,
"expirationYear":2018,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"748f88a2e25f1db08fa3074269a0587a67c9970c",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"d77e2618-8825-4efe-9ab2-212e6f912454",
"merchantCardId":null,
"creationDate":"2016-09-22T10:03:20.958+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
},
{
"cardId":"e16aa8d1-7a62-48f3-b71a-0f7c9439624d",
"merchantCardId":null,
"creationDate":"2016-09-22T09:39:59.794+02:00",
"commercialBrand":"MASTERCARD",
"first6":"510000",
"last4":"0065",
"expirationMonth":10,
"expirationYear":2019,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":null,
"fingerprint":"88d5d21faa0f2f26bfc7ac49021a6a956c087108",
"additionalData":{
},
"cardTokenId":null
}
],
"totalCount":48272
}
Refund
Refund objects allow you to refund a processed transaction. The amount will be refunded to the debit/credit card used for the transaction.
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 |
| amount Integer |
Amount of the refund |
| description String |
Description |
| transactionId String (36) |
CentralPay transaction ID Note: UUID Format |
| 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 |
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/refund/ \
-u 'doctest:4I9HJRTd' \
-d transactionId=d0a2ff2b-3511-420b-80b5-7351e20ba2af
Back to JSON Format
{
"refundId":"53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd",
"merchantRefundId":null,
"creationDate":"2016-09-22T09:26:47.737+02:00",
"amount":1000,
"description":"Refund commande CMDd0a2ff2b",
"transactionId":"d0a2ff2b-3511-420b-80b5-7351e20ba2af",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
}
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=d0a2ff2b-3511-420b-80b5-7351e20ba2af
Back to JSON Format
{
"refundId":"53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd",
"merchantRefundId":null,
"creationDate":"2016-09-22T09:26:47.737+02:00",
"amount":1000,
"description":"Refund commande CMDd0a2ff2b",
"transactionId":"d0a2ff2b-3511-420b-80b5-7351e20ba2af",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
}
Example of html code
curl -v https://test-api.centralpay.net/v2/rest/refund/53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd \
-u 'doctest:4I9HJRTd' \
-d transactionId=d0a2ff2b-3511-420b-80b5-7351e20ba2af
Back to Json format
{
"refundId":"53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd",
"merchantRefundId":null,
"creationDate":"2016-09-22T09:26:47.737+02:00",
"amount":1000,
"description":"Refund commande CMD0045",
"transactionId":"d0a2ff2b-3511-420b-80b5-7351e20ba2af",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
}
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/53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd \
-u 'doctest:4I9HJRTd' \
-d transactionId=d0a2ff2b-3511-420b-80b5-7351e20ba2af
Back to Json format
{
"refundId":"53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd",
"merchantRefundId":null,
"creationDate":"2016-09-22T09:26:47.737+02:00",
"amount":1000,
"description":"Refund commande CMD0045",
"transactionId":"d0a2ff2b-3511-420b-80b5-7351e20ba2af",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
}
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/refund/53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"refundId":"53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd",
"merchantRefundId":null,
"creationDate":"2016-09-22T09:26:47.737+02:00",
"amount":1000,
"description":"Refund commande CMD0045",
"transactionId":"d0a2ff2b-3511-420b-80b5-7351e20ba2af",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
}
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 https://test-api.centralpay.net/v2/rest/refund/53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"refundId":"53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd",
"merchantRefundId":null,
"creationDate":"2016-09-22T09:26:47.737+02:00",
"amount":1000,
"description":"Refund commande CMD0045",
"transactionId":"d0a2ff2b-3511-420b-80b5-7351e20ba2af",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
}
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/refund/53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"refundId":"53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd",
"merchantRefundId":null,
"creationDate":"2016-09-22T09:26:47.737+02:00",
"amount":1000,
"description":"Refund commande CMD0045",
"transactionId":"d0a2ff2b-3511-420b-80b5-7351e20ba2af",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
}
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 -X GET -v https://test-api.centralpay.net/v2/rest/refund/53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"refundId":"53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd",
"merchantRefundId":null,
"creationDate":"2016-09-22T09:26:47.737+02:00",
"amount":1000,
"description":"Refund commande CMD0045",
"transactionId":"d0a2ff2b-3511-420b-80b5-7351e20ba2af",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
}
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":"53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd",
"merchantRefundId":null,
"creationDate":"2016-09-22T09:26:47.737+02:00",
"amount":1000,
"description":"Refund commande CMD0045",
"transactionId":"d0a2ff2b-3511-420b-80b5-7351e20ba2af",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"3b653812-4245-48db-8862-d19e0639d091",
"merchantRefundId":null,
"creationDate":"2016-09-21T17:33:28.485+02:00",
"amount":1523,
"description":null,
"transactionId":"1da9cb6b-46f3-4947-93d5-f9a8c17e105a",
"status":"CANCELED",
"clearingDate":null,
"cancellationDate":"2016-09-22T10:30:03.818+02:00",
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"d25ca02b-cffc-44ed-992a-7decfaf9edc1",
"merchantRefundId":null,
"creationDate":"2016-09-21T17:32:21.012+02:00",
"amount":2000,
"description":null,
"transactionId":"d1449a12-39a9-4fd9-acb0-bc9448c65cf8",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"63446fbe-a385-4258-9821-36200c5aa4d1",
"merchantRefundId":null,
"creationDate":"2016-09-21T17:01:16.023+02:00",
"amount":1523,
"description":null,
"transactionId":"58f46d16-aa0a-4f04-a5db-fd97d2f6cb2f",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"f19a34f4-62f1-475f-9a18-a7c0eb77ec1d",
"merchantRefundId":null,
"creationDate":"2016-09-21T17:00:08.782+02:00",
"amount":2000,
"description":null,
"transactionId":"0e712d23-210e-4328-948d-b342fa8038b2",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"0eac7646-d93b-485e-aa07-2edc2d658661",
"merchantRefundId":null,
"creationDate":"2016-09-12T18:41:48.519+02:00",
"amount":100,
"description":null,
"transactionId":"90f4abc8-4e92-47de-8b9a-53f0a17f073f",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"6e579355-b523-4270-9b60-63d4b7015b4b",
"merchantRefundId":null,
"creationDate":"2016-09-12T18:41:48.263+02:00",
"amount":100,
"description":null,
"transactionId":"90f4abc8-4e92-47de-8b9a-53f0a17f073f",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"5313e57f-fafc-4c7b-9d02-21996d12d28b",
"merchantRefundId":null,
"creationDate":"2016-09-12T18:41:47.847+02:00",
"amount":100,
"description":null,
"transactionId":"90f4abc8-4e92-47de-8b9a-53f0a17f073f",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"5b8cdab9-acdc-49c2-8a4f-f359949c2f0b",
"merchantRefundId":null,
"creationDate":"2016-09-12T18:41:47.607+02:00",
"amount":100,
"description":null,
"transactionId":"90f4abc8-4e92-47de-8b9a-53f0a17f073f",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"7f1ffd85-921b-43d1-a9b4-f8c9cd2aef54",
"merchantRefundId":null,
"creationDate":"2016-09-12T18:41:47.354+02:00",
"amount":100,
"description":null,
"transactionId":"90f4abc8-4e92-47de-8b9a-53f0a17f073f",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
}
],
"totalCount":9810
}
List refunds
This function allows you to search objects from a multi-criteria search.
« Refund » specific parameters
| merchantRefundId String (100) |
Merchant ID Required: no Validation: .{0,100} |
| status String |
Refund status Required: no Validation: UNCLEARED | CLEARED | CANCELED |
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":"53eebaf4-c4e1-4b5a-a544-ab0ae8e095fd",
"merchantRefundId":null,
"creationDate":"2016-09-22T09:26:47.737+02:00",
"amount":1000,
"description":"Refund commande CMD0045",
"transactionId":"d0a2ff2b-3511-420b-80b5-7351e20ba2af",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"3b653812-4245-48db-8862-d19e0639d091",
"merchantRefundId":null,
"creationDate":"2016-09-21T17:33:28.485+02:00",
"amount":1523,
"description":null,
"transactionId":"1da9cb6b-46f3-4947-93d5-f9a8c17e105a",
"status":"CANCELED",
"clearingDate":null,
"cancellationDate":"2016-09-22T10:30:03.818+02:00",
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"d25ca02b-cffc-44ed-992a-7decfaf9edc1",
"merchantRefundId":null,
"creationDate":"2016-09-21T17:32:21.012+02:00",
"amount":2000,
"description":null,
"transactionId":"d1449a12-39a9-4fd9-acb0-bc9448c65cf8",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"63446fbe-a385-4258-9821-36200c5aa4d1",
"merchantRefundId":null,
"creationDate":"2016-09-21T17:01:16.023+02:00",
"amount":1523,
"description":null,
"transactionId":"58f46d16-aa0a-4f04-a5db-fd97d2f6cb2f",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"f19a34f4-62f1-475f-9a18-a7c0eb77ec1d",
"merchantRefundId":null,
"creationDate":"2016-09-21T17:00:08.782+02:00",
"amount":2000,
"description":null,
"transactionId":"0e712d23-210e-4328-948d-b342fa8038b2",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"0eac7646-d93b-485e-aa07-2edc2d658661",
"merchantRefundId":null,
"creationDate":"2016-09-12T18:41:48.519+02:00",
"amount":100,
"description":null,
"transactionId":"90f4abc8-4e92-47de-8b9a-53f0a17f073f",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"6e579355-b523-4270-9b60-63d4b7015b4b",
"merchantRefundId":null,
"creationDate":"2016-09-12T18:41:48.263+02:00",
"amount":100,
"description":null,
"transactionId":"90f4abc8-4e92-47de-8b9a-53f0a17f073f",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"5313e57f-fafc-4c7b-9d02-21996d12d28b",
"merchantRefundId":null,
"creationDate":"2016-09-12T18:41:47.847+02:00",
"amount":100,
"description":null,
"transactionId":"90f4abc8-4e92-47de-8b9a-53f0a17f073f",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"5b8cdab9-acdc-49c2-8a4f-f359949c2f0b",
"merchantRefundId":null,
"creationDate":"2016-09-12T18:41:47.607+02:00",
"amount":100,
"description":null,
"transactionId":"90f4abc8-4e92-47de-8b9a-53f0a17f073f",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
},
{
"refundId":"7f1ffd85-921b-43d1-a9b4-f8c9cd2aef54",
"merchantRefundId":null,
"creationDate":"2016-09-12T18:41:47.354+02:00",
"amount":100,
"description":null,
"transactionId":"90f4abc8-4e92-47de-8b9a-53f0a17f073f",
"status":"UNCLEARED",
"clearingDate":null,
"cancellationDate":null,
"additionalData":{
},
"breakdownPerSubMerchant":[
]
}
],
"totalCount":9810
}
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.
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 |
| cards Array of Card object |
Cards Note: See Json "Card" object |
| description String |
Description |
| additionalData Object |
Merchant data Note: Contains keys/values |
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":"0881e6a3-f287-4e39-bdca-6c7957c0c170",
"creationDate":"2016-09-22T15:37:33.794+02:00",
"additionalData":{
},
"addressLine1":"17 RUE DE LA POSTE",
"addressLine2":"APPT 51",
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"b20fc4e9-0b23-4d57-bebf-576ffbf746ab",
"merchantCardId":null,
"creationDate":"2016-09-22T15:33:46.156+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"0881e6a3-f287-4e39-bdca-6c7957c0c170",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":"3f2cc44d-e7c1-4e18-a510-17cf9a33ce33"
}
],
"city":"TOURS",
"country":"250",
"description":null,
"email":"john.doe@gmail.com",
"firstName":"JOHN",
"lastName":"DOE",
"merchantCustomerId":"Client-0001",
"phone":null,
"postalCode":"37000"
}
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} |
| 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":"0881e6a3-f287-4e39-bdca-6c7957c0c170",
"creationDate":"2016-09-22T15:37:33.794+02:00",
"additionalData":{
},
"addressLine1":"17 RUE DE LA POSTE",
"addressLine2":"APPT 51",
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"b20fc4e9-0b23-4d57-bebf-576ffbf746ab",
"merchantCardId":null,
"creationDate":"2016-09-22T15:33:46.156+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"0881e6a3-f287-4e39-bdca-6c7957c0c170",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":"3f2cc44d-e7c1-4e18-a510-17cf9a33ce33"
}
],
"city":"TOURS",
"country":"250",
"description":null,
"email":"john.doe@gmail.com",
"firstName":"JOHN",
"lastName":"DOE",
"merchantCustomerId":"Client-0001",
"phone":null,
"postalCode":"37000"
}
Example of curl code
curl -X POST -v https://test-api.centralpay.net/v2/rest/customer/07fb877c-b382-4f0a-9e75-2fe6ff68c13e \
-u 'doctest:4I9HJRTd' \
-d adressLine1='24 avenue de la promenade'
Back to Json format
{
"customerId":"07fb877c-b382-4f0a-9e75-2fe6ff68c13e",
"creationDate":"2016-09-22T12:09:43.448+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"8352ca31-e884-4207-bf46-f663abf22fb5",
"merchantCardId":null,
"creationDate":"2016-09-22T12:09:44.169+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"07fb877c-b382-4f0a-9e75-2fe6ff68c13e",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":null,
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
}
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} |
| 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/07fb877c-b382-4f0a-9e75-2fe6ff68c13e \
-u 'doctest:4I9HJRTd' \
-d adressLine1='24 avenue de la promenade'
Back to Json format
{
"customerId":"07fb877c-b382-4f0a-9e75-2fe6ff68c13e",
"creationDate":"2016-09-22T12:09:43.448+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"8352ca31-e884-4207-bf46-f663abf22fb5",
"merchantCardId":null,
"creationDate":"2016-09-22T12:09:44.169+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"07fb877c-b382-4f0a-9e75-2fe6ff68c13e",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":null,
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
}
Example of curl code
curl -X GET -v https://test-api.centralpay.net/v2/rest/customer/07fb877c-b382-4f0a-9e75-2fe6ff68c13e \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"customerId":"07fb877c-b382-4f0a-9e75-2fe6ff68c13e",
"creationDate":"2016-09-22T12:09:43.448+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"8352ca31-e884-4207-bf46-f663abf22fb5",
"merchantCardId":null,
"creationDate":"2016-09-22T12:09:44.169+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"07fb877c-b382-4f0a-9e75-2fe6ff68c13e",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":null,
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
}
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/07fb877c-b382-4f0a-9e75-2fe6ff68c13e \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"customerId":"07fb877c-b382-4f0a-9e75-2fe6ff68c13e",
"creationDate":"2016-09-22T12:09:43.448+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"8352ca31-e884-4207-bf46-f663abf22fb5",
"merchantCardId":null,
"creationDate":"2016-09-22T12:09:44.169+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"07fb877c-b382-4f0a-9e75-2fe6ff68c13e",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":null,
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
}
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/customer \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list":[
{
"customerId":"89919c45-eb6d-4a22-b328-58094fb1ff54",
"creationDate":"2016-09-21T17:33:01.613+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"b2fd7d44-0842-499e-9127-224ec4c7df27",
"merchantCardId":null,
"creationDate":"2016-09-21T17:33:02.489+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"89919c45-eb6d-4a22-b328-58094fb1ff54",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":null,
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"92998711-cab1-46c2-8c42-776c6de5f359",
"creationDate":"2016-09-21T17:32:00.474+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"9e4ccabe-01e4-403f-9b0a-b81f5fec8555",
"merchantCardId":null,
"creationDate":"2016-09-21T17:32:01.203+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"92998711-cab1-46c2-8c42-776c6de5f359",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"merchant1@merchant1.fr",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"05858869-9716-4888-a2bb-acf098bbe889",
"creationDate":"2016-09-21T17:31:59.034+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"0539753d-9e96-4dd5-b932-b8ed8c8abdd0",
"merchantCardId":null,
"creationDate":"2016-09-21T17:32:00.120+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"05858869-9716-4888-a2bb-acf098bbe889",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"merchant1@hakers.eu",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"a9809d76-28a5-4700-8c99-a7c8be6cd00f",
"creationDate":"2016-09-21T17:31:57.836+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"bd65f334-9d24-4bd7-bffa-dfb5f6d560db",
"merchantCardId":null,
"creationDate":"2016-09-21T17:31:58.550+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"a9809d76-28a5-4700-8c99-a7c8be6cd00f",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"agent1@agent1.com",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"22572530-06cb-4b00-bd7f-aa929dc0b466",
"creationDate":"2016-09-21T17:31:56.396+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"0eb8fe14-5f76-4010-8db2-cd448d743622",
"merchantCardId":null,
"creationDate":"2016-09-21T17:31:57.098+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"22572530-06cb-4b00-bd7f-aa929dc0b466",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"agent1@hakers.fr",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"c7edae13-e489-4fdd-b447-7230eea5ac5d",
"creationDate":"2016-09-21T17:31:55.008+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"c898a3b1-52dd-480d-8d0f-b84bc43cdc0c",
"merchantCardId":null,
"creationDate":"2016-09-21T17:31:55.715+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"c7edae13-e489-4fdd-b447-7230eea5ac5d",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"ef1@ef1.com",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"ff81c44d-9597-462b-8fcf-684f5a561e90",
"creationDate":"2016-09-21T17:31:53.991+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"b1119ba5-7656-4cf3-817f-995a14f0a0f6",
"merchantCardId":null,
"creationDate":"2016-09-21T17:31:54.693+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"ff81c44d-9597-462b-8fcf-684f5a561e90",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"ef1@hakers.com",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"5c4ab12f-c675-4fe7-afe9-63331f63b094",
"creationDate":"2016-09-21T17:31:52.689+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"71e8c4f2-c965-4389-b5f8-905e4d0163a2",
"merchantCardId":null,
"creationDate":"2016-09-21T17:31:53.601+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"5c4ab12f-c675-4fe7-afe9-63331f63b094",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"hakers@hakers.com",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"d0d3f00e-25de-4293-b265-c06db9f78cee",
"creationDate":"2016-09-21T17:30:35.087+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"9333a216-919d-427c-b9ba-857b219195e4",
"merchantCardId":null,
"creationDate":"2016-09-21T17:30:36.018+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"d0d3f00e-25de-4293-b265-c06db9f78cee",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":null,
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"742edfe4-0edd-4821-ad41-2bf4fbdc7464",
"creationDate":"2016-09-21T17:30:11.979+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"0b51d65a-f43b-45d8-988c-28870eaea961",
"merchantCardId":null,
"creationDate":"2016-09-21T17:30:12.716+02:00",
"commercialBrand":"VISA",
"first6":"402400",
"last4":"5481",
"expirationMonth":12,
"expirationYear":2020,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"742edfe4-0edd-4821-ad41-2bf4fbdc7464",
"fingerprint":"af3881c681438838ddf7d4de133293f4c4c03852",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":null,
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
}
],
"totalCount":11867
}
List customers
This function allows you to search objects from a multi-criteria search.
« 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 \
-u 'doctest:4I9HJRTd'
Back to Json format
{
"list":[
{
"customerId":"89919c45-eb6d-4a22-b328-58094fb1ff54",
"creationDate":"2016-09-21T17:33:01.613+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"b2fd7d44-0842-499e-9127-224ec4c7df27",
"merchantCardId":null,
"creationDate":"2016-09-21T17:33:02.489+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"89919c45-eb6d-4a22-b328-58094fb1ff54",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":null,
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"92998711-cab1-46c2-8c42-776c6de5f359",
"creationDate":"2016-09-21T17:32:00.474+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"9e4ccabe-01e4-403f-9b0a-b81f5fec8555",
"merchantCardId":null,
"creationDate":"2016-09-21T17:32:01.203+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"92998711-cab1-46c2-8c42-776c6de5f359",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"merchant1@merchant1.fr",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"05858869-9716-4888-a2bb-acf098bbe889",
"creationDate":"2016-09-21T17:31:59.034+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"0539753d-9e96-4dd5-b932-b8ed8c8abdd0",
"merchantCardId":null,
"creationDate":"2016-09-21T17:32:00.120+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"05858869-9716-4888-a2bb-acf098bbe889",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"merchant1@hakers.eu",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"a9809d76-28a5-4700-8c99-a7c8be6cd00f",
"creationDate":"2016-09-21T17:31:57.836+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"bd65f334-9d24-4bd7-bffa-dfb5f6d560db",
"merchantCardId":null,
"creationDate":"2016-09-21T17:31:58.550+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"a9809d76-28a5-4700-8c99-a7c8be6cd00f",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"agent1@agent1.com",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"22572530-06cb-4b00-bd7f-aa929dc0b466",
"creationDate":"2016-09-21T17:31:56.396+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"0eb8fe14-5f76-4010-8db2-cd448d743622",
"merchantCardId":null,
"creationDate":"2016-09-21T17:31:57.098+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"22572530-06cb-4b00-bd7f-aa929dc0b466",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"agent1@hakers.fr",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"c7edae13-e489-4fdd-b447-7230eea5ac5d",
"creationDate":"2016-09-21T17:31:55.008+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"c898a3b1-52dd-480d-8d0f-b84bc43cdc0c",
"merchantCardId":null,
"creationDate":"2016-09-21T17:31:55.715+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"c7edae13-e489-4fdd-b447-7230eea5ac5d",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"ef1@ef1.com",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"ff81c44d-9597-462b-8fcf-684f5a561e90",
"creationDate":"2016-09-21T17:31:53.991+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"b1119ba5-7656-4cf3-817f-995a14f0a0f6",
"merchantCardId":null,
"creationDate":"2016-09-21T17:31:54.693+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"ff81c44d-9597-462b-8fcf-684f5a561e90",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"ef1@hakers.com",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"5c4ab12f-c675-4fe7-afe9-63331f63b094",
"creationDate":"2016-09-21T17:31:52.689+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"71e8c4f2-c965-4389-b5f8-905e4d0163a2",
"merchantCardId":null,
"creationDate":"2016-09-21T17:31:53.601+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"5c4ab12f-c675-4fe7-afe9-63331f63b094",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":"hakers@hakers.com",
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"d0d3f00e-25de-4293-b265-c06db9f78cee",
"creationDate":"2016-09-21T17:30:35.087+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"9333a216-919d-427c-b9ba-857b219195e4",
"merchantCardId":null,
"creationDate":"2016-09-21T17:30:36.018+02:00",
"commercialBrand":"VISA",
"first6":"461787",
"last4":"9012",
"expirationMonth":12,
"expirationYear":2016,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"d0d3f00e-25de-4293-b265-c06db9f78cee",
"fingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":null,
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
},
{
"customerId":"742edfe4-0edd-4821-ad41-2bf4fbdc7464",
"creationDate":"2016-09-21T17:30:11.979+02:00",
"additionalData":{
},
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"addressLine4":null,
"cards":[
{
"cardId":"0b51d65a-f43b-45d8-988c-28870eaea961",
"merchantCardId":null,
"creationDate":"2016-09-21T17:30:12.716+02:00",
"commercialBrand":"VISA",
"first6":"402400",
"last4":"5481",
"expirationMonth":12,
"expirationYear":2020,
"country":null,
"cardholderName":null,
"cardholderEmail":null,
"description":null,
"customerId":"742edfe4-0edd-4821-ad41-2bf4fbdc7464",
"fingerprint":"af3881c681438838ddf7d4de133293f4c4c03852",
"additionalData":{
},
"cardTokenId":null
}
],
"city":null,
"country":null,
"description":null,
"email":null,
"firstName":null,
"lastName":null,
"merchantCustomerId":null,
"phone":null,
"postalCode":null
}
],
"totalCount":11867
}
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.
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 |
| 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 |
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=84846387-b744-4913-9f91-d77c2abe5e4a \
-d merchantDisputeId=REF_561 \
-d disputeDate=2017-01-04 \
-d amount=300 \
-d reason=FRAUDULENT \
-d status=RETRIEVAL_NOTICED \
-d evidencesDeadline=2017-02-07 \
-d description='Chargeback 01'Back to JSON Format
{
"disputeId":"0fb483bb-7317-48ad-82a7-3146df0bb0d0",
"merchantDisputeId":"REF_561",
"creationDate":"2017-01-04T17:24:21.792+01:00",
"transactionId":"84846387-b744-4913-9f91-d77c2abe5e4a",
"disputeDate":"2017-01-04",
"description":"Chargeback 01",
"amount":300,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"RETRIEVAL_NOTICED",
"evidencesDeadline":"2017-02-07",
"additionalData":{
}
}Create a dispute
This function allows you to create a dispute.
| 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=84846387-b744-4913-9f91-d77c2abe5e4a \
-d merchantDisputeId=REF_561 \
-d disputeDate=2017-01-04 \
-d amount=300 \
-d reason=FRAUDULENT \
-d status=RETRIEVAL_NOTICED \
-d evidencesDeadline=2017-02-07 \
-d description='Chargeback 01'Back to JSON Format
{
"disputeId":"0fb483bb-7317-48ad-82a7-3146df0bb0d0",
"merchantDisputeId":"REF_561",
"creationDate":"2017-01-04T17:24:21.792+01:00",
"transactionId":"84846387-b744-4913-9f91-d77c2abe5e4a",
"disputeDate":"2017-01-04",
"description":"Chargeback 01",
"amount":300,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"RETRIEVAL_NOTICED",
"evidencesDeadline":"2017-02-07",
"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/0fb483bb-7317-48ad-82a7-3146df0bb0d0 \
-u 'doctest:4I9HJRTd'
-d description='Chargeback 01 - Ref005' \
-d status=CHARGEBACK_NOTICEDBack to Json format
{
"disputeId":"0fb483bb-7317-48ad-82a7-3146df0bb0d0",
"merchantDisputeId":"REF_561",
"creationDate":"2017-01-04T17:24:21.792+01:00",
"transactionId":"84846387-b744-4913-9f91-d77c2abe5e4a",
"disputeDate":"2017-01-04",
"description":"Chargeback 01 - Ref005",
"amount":300,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":"2017-02-07",
"additionalData":{
}
}Update a dispute
This function allows you to update the information and status of the dispute with the dispute ID.
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/0fb483bb-7317-48ad-82a7-3146df0bb0d0 \
-u 'doctest:4I9HJRTd'
-d description='Chargeback 01 - Ref005' \
-d status=CHARGEBACK_NOTICEDBack to Json format
{
"disputeId":"0fb483bb-7317-48ad-82a7-3146df0bb0d0",
"merchantDisputeId":"REF_561",
"creationDate":"2017-01-04T17:24:21.792+01:00",
"transactionId":"84846387-b744-4913-9f91-d77c2abe5e4a",
"disputeDate":"2017-01-04",
"description":"Chargeback 01 - Ref005",
"amount":300,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":"2017-02-07",
"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/0fb483bb-7317-48ad-82a7-3146df0bb0d0 \
-u 'doctest:4I9HJRTd'
{
"disputeId":"0fb483bb-7317-48ad-82a7-3146df0bb0d0",
"merchantDisputeId":"REF_561",
"creationDate":"2017-01-04T17:24:21.792+01:00",
"transactionId":"84846387-b744-4913-9f91-d77c2abe5e4a",
"disputeDate":"2017-01-04",
"description":"Chargeback 01 - Ref005",
"amount":300,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":"2017-02-07",
"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/0fb483bb-7317-48ad-82a7-3146df0bb0d0 \
-u 'doctest:4I9HJRTd'
{
"disputeId":"0fb483bb-7317-48ad-82a7-3146df0bb0d0",
"merchantDisputeId":"REF_561",
"creationDate":"2017-01-04T17:24:21.792+01:00",
"transactionId":"84846387-b744-4913-9f91-d77c2abe5e4a",
"disputeDate":"2017-01-04",
"description":"Chargeback 01 - Ref005",
"amount":300,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":"2017-02-07",
"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":"0fb483bb-7317-48ad-82a7-3146df0bb0d0",
"merchantDisputeId":"REF_561",
"creationDate":"2017-01-04T17:24:21.792+01:00",
"transactionId":"84846387-b744-4913-9f91-d77c2abe5e4a",
"disputeDate":"2017-01-04",
"description":"updateDescription",
"amount":300,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":"2017-02-07",
"additionalData":{
}
},
{
"disputeId":"13e62fc1-0ebb-4f5a-a7b2-f090dc1e02bc",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:29:12.726+01:00",
"transactionId":"e51333ad-66e5-49b1-ad80-ecfcde47c6fb",
"disputeDate":"2017-01-02",
"description":null,
"amount":2300,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
}
},
{
"disputeId":"d3c560fd-0c8e-4308-b925-ba0e95b4c4b7",
"merchantDisputeId":"REFfmi01",
"creationDate":"2017-01-02T17:16:48.837+01:00",
"transactionId":"a178a6d6-4eb1-4d05-b30f-b16770fa4562",
"disputeDate":"2017-01-02",
"description":"Création contestation pour le client 1",
"amount":5643,
"currency":"EUR",
"reason":"DUPLICATE",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":"2017-01-02",
"additionalData":{
"premium":"true",
"count":"1"
}
},
{
"disputeId":"6cedce45-c3d3-479e-98e2-63dc421372d5",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:50.322+01:00",
"transactionId":"c872b907-b4f2-4a35-b5a5-45de8438fb99",
"disputeDate":"2017-01-02",
"description":null,
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
}
},
{
"disputeId":"326c0ccf-b3a4-42e3-90e2-63589f13d6d1",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:41.120+01:00",
"transactionId":"6151236d-ea84-4ed0-952c-be3bac7bad23",
"disputeDate":"2017-01-02",
"description":null,
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
"testCreateAdd":"testCreateAdd"
}
},
{
"disputeId":"6ecdcfc1-0f11-4187-87ea-fd6da507707c",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:35.082+01:00",
"transactionId":"1b66b64a-de22-418a-b242-2d2890570e4d",
"disputeDate":"2017-01-02",
"description":null,
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
"testCreateAdd":"testCreateAdd"
}
},
{
"disputeId":"00e4a87c-76e2-4f55-8fc4-f8b87d1c7e73",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:33.159+01:00",
"transactionId":"53361e87-bc71-4bbe-9c27-ce90b1fdbe0a",
"disputeDate":"2017-01-02",
"description":"createTestfmi",
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
}
},
{
"disputeId":"de1b2c19-6ff2-4ed9-aed0-cc7ecfe2b4e2",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:31.652+01:00",
"transactionId":"0f158e36-5500-4e67-8a3c-9e7900ccd25a",
"disputeDate":"2017-01-02",
"description":null,
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
}
},
{
"disputeId":"b1c47ac3-295f-464b-a431-37ee47a0d73c",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:30.570+01:00",
"transactionId":"aaff9ca2-d825-4fbb-908b-21a9aa383b75",
"disputeDate":"2017-01-02",
"description":null,
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
}
},
{
"disputeId":"93eab4dd-24cf-4f0b-a473-5ba8453803d6",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:29.222+01:00",
"transactionId":"0a0f7b96-3285-4213-a3e8-7ce91c3ab0e9",
"disputeDate":"2017-01-02",
"description":null,
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
}
}
],
"totalCount":764
}List disputes
This function allows you to search objects from a multi-criteria search.
« Dispute » specific parameters
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":"0fb483bb-7317-48ad-82a7-3146df0bb0d0",
"merchantDisputeId":"REF_561",
"creationDate":"2017-01-04T17:24:21.792+01:00",
"transactionId":"84846387-b744-4913-9f91-d77c2abe5e4a",
"disputeDate":"2017-01-04",
"description":"updateDescription",
"amount":300,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":"2017-02-07",
"additionalData":{
}
},
{
"disputeId":"13e62fc1-0ebb-4f5a-a7b2-f090dc1e02bc",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:29:12.726+01:00",
"transactionId":"e51333ad-66e5-49b1-ad80-ecfcde47c6fb",
"disputeDate":"2017-01-02",
"description":null,
"amount":2300,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
}
},
{
"disputeId":"d3c560fd-0c8e-4308-b925-ba0e95b4c4b7",
"merchantDisputeId":"REFfmi01",
"creationDate":"2017-01-02T17:16:48.837+01:00",
"transactionId":"a178a6d6-4eb1-4d05-b30f-b16770fa4562",
"disputeDate":"2017-01-02",
"description":"Création contestation pour le client 1",
"amount":5643,
"currency":"EUR",
"reason":"DUPLICATE",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":"2017-01-02",
"additionalData":{
"premium":"true",
"count":"1"
}
},
{
"disputeId":"6cedce45-c3d3-479e-98e2-63dc421372d5",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:50.322+01:00",
"transactionId":"c872b907-b4f2-4a35-b5a5-45de8438fb99",
"disputeDate":"2017-01-02",
"description":null,
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
}
},
{
"disputeId":"326c0ccf-b3a4-42e3-90e2-63589f13d6d1",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:41.120+01:00",
"transactionId":"6151236d-ea84-4ed0-952c-be3bac7bad23",
"disputeDate":"2017-01-02",
"description":null,
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
"testCreateAdd":"testCreateAdd"
}
},
{
"disputeId":"6ecdcfc1-0f11-4187-87ea-fd6da507707c",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:35.082+01:00",
"transactionId":"1b66b64a-de22-418a-b242-2d2890570e4d",
"disputeDate":"2017-01-02",
"description":null,
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
"testCreateAdd":"testCreateAdd"
}
},
{
"disputeId":"00e4a87c-76e2-4f55-8fc4-f8b87d1c7e73",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:33.159+01:00",
"transactionId":"53361e87-bc71-4bbe-9c27-ce90b1fdbe0a",
"disputeDate":"2017-01-02",
"description":"createTestfmi",
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
}
},
{
"disputeId":"de1b2c19-6ff2-4ed9-aed0-cc7ecfe2b4e2",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:31.652+01:00",
"transactionId":"0f158e36-5500-4e67-8a3c-9e7900ccd25a",
"disputeDate":"2017-01-02",
"description":null,
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
}
},
{
"disputeId":"b1c47ac3-295f-464b-a431-37ee47a0d73c",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:30.570+01:00",
"transactionId":"aaff9ca2-d825-4fbb-908b-21a9aa383b75",
"disputeDate":"2017-01-02",
"description":null,
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
}
},
{
"disputeId":"93eab4dd-24cf-4f0b-a473-5ba8453803d6",
"merchantDisputeId":null,
"creationDate":"2017-01-02T17:15:29.222+01:00",
"transactionId":"0a0f7b96-3285-4213-a3e8-7ce91c3ab0e9",
"disputeDate":"2017-01-02",
"description":null,
"amount":1265,
"currency":"EUR",
"reason":"FRAUDULENT",
"status":"CHARGEBACK_NOTICED",
"evidencesDeadline":null,
"additionalData":{
}
}
],
"totalCount":764
}Payment Claim
A Paymentclaim is a request that is addressed by email or SMS to a customer to settle a transaction.
Payment claim object description
|
paymentClaimId UUID |
Payment Claim ID |
| merchantPaymentClaimId String |
Merchant Payment Claim ID |
| creationDate OffsetDateTime |
Creation Date |
| pointOfSaleId UUID |
Point Of Sale ID
|
| contractId UUID |
Contract ID |
|
description String |
Description
|
| currency String |
Currency Prefered format |
| amount Integer |
Amount
|
| customerId UUID |
Customer ID
|
|
language String |
Language used in the claim 639-2 ISO Format (3 carac) |
|
String |
Email used for the claim
|
|
phone String |
Phone number used for the claim
|
|
provider Enum PaymentClaimProvider |
SMS or email
|
|
deadLine Enum PaymentClaimProvider |
LocalDate |
|
entered Enum PaymentClaimProvider |
OffsetDateTime |
|
lastEnteringDate Enum PaymentClaimProvider |
Boolean
|
|
paymentAttempted Enum PaymentClaimProvider |
OffsetDateTime
|
|
lastPaymentAttempt Enum PaymentClaimProvider |
OffsetDateTime |
|
paid Enum PaymentClaimProvider |
Boolean
|
|
lastNotificationDate Enum PaymentClaimProvider |
OffsetDateTime
|
|
additionalData[*] Enum PaymentClaimProvider |
Map
|
|
specificAttributes Enum PaymentClaimProvider |
|
|
type Enum PaymentClaimProvider |
Payment Claim type TRANSACTION |
|
merchantTransactionId String |
Merchant transaction ID
|
|
createCustomer Boolean |
Create a Customer
|
|
fixedAmount Boolean |
Fixed amount
|
|
minAmount Integer |
Minimum amount
|
|
transactions List<UUID> |
ID transaction list
|
HTTP Response
Object JSON Transaction Claim Type
Create a transaction claim
POST /paymentClaim/transactionClaim
|
merchantPaymentClaimId String |
merchant ID of the payment claim .{0,100} |
| pointOfSaleId PointOfSale |
POS ID
By default the POS by default of the user UUID |
| contractId Contract |
Contrat IDRequired: yes |
| description String |
Description .{0,256} |
| currency Currency |
Currency ISO4217 alpha or num format |
|
amount Integer |
Amount In cents > 0 et <= 999999999 |
|
customerId Customer |
Customer ID If does not get thru, payment will be done with a token UUID |
| language Language |
Language used in the claim By default the customer language (if present) ISO 639-2 (3 carac) or ISO 639-1 (2 carac) |
| email String |
Email for claim sending By default customer email (if present) |
| phone String |
phone number for claim sending By default customer phone number (if present) Global format : \\+[0-9]{1,15} |
| provider Enum PaymentClaimProvider |
Sending type EMAIL | SMS To check the email or phone presence depending on the provider value |
| deadline LocalDate |
Deadline payment tomorrow or after |
|
sendingDate OffsetDateTime |
Sending date Now by default ISO Date |
|
additionalData[*] String |
Merchant data .{0,100} |
|
createCustomer Boolean |
Create a Customer Need to be false if the merchant does not have the OC option |
|
fixedAmount Boolean |
Fixed amount
|
|
minAmount Integer |
Minimum amount fixedAmount need to be false |
HTTP Response
Object JSON Transaction Claim Type
Update a transaction claim
POST /paymentClaim/<paymentClaimId>
|
paymentClaimId (URL) PaymentClaim |
Payment claim ID UUID Existing Belonged to the merchant |
| merchantPaymentClaimId String |
Merchant Paymant Claim ID
.{0,100} |
|
language Language |
Language used in the claimISO 639-2 (3 carac) or ISO 639-1 (2 carac) Existing |
|
String |
Email for the claim sending |
|
phone String |
phone number for the claim sending Global format : \\+[0-9]{1,15} |
|
provider Enum PaymentClaimProvider |
Sending type To check the email or phone number presence depending on the provider value |
|
additionalData[*] String |
Merchant data Key : .{45} |
Object JSON Resend notification claim type
Resend a payment claim notification
POST /paymentClaim/<paymentClaimId>/sendNotification
|
paymentClaimId (URL) PaymentClaim |
Payment Claim IDUUID Existing Belonged to the merchant |
Object JSON Resend notification claim type
Object JSON Retrieve transaction claim type
Retrieve a transaction claim
GET /paymentClaim/<paymentClaimId>
|
paymentClaimId (URL) PaymentClaim |
Payment Claim ID UUID Existing BElonged to the merchant |
Object JSON Retrieve transaction claim type
Object Json payment claim list type
Payment claim list
GET /paymentClaim return
|
merchantPaymentClaimId String |
Merchant Payment Claim ID .{0,100} |
| paid Boolean |
Paid
|
Object Json payment claim list type
Payment Request
Simple payment request
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-F paymentMethod[]='TRANSACTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}'
JSON response
{
"paymentRequestId":"05a2861e-22b1-499b-a1ec-ebbc3f4621fd",
"merchantPaymentRequestId":null,
"creationDate":"2019-01-22T09:47:20.615082+01:00",
"pointOfSaleId":"556b5936-e83a-4895-a0d1-4984be45dbb4",
"description":null,
"currency":"EUR",
"totalAmount":100000,
"partial":false,
"paymentRequestStatus":"ACTIVE",
"paymentStatus":"UNPAID",
"deadline":null,
"linkExpirationDate":null,
"createCustomer":false,
"paymentMethods":[
"TRANSACTION"
],
"transaction":{
"paymentRequestTransactionId":"1251d5d5-b8c0-4ed6-afca-5050f49f0001",
"receiptEmail":null,
"creationDate":"2019-01-22T09:47:20.615082+01:00",
"updateUser":null,
"contractId":null
},
"installment":null,
"breakdowns":[
{
"requestUuid":"42e21a87-d969-4310-a7f3-63fb8b56d92a",
"customerId":null,
"email":"johnDoe@hotmail.com",
"entered":false,
"lastEnteringDate":null,
"paymentAttempted":false,
"lastPaymentAttempt":null,
"paid":null,
"view":0,
"payments":[
]
}
],
"transfers":[
],
"transferGroup":null,
"scenarioId":null,
"paymentFormTemplateId":null,
"additionalData":{
},
"attachments":[
]
}
Payment request in 3 times
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-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 \
-F installment[depositStartingDate]='2019-01-22' \
-F installment[startingDate]='2019-02-22' \
-F scenarioId=c1aeecb5-62e0-4b57-897f-42d4305eef89
JSON response
{
"paymentRequestId":"0c7f720c-7156-407a-a244-d4a72884f080",
"merchantPaymentRequestId":null,
"creationDate":"2019-01-22T09:49:25.654231+01:00",
"pointOfSaleId":"556b5936-e83a-4895-a0d1-4984be45dbb4",
"description":null,
"currency":"EUR",
"totalAmount":100000,
"partial":true,
"paymentRequestStatus":"ACTIVE",
"paymentStatus":"UNPAID",
"deadline":null,
"linkExpirationDate":null,
"createCustomer":false,
"paymentMethods":[
"INSTALLMENT"
],
"transaction":null,
"installment":{
"paymentRequestInstallmentId":"aa02292d-1211-4d0a-85b4-3372e56b5321",
"depositAmount":400,
"feeAmount":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"iterationCount":2,
"depositStartingDate":"2019-01-22",
"startingDate":"2019-01-22",
"creationDate":"2019-01-22T09:49:25.654231+01:00",
"updateUser":null
},
"breakdowns":[
{
"requestUuid":"bb1533c6-1549-4d00-a140-a62c28940e92",
"customerId":null,
"email":"johnDoe@hotmail.com",
"entered":false,
"lastEnteringDate":null,
"paymentAttempted":false,
"lastPaymentAttempt":null,
"paid":null,
"view":0,
"payments":[
]
}
],
"transfers":[
],
"transferGroup":null,
"scenarioId":" c1aeecb5-62e0-4b57-897f-42d4305eef89",
"paymentFormTemplateId":null,
"additionalData":{
},
"attachments":[
]
}
Payment request with 3 participants
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-F paymentMethod[]=TRANSACTION \
-F currency=EUR \
-F totalAmount=100000 \
-F partial=true \
-F deadline='2019-02-25T12:00+01:00' \
-F linkExpirationDate='2019-03-25T12:00+01:00' \
-F scenarioId=c1aeecb5-62e0-4b57-897f-42d4305eef89 \
-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":"6a397b8d-2acf-44a8-8d3c-ef645f886e44",
"merchantPaymentRequestId":null,
"creationDate":"2019-01-22T09:52:15.047221+01:00",
"pointOfSaleId":"556b5936-e83a-4895-a0d1-4984be45dbb4",
"description":null,
"currency":"EUR",
"totalAmount":100000,
"partial":true,
"paymentRequestStatus":"ACTIVE",
"paymentStatus":"UNPAID",
"deadline":"2019-02-25T12:00+01:00",
"linkExpirationDate":"2019-03-25T12:00+01:00",
"createCustomer":false,
"paymentMethods":[
"TRANSACTION"
],
"transaction":{
"paymentRequestTransactionId":"57adb1d9-1055-47ca-9698-90e681ca466d",
"receiptEmail":null,
"creationDate":"2019-01-22T09:52:15.047221+01:00",
"updateUser":null,
"contractId":null
},
"installment":null,
"breakdowns":[
{
"requestUuid":"2fb0d7dd-8c4f-4ab4-9d7f-88b389d9040b",
"customerId":null,
"email":"johnDoe@hotmail.com",
"entered":false,
"lastEnteringDate":null,
"paymentAttempted":false,
"lastPaymentAttempt":null,
"paid":null,
"view":0,
"payments":[
]
},
{
"requestUuid":"86524d71-e082-4ac3-a0ad-97e7a4cd9b7e",
"customerId":null,
"email":"janeDoe@gmail.com",
"entered":false,
"lastEnteringDate":null,
"paymentAttempted":false,
"lastPaymentAttempt":null,
"paid":null,
"view":0,
"payments":[
]
},
{
"requestUuid":"a514dd4d-bfe2-42b5-a05f-6f1c501c411d",
"customerId":null,
"email":"Doe@yahoo.com",
"entered":false,
"lastEnteringDate":null,
"paymentAttempted":false,
"lastPaymentAttempt":null,
"paid":null,
"view":0,
"payments":[
]
}
],
"transfers":[
],
"transferGroup":null,
"scenarioId":" c1aeecb5-62e0-4b57-897f-42d4305eef89",
"paymentFormTemplateId":null,
"additionalData":{
},
"attachments":[
]
}
Payment Request return
POST /paymentRequest return [OBJ] PaymentRequest
| 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 Note: TRANSACTION | INSTALLMENT |
| 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 Note: content in JSON format |
| customerId UUID |
Customer IDs Required: no Validation: mandatory if its breakdown[email] = null |
| email String |
Customer email Required: no Validation: mandatory if its breakdown[customerId] = null |
| 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 |
| 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 |
| 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 |
| 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[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 |
Simple payment request
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-F paymentMethod[]='TRANSACTION' \
-F currency='EUR' \
-F totalAmount=100000 \
-F partial=false \
-F breakdown[]='{"amount":100000, "email":"johnDoe@hotmail.com"}'
JSON response
{
"paymentRequestId":"05a2861e-22b1-499b-a1ec-ebbc3f4621fd",
"merchantPaymentRequestId":null,
"creationDate":"2019-01-22T09:47:20.615082+01:00",
"pointOfSaleId":"556b5936-e83a-4895-a0d1-4984be45dbb4",
"description":null,
"currency":"EUR",
"totalAmount":100000,
"partial":false,
"paymentRequestStatus":"ACTIVE",
"paymentStatus":"UNPAID",
"deadline":null,
"linkExpirationDate":null,
"createCustomer":false,
"paymentMethods":[
"TRANSACTION"
],
"transaction":{
"paymentRequestTransactionId":"1251d5d5-b8c0-4ed6-afca-5050f49f0001",
"receiptEmail":null,
"creationDate":"2019-01-22T09:47:20.615082+01:00",
"updateUser":null,
"contractId":null
},
"installment":null,
"breakdowns":[
{
"requestUuid":"42e21a87-d969-4310-a7f3-63fb8b56d92a",
"customerId":null,
"email":"johnDoe@hotmail.com",
"entered":false,
"lastEnteringDate":null,
"paymentAttempted":false,
"lastPaymentAttempt":null,
"paid":null,
"view":0,
"payments":[
]
}
],
"transfers":[
],
"transferGroup":null,
"scenarioId":null,
"paymentFormTemplateId":null,
"additionalData":{
},
"attachments":[
]
}
Payment request in 3 times
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-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 \
-F installment[depositStartingDate]='2019-01-22' \
-F installment[startingDate]='2019-02-22' \
-F scenarioId=c1aeecb5-62e0-4b57-897f-42d4305eef89
JSON response
{
"paymentRequestId":"0c7f720c-7156-407a-a244-d4a72884f080",
"merchantPaymentRequestId":null,
"creationDate":"2019-01-22T09:49:25.654231+01:00",
"pointOfSaleId":"556b5936-e83a-4895-a0d1-4984be45dbb4",
"description":null,
"currency":"EUR",
"totalAmount":100000,
"partial":true,
"paymentRequestStatus":"ACTIVE",
"paymentStatus":"UNPAID",
"deadline":null,
"linkExpirationDate":null,
"createCustomer":false,
"paymentMethods":[
"INSTALLMENT"
],
"transaction":null,
"installment":{
"paymentRequestInstallmentId":"aa02292d-1211-4d0a-85b4-3372e56b5321",
"depositAmount":400,
"feeAmount":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"iterationCount":2,
"depositStartingDate":"2019-01-22",
"startingDate":"2019-01-22",
"creationDate":"2019-01-22T09:49:25.654231+01:00",
"updateUser":null
},
"breakdowns":[
{
"requestUuid":"bb1533c6-1549-4d00-a140-a62c28940e92",
"customerId":null,
"email":"johnDoe@hotmail.com",
"entered":false,
"lastEnteringDate":null,
"paymentAttempted":false,
"lastPaymentAttempt":null,
"paid":null,
"view":0,
"payments":[
]
}
],
"transfers":[
],
"transferGroup":null,
"scenarioId":" c1aeecb5-62e0-4b57-897f-42d4305eef89",
"paymentFormTemplateId":null,
"additionalData":{
},
"attachments":[
]
}
Payment request with 3 participants
curl -v https://test-api.centralpay.net/v2/rest/paymentRequest \
-F paymentMethod[]=TRANSACTION \
-F currency=EUR \
-F totalAmount=100000 \
-F partial=true \
-F deadline='2019-02-25T12:00+01:00' \
-F linkExpirationDate='2019-03-25T12:00+01:00' \
-F scenarioId=c1aeecb5-62e0-4b57-897f-42d4305eef89 \
-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":"6a397b8d-2acf-44a8-8d3c-ef645f886e44",
"merchantPaymentRequestId":null,
"creationDate":"2019-01-22T09:52:15.047221+01:00",
"pointOfSaleId":"556b5936-e83a-4895-a0d1-4984be45dbb4",
"description":null,
"currency":"EUR",
"totalAmount":100000,
"partial":true,
"paymentRequestStatus":"ACTIVE",
"paymentStatus":"UNPAID",
"deadline":"2019-02-25T12:00+01:00",
"linkExpirationDate":"2019-03-25T12:00+01:00",
"createCustomer":false,
"paymentMethods":[
"TRANSACTION"
],
"transaction":{
"paymentRequestTransactionId":"57adb1d9-1055-47ca-9698-90e681ca466d",
"receiptEmail":null,
"creationDate":"2019-01-22T09:52:15.047221+01:00",
"updateUser":null,
"contractId":null
},
"installment":null,
"breakdowns":[
{
"requestUuid":"2fb0d7dd-8c4f-4ab4-9d7f-88b389d9040b",
"customerId":null,
"email":"johnDoe@hotmail.com",
"entered":false,
"lastEnteringDate":null,
"paymentAttempted":false,
"lastPaymentAttempt":null,
"paid":null,
"view":0,
"payments":[
]
},
{
"requestUuid":"86524d71-e082-4ac3-a0ad-97e7a4cd9b7e",
"customerId":null,
"email":"janeDoe@gmail.com",
"entered":false,
"lastEnteringDate":null,
"paymentAttempted":false,
"lastPaymentAttempt":null,
"paid":null,
"view":0,
"payments":[
]
},
{
"requestUuid":"a514dd4d-bfe2-42b5-a05f-6f1c501c411d",
"customerId":null,
"email":"Doe@yahoo.com",
"entered":false,
"lastEnteringDate":null,
"paymentAttempted":false,
"lastPaymentAttempt":null,
"paid":null,
"view":0,
"payments":[
]
}
],
"transfers":[
],
"transferGroup":null,
"scenarioId":" c1aeecb5-62e0-4b57-897f-42d4305eef89",
"paymentFormTemplateId":null,
"additionalData":{
},
"attachments":[
]
}
PaymentRequest Object
[OBJ] PaymentRequest
|
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: UNPAID ou PARTIALLY_PAID |
|
paymentStatus |
Status of the payment request Note: PAID: paid, 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 |
|
installment |
Data on X times |
|
scenarioId |
Scenario ID |
|
paymentFormTemplateId |
Form template ID |
|
attachment |
List of the names of the attachments |
|
paymentMethods |
List<PaymentMethod> |
|
additionalData[*] |
Merchant data |
Payment request breakdown response object
[OBJ] PaymentRequestBreakdownResponse
|
requestUuid |
UUID of the breakdown form |
|
customerId |
Customer ID |
| email String |
|
|
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) |
[OBJ] PaymentRequestBreakdownResponse
| uuid UUID |
UUID of the means of payment |
| PaymentMerthod PaymentMethod |
Method of the means of payment Note: TRANSACTION | INSTALLMENT |
Transfer
-F transfer[]='{"destinationWalletId":"59f8ad24-45eb-4dfa-845f-3e184b4358d3", "amount":100000, "email":"johnDoe@hotmail.com"}'
Payment request transfer response object
[OBJ] PaymentRequestTransferResponse
|
destinationWalletId |
Destination wallet ID |
|
amount |
Gross amount |
|
fee |
Fee |
|
escrowDate |
Escow date |
Transfer
-F transfer[]='{"destinationWalletId":"59f8ad24-45eb-4dfa-845f-3e184b4358d3", "amount":100000, "email":"johnDoe@hotmail.com"}'
Payment request transaction response object
[OBJ] PaymentRequestTransactionResponse
|
receiptEmail |
Email for sending the receipt |
| contractId UUID |
Contract ID |
Payment request installment response object
[OBJ] PaymentRequestInstallmentResponse
|
depositAmount |
Amount of the deposit (included in amount) |
|
feeAmount |
Fee of the X times (NOT included in amount) |
|
intervalUnit |
Interval unit |
|
intervalCount |
Number of intervals |
|
iterationCount |
Number of iterations |
|
depositStartingDate |
Start date of the deposit |
|
startingDate |
Start date of the X times |
Payment request ID cancel return object
POST /paymentRequest/<paymentrequestid>/cancel return [OBJ] PaymentRequest</paymentrequestid>
|
paymentRequestId (URL) |
Payment request ID Required: yes Validation: UUID, existing, belongs to the merchant, status = ACTIVE |
Payment request ID return object
GET /paymentRequest/<paymentrequestid> return [OBJ] PaymentRequest</paymentrequestid>
|
paymentRequestId (URL) |
Payment request ID Required: yes Validation: UUID, existing, belongs to the merchant |
Payment request return object list
GET /paymentRequest return [OBJ] List<paymentrequest></paymentrequest>
|
merchantPaymentRequestId |
Merchant ID of the payment request Required: no Validation: .{0,100} |
|
status |
Status of the payment request Required: no |
3DS enrollment
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 |
| merchantName String |
Merchant name |
| merchantCountry String |
Merchant country Note: Favourite format |
| merchantURL String |
URL of the merchant |
| 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 Note: Just 'calculated' (as the fingerprint of the Card) Does not store card data as it will be done during the payment |
| paReq String (10000) |
PaReq Note: 10 000 max |
| acsURL String |
URL of ACS |
| additionalData Object |
Merchant data Note: Contains key/values |
Example of curl code
curl -v https://test-api.centralpay.net/v2/rest/checkEnrollment \
-u 'doctest:4I9HJRTd' \
-d merchantTransactionIdentifier='REF001' \
-d merchantName='Marchand 001' \
-d merchantCountry='FRA' \
-d merchantURL='https://www.ma-boutique.com' \
-d currency='EUR' \
-d amount='1000' \
-d card[number]='4444333322221111' \
-d card[expirationMonth]='06' \
-d card[expirationYear]='2018'
Back to Json format
{
"enrollmentId":"f2a2a844-8a04-49fd-8c23-d6d8980801c6",
"creationDate":"2016-09-23T10:36:32.244+02:00",
"additionalData":{
},
"acsURL":"https://acs.my-bank.com",
"amount":1000,
"cardFingerprint":"823644ee8901d9f84d89b7ac3d8c69d874abd6e0",
"currency":"978",
"first6":"444433",
"last4":"1111",
"merchantCountry":"250",
"merchantName":"Marchand 001",
"merchantTransactionIdentifier":"REF001",
"merchantURL":"https://www.ma-boutique.com",
"paReq":"eJzNWWnPo0iS/iulmo9WNbcxLdc74r4xYO5vXOYG22CD+fWTtruqq7trd3tHq9VYRiRBZmSQEfE8kbD/59K1n+75dayG/utn5Bf486e8T4es6ouvn11H+LL7/M+PvVNe85w75untmn/s9Xwc4yL/VGVfP+/iLMVgKvmSIDjyBUfR05cYS5MvBE6g8I4gt3iMfP7Ym7Sdj68BrxZGUvgOiH+b+APM+wu6h75dghmuaRn308c+Ti+MbHzgFAkjyB767XLf5VeZ+4ARHMW28B56X+6h38eZt2drBNYuVfbhcfSsH+lCZv9yfN1Dzx77LJ7yDxRGSBhD4U8I9iuC/Ers9tBLvj8/1dHdcAO6ERjM+KNgD5blClbt8UGRYMT3q32+nIc+Bz3As31v76HfbTvH/Qf8ww/dYiTQDaR7J/jYT1X3o034r+CPAV0v+X6c4uk2foR76LfWPo3v9w+aphm6ZOSSjxXBVyzLrXj6/QPP+uqyz9PqAyaAUeD8GkW3xXCtprJ7mvpHwR56mgK9/PaxP1ZFDya75p9A4PTj18/lNJ1/haB5nn+ZsV+GawGh4EEgmIJAh2ysin98fo/KM7k/DR97Nu6HvkrjtlrjCXhbz6dyyD59n/BnKh37qRWBbJ79AtR+SRG8//KUwBhCfIZ+MOvvaPuzgdcx/jKWIE6BIjs/5U/v5Z9cW/76+R9/CFeuKvJx+nem+Kb+rcGL21v+YUTu0TJ2Wa8bpM2c/anAelUbNnJRAEf92HMPfTcLtH9czO/P/ZtKZNuTE2xeVfcxbMrB6jFNkgx/Hpq+NUbCOvfb0TmbvHkjSmks/JujoFvSFYJgQtREN4XzY2OmU5P7cdkfVy9tW/BwrUvaabHjqcw1JpM8NFc0U4bAi8hBejBX2pfD6IZzwXHrPbLENttR6/HASeO4XHa8mZYb2p56T/Uz5VJTj35oxVqSXDlaLu7lBO8O8ahqY0md8CgrhCtPoH0PH92dxs+QULqHhcKwAMYR6MiFykzrEnQX4PFsY9To73zkEj1KilPlFTkrydgKINN3Frq9K3nhw2wTuZ16QoyNdMptWLoE0LDlrYzW3IIgg8eSPFDLQzaldfY10dveCLJcp4TyulOJJfch1IuvX9+L/sNC79X88fZAQMAUF0/xu8Xm16k6gegGoKHLMjfULEsPl4KeZQbAjcXjIeLYMMTcNWbjuwIS0WlY0wZTNJeyqURqhhnacgWaY666Nc6sFXKeZYn8rHjuyhs6PYo04vJsqfNe0zqWw991Fn7LFr3zunYNj4yS9HabdkSZie096YRRFow27aNziLqFFRhrghrnMLDPCYovEkfHTGF4DK07PBKdU5QvIte4Jz4CdBitLCj3BLNmqUwNnZNno5ZRcF4OnI76T1n9ksE6Ry9GzT/8+j/P9qLgK52GRfZ4EY9ygnEW/1xnmsZlhpvp532VHoCPLPbuUYQvddsS7dilZU+aQI2SibOCs6vSaeLgBIbMLqtLdKfIAXcZD44pSehFU2r4apw8eYwkhm5wvj0L5MiZ82jbB97fIJa6S+zYU0lsi15NtZCQAuKbqDBltMQlzPRWfJXuk7SLB6+dMy+6+Ih2JMNC6B7nGcXs21yG0A65bF12fVxhxyRIKrKzkkeHXcea6Iy3pkKtabpxMfh6QSnqcZDXtb1ii0Cux1s9Cf4Y99QYBtUsZhDTDeqg+zfuLEMNvhnUURTz1tnhtMNs4Om+7lRTcIvDcR5psYVb97KTNfWc525YReKAMYtBktPGmKcMqru2ElSdFtdRlBbmfoq1LMi3oYLyBIRPdKEzNC3WVg08Re+ePs/4mWeg2RJ0Gtw77WauAPFiwyZtSRBwBEcXvKgzr/jIuMLyGcbyDrJumo8ZSjk9X91kw+BzgRsnblp/kkP0gaUtng4ggTkFS8pqzRU3/KMNnftAdZ151svuMemVm5i+iynQxaOnzjSwgB9aP7VX9jjCsD2mMc7I4sgNwy6cHs32lLt+KBi4qbN3ITSxGpFXRUOahjjdKuiUiGo5pYmJaczJyljvTEHE1VSOG8edmJonq5Ti6oZVVmuHreTmvK6Nr45qpEDwQvWBKC9SmDXCmJF3TKc2JBWq/pKX0QLbiXVi5F0idgG6JU6H6Dxrs7sT3ZDvjjQKi8wttGJSaFQ9NdN5s+GS6KLTdIJ1mnGxgy0jVjBy6TmYwixPhPoYGuhhR9Bcp5AnqGSx/FbJfVsyy/ahTRi1W3sdqq/x9oDIZOcg4l04a0VghhI3P0Hxz4j3MwgUxJVlGfrwDQJt2ijh0GEYiFv4QVvFwJ/RnU3PnBUq6hDJ5T01gNs0xqLneOU1nW5eEMGUOut5+sI5tPZO+cFhhEhxYX7RVnp6y0ZHad8wcPQJOAqU2xsqiDJhGQdco7EPYIEX1hSl6tgX4Ninbro9z2LxgiuOXww/DoxSFj0uQZEJjKmjI3NMUArWGTzgANDoXPgwOHCu09loByCTH0+ZXoM60wlnAxnm1Pl/sv0ozzL9zfb2Z7YrKWYgsU/0Mm8wwCeM/BfK4X9Llx39vM8W6it1rk3HErC1EZvOekQo1ajLGck2vYJjyhyUYkTGgoCYlU4cW5Y/Wih68aCWobFZCkNzVyEkJFpWaDCVgN3w67a+BbIkzPV8Vx+CLmybjgmDe2rFOzMjCYFFeux0kq8lX2/aLOlAYb6qcGmewkfARxfuLJXNre/uHHlZEYb3VZ403NATbP40nL3q1KqVF6XhVapIVqFzxgjJ7FHcO1nvJTeXcGPijsTlBPUUZ1mnk/foiVLxK8LMmR3ZO+302K1ZXaFTTfY0ugkxU1NtxcUeiJyk5UVs++CyxLF6ahzNGKvoQpnOrMbXh7S5ddgUnIgb3t3a1RYPfom6G7fBtX7qdIFNIO2iNH7vevlmljnaopkBUM/4LA9ifJbmF/TVDFPMwkC7glNx3LobTYxepRERoSLX5QMXzGQ682+YdN4wWcxM8YRRkFscTTzjSDrS/CsOWVxk/JyhAczqrDvLcyircwhQ1JUAtPoCWsKZRG+1B4VlWHrLXvRL1AkK31NxOr/i4G0XQB2gv2YZaKXRgTsW+hDOsWTDKTfcNdi7pR01JiyBPmMvRPlbiFKT9qJjgbP8H2LRe9HxLcSUUecexeFC42UdDZlkz4dqd8+AJVrX3jJxftvjG6XWATo/UnXazfdXieAazI8U73bUPWOJ5/25COOiCA/gYMVTtzRh8Ho+IenBvH/W6QzrgWvuIYpTv5UerQXsTnzv8Sw13nqXu+m98nRMMJf6N0oUKERBUSy2Hchd0N87RkEE5nznriO2a8bRh5ffrN2TBkFdooPcC2fJeq39gWFCXjAgTm3dmwbL27xhs+bCYTbWBzWeq38ua9j5XdbQFkOFG4GiplKiD+USDVbqUGzCDr3HTkmHlX57QntG6W+xlQ+nKTuo/lTD4cGpSdON1YN/mtMkOkrMFrvqnVZ5HRldZK/P/OXOMLaGOGmRzHHB9VpBXy1dlfoQvYnWyax5gHx03/t5qJyyTWor3rBVMRtnEktchaMUoxUaX7fQEKyy8YgXOsgGEcbZFTVhs9siGADMcy08wqo9QjhAwBxxGugujU4vzELbUMBF2s4rmXhb4/ApjoUbtD1VPblTh3NDbQspo2UDmRIaQQ2ju5KJhZzdEe5VqVwtcbCD4hZmpBseqAodDY9FWILGhF02nOfxjloqusGwC0wcUAjnil7AO+I2bm2Pwrm/SXslB2hPfPxOeyaz0IMtCVzg3EeCcRHugrc/p73/WOp40x+o/ptZr3lMd/RFR570x+N/ks1FYi1cDUq7l32pw7jKmKDtqtvuzM+vOWV+XnQge2i+B2u+MUSBvLArrbzHhA7dREfdTmfhvZNQ+ZlgMpFaZSG7pyC9E7G9RQ7f6az1bReRWa7hyDzBeHwbHj29cHkhclzv4IF1cODFA3LTafXFdGjy287BEDLdZRHGQvTib44vXLTtQerDWaCAXcbLH/+LXQZ3OuAZ0phEDNGqcgyj5YaDQrsy4A5sie/9gaeMijDaFbsfUIsOsDaXp5Ydlc3dO/EXLIop5K5G6TbNYm8bhoST0DW1SeVUE/ngButBO89Df+oBT9xkOvOhwq+JycOEh+5mEC6H96gNLnJqyjvfbR6pR1nMYWDOd8qtmDS4WpudwLgQLbD9ETnAUn673mhSkB/DFId9/3DICsLjBwc28yitVwfUFErPiOCEq9wNJHbDgT94znhIUFt1q4FYIPcaatZ5eoTpeoYPwISLlNOEI2FCvRo7xgmkmmwIpMK8jWaU+PUUcZvVGsZhycrY8zeBaT8uVWXji2hfGizWx94o6hWBbg698Q8uhibfdhlFIdlP+lodpmWK4gooUmCsFKy7HelCOivW71QItiyi6H+nwnuIGbPWv3LpTWMgX1KMnrXixzGqKHffx7Q/pZcj1T7HJ4BSQVz/heKxnX7xjvjdqs9bS0GPg5lJeZabJT7MHP0jxcszzbHMo/hGxRKryyKks1WhXOimrJTv9Gn7xCNBl/Ftv1B/o/M3XcJv2pXF4yCLJjj0chCVRLTL/47GD7WOHwD9JjXyP+KDJuoUwKp/lyrHZEX8o2cwJvrsY5+jrq3BPUDxHgr6vXU0yzkFO/q/7hZz+o+7xSNmmEvZYfRStnmVVxtvUrQ5Nutpcv6PS6X/koJpyja82PXWQ1yFhCA1qXdgs0U9W0iTPNzRMtxF3XCN1heB2JEgnU9Nm3mLinHyBpsBAFWef8sPk1NuYu+YutwwbmvkEc2F1VnKFZmuCIQrjEPE4n0ar3esszs/hpL1flFHamNtmXsKj+FWmVi3x5o1EaktKafQRpGj5LIcboy+m5KwaCt6WjhCRQ88fd7m940yELcEitCbtR4fRS3Cccx07GoszaXtWoJSnU7YdFpEtU226+6P2Q2gbINPfUckNyTHHEfXsGASpXieal9Bg5tlkd6uTHWK2iYOQEuOawIAZGoyqkdDa3gv4cXNgkOand9qjvQ3q+zEo7l6+I6aIFsNu4i6NfcZan9CwdDv7+Gg7+/mfn9r9/o28Ppq8Xyf/ePXjH8Bh7EywA==",
"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 PointOfSale |
POS ID Required: no Validation: UUID, existing, authorized user Note: by default, the user default POS |
| merchantName String (25) |
Merchant name Usually, it is the one shown to the cardholder on the merchant's website Required: yes ​Validation: .{1,25} |
| merchantCountry Country |
Merchant country Required: yes ​Validation: ISO3166 in format alpha2, apha3 or num - [0-9]{3}|[A-Z]{2}|[A-Z]{3} - Existing |
| merchantURL String (2048) |
Merchant's url Required: yes ​Validation: URL, 2048 max. |
| 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 merchantName='Marchand 001' \
-d merchantCountry='FRA' \
-d merchantURL='https://www.ma-boutique.com' \
-d currency='EUR' \
-d amount='1000' \
-d card[number]='4444333322221111' \
-d card[expirationMonth]='06' \
-d card[expirationYear]='2018'
Back to Json format
{
"enrollmentId":"f2a2a844-8a04-49fd-8c23-d6d8980801c6",
"creationDate":"2016-09-23T10:36:32.244+02:00",
"additionalData":{
},
"acsURL":"https://acs.my-bank.com",
"amount":1000,
"cardFingerprint":"823644ee8901d9f84d89b7ac3d8c69d874abd6e0",
"currency":"978",
"first6":"444433",
"last4":"1111",
"merchantCountry":"250",
"merchantName":"Marchand 001",
"merchantTransactionIdentifier":"REF001",
"merchantURL":"https://www.ma-boutique.com",
"paReq":"eJzNWWnPo0iS/iulmo9WNbcxLdc74r4xYO5vXOYG22CD+fWTtruqq7trd3tHq9VYRiRBZmSQEfE8kbD/59K1n+75dayG/utn5Bf486e8T4es6ouvn11H+LL7/M+PvVNe85w75untmn/s9Xwc4yL/VGVfP+/iLMVgKvmSIDjyBUfR05cYS5MvBE6g8I4gt3iMfP7Ym7Sdj68BrxZGUvgOiH+b+APM+wu6h75dghmuaRn308c+Ti+MbHzgFAkjyB767XLf5VeZ+4ARHMW28B56X+6h38eZt2drBNYuVfbhcfSsH+lCZv9yfN1Dzx77LJ7yDxRGSBhD4U8I9iuC/Ers9tBLvj8/1dHdcAO6ERjM+KNgD5blClbt8UGRYMT3q32+nIc+Bz3As31v76HfbTvH/Qf8ww/dYiTQDaR7J/jYT1X3o034r+CPAV0v+X6c4uk2foR76LfWPo3v9w+aphm6ZOSSjxXBVyzLrXj6/QPP+uqyz9PqAyaAUeD8GkW3xXCtprJ7mvpHwR56mgK9/PaxP1ZFDya75p9A4PTj18/lNJ1/haB5nn+ZsV+GawGh4EEgmIJAh2ysin98fo/KM7k/DR97Nu6HvkrjtlrjCXhbz6dyyD59n/BnKh37qRWBbJ79AtR+SRG8//KUwBhCfIZ+MOvvaPuzgdcx/jKWIE6BIjs/5U/v5Z9cW/76+R9/CFeuKvJx+nem+Kb+rcGL21v+YUTu0TJ2Wa8bpM2c/anAelUbNnJRAEf92HMPfTcLtH9czO/P/ZtKZNuTE2xeVfcxbMrB6jFNkgx/Hpq+NUbCOvfb0TmbvHkjSmks/JujoFvSFYJgQtREN4XzY2OmU5P7cdkfVy9tW/BwrUvaabHjqcw1JpM8NFc0U4bAi8hBejBX2pfD6IZzwXHrPbLENttR6/HASeO4XHa8mZYb2p56T/Uz5VJTj35oxVqSXDlaLu7lBO8O8ahqY0md8CgrhCtPoH0PH92dxs+QULqHhcKwAMYR6MiFykzrEnQX4PFsY9To73zkEj1KilPlFTkrydgKINN3Frq9K3nhw2wTuZ16QoyNdMptWLoE0LDlrYzW3IIgg8eSPFDLQzaldfY10dveCLJcp4TyulOJJfch1IuvX9+L/sNC79X88fZAQMAUF0/xu8Xm16k6gegGoKHLMjfULEsPl4KeZQbAjcXjIeLYMMTcNWbjuwIS0WlY0wZTNJeyqURqhhnacgWaY666Nc6sFXKeZYn8rHjuyhs6PYo04vJsqfNe0zqWw991Fn7LFr3zunYNj4yS9HabdkSZie096YRRFow27aNziLqFFRhrghrnMLDPCYovEkfHTGF4DK07PBKdU5QvIte4Jz4CdBitLCj3BLNmqUwNnZNno5ZRcF4OnI76T1n9ksE6Ry9GzT/8+j/P9qLgK52GRfZ4EY9ygnEW/1xnmsZlhpvp532VHoCPLPbuUYQvddsS7dilZU+aQI2SibOCs6vSaeLgBIbMLqtLdKfIAXcZD44pSehFU2r4apw8eYwkhm5wvj0L5MiZ82jbB97fIJa6S+zYU0lsi15NtZCQAuKbqDBltMQlzPRWfJXuk7SLB6+dMy+6+Ih2JMNC6B7nGcXs21yG0A65bF12fVxhxyRIKrKzkkeHXcea6Iy3pkKtabpxMfh6QSnqcZDXtb1ii0Cux1s9Cf4Y99QYBtUsZhDTDeqg+zfuLEMNvhnUURTz1tnhtMNs4Om+7lRTcIvDcR5psYVb97KTNfWc525YReKAMYtBktPGmKcMqru2ElSdFtdRlBbmfoq1LMi3oYLyBIRPdKEzNC3WVg08Re+ePs/4mWeg2RJ0Gtw77WauAPFiwyZtSRBwBEcXvKgzr/jIuMLyGcbyDrJumo8ZSjk9X91kw+BzgRsnblp/kkP0gaUtng4ggTkFS8pqzRU3/KMNnftAdZ151svuMemVm5i+iynQxaOnzjSwgB9aP7VX9jjCsD2mMc7I4sgNwy6cHs32lLt+KBi4qbN3ITSxGpFXRUOahjjdKuiUiGo5pYmJaczJyljvTEHE1VSOG8edmJonq5Ti6oZVVmuHreTmvK6Nr45qpEDwQvWBKC9SmDXCmJF3TKc2JBWq/pKX0QLbiXVi5F0idgG6JU6H6Dxrs7sT3ZDvjjQKi8wttGJSaFQ9NdN5s+GS6KLTdIJ1mnGxgy0jVjBy6TmYwixPhPoYGuhhR9Bcp5AnqGSx/FbJfVsyy/ahTRi1W3sdqq/x9oDIZOcg4l04a0VghhI3P0Hxz4j3MwgUxJVlGfrwDQJt2ijh0GEYiFv4QVvFwJ/RnU3PnBUq6hDJ5T01gNs0xqLneOU1nW5eEMGUOut5+sI5tPZO+cFhhEhxYX7RVnp6y0ZHad8wcPQJOAqU2xsqiDJhGQdco7EPYIEX1hSl6tgX4Ninbro9z2LxgiuOXww/DoxSFj0uQZEJjKmjI3NMUArWGTzgANDoXPgwOHCu09loByCTH0+ZXoM60wlnAxnm1Pl/sv0ozzL9zfb2Z7YrKWYgsU/0Mm8wwCeM/BfK4X9Llx39vM8W6it1rk3HErC1EZvOekQo1ajLGck2vYJjyhyUYkTGgoCYlU4cW5Y/Wih68aCWobFZCkNzVyEkJFpWaDCVgN3w67a+BbIkzPV8Vx+CLmybjgmDe2rFOzMjCYFFeux0kq8lX2/aLOlAYb6qcGmewkfARxfuLJXNre/uHHlZEYb3VZ403NATbP40nL3q1KqVF6XhVapIVqFzxgjJ7FHcO1nvJTeXcGPijsTlBPUUZ1mnk/foiVLxK8LMmR3ZO+302K1ZXaFTTfY0ugkxU1NtxcUeiJyk5UVs++CyxLF6ahzNGKvoQpnOrMbXh7S5ddgUnIgb3t3a1RYPfom6G7fBtX7qdIFNIO2iNH7vevlmljnaopkBUM/4LA9ifJbmF/TVDFPMwkC7glNx3LobTYxepRERoSLX5QMXzGQ682+YdN4wWcxM8YRRkFscTTzjSDrS/CsOWVxk/JyhAczqrDvLcyircwhQ1JUAtPoCWsKZRG+1B4VlWHrLXvRL1AkK31NxOr/i4G0XQB2gv2YZaKXRgTsW+hDOsWTDKTfcNdi7pR01JiyBPmMvRPlbiFKT9qJjgbP8H2LRe9HxLcSUUecexeFC42UdDZlkz4dqd8+AJVrX3jJxftvjG6XWATo/UnXazfdXieAazI8U73bUPWOJ5/25COOiCA/gYMVTtzRh8Ho+IenBvH/W6QzrgWvuIYpTv5UerQXsTnzv8Sw13nqXu+m98nRMMJf6N0oUKERBUSy2Hchd0N87RkEE5nznriO2a8bRh5ffrN2TBkFdooPcC2fJeq39gWFCXjAgTm3dmwbL27xhs+bCYTbWBzWeq38ua9j5XdbQFkOFG4GiplKiD+USDVbqUGzCDr3HTkmHlX57QntG6W+xlQ+nKTuo/lTD4cGpSdON1YN/mtMkOkrMFrvqnVZ5HRldZK/P/OXOMLaGOGmRzHHB9VpBXy1dlfoQvYnWyax5gHx03/t5qJyyTWor3rBVMRtnEktchaMUoxUaX7fQEKyy8YgXOsgGEcbZFTVhs9siGADMcy08wqo9QjhAwBxxGugujU4vzELbUMBF2s4rmXhb4/ApjoUbtD1VPblTh3NDbQspo2UDmRIaQQ2ju5KJhZzdEe5VqVwtcbCD4hZmpBseqAodDY9FWILGhF02nOfxjloqusGwC0wcUAjnil7AO+I2bm2Pwrm/SXslB2hPfPxOeyaz0IMtCVzg3EeCcRHugrc/p73/WOp40x+o/ptZr3lMd/RFR570x+N/ks1FYi1cDUq7l32pw7jKmKDtqtvuzM+vOWV+XnQge2i+B2u+MUSBvLArrbzHhA7dREfdTmfhvZNQ+ZlgMpFaZSG7pyC9E7G9RQ7f6az1bReRWa7hyDzBeHwbHj29cHkhclzv4IF1cODFA3LTafXFdGjy287BEDLdZRHGQvTib44vXLTtQerDWaCAXcbLH/+LXQZ3OuAZ0phEDNGqcgyj5YaDQrsy4A5sie/9gaeMijDaFbsfUIsOsDaXp5Ydlc3dO/EXLIop5K5G6TbNYm8bhoST0DW1SeVUE/ngButBO89Df+oBT9xkOvOhwq+JycOEh+5mEC6H96gNLnJqyjvfbR6pR1nMYWDOd8qtmDS4WpudwLgQLbD9ETnAUn673mhSkB/DFId9/3DICsLjBwc28yitVwfUFErPiOCEq9wNJHbDgT94znhIUFt1q4FYIPcaatZ5eoTpeoYPwISLlNOEI2FCvRo7xgmkmmwIpMK8jWaU+PUUcZvVGsZhycrY8zeBaT8uVWXji2hfGizWx94o6hWBbg698Q8uhibfdhlFIdlP+lodpmWK4gooUmCsFKy7HelCOivW71QItiyi6H+nwnuIGbPWv3LpTWMgX1KMnrXixzGqKHffx7Q/pZcj1T7HJ4BSQVz/heKxnX7xjvjdqs9bS0GPg5lJeZabJT7MHP0jxcszzbHMo/hGxRKryyKks1WhXOimrJTv9Gn7xCNBl/Ftv1B/o/M3XcJv2pXF4yCLJjj0chCVRLTL/47GD7WOHwD9JjXyP+KDJuoUwKp/lyrHZEX8o2cwJvrsY5+jrq3BPUDxHgr6vXU0yzkFO/q/7hZz+o+7xSNmmEvZYfRStnmVVxtvUrQ5Nutpcv6PS6X/koJpyja82PXWQ1yFhCA1qXdgs0U9W0iTPNzRMtxF3XCN1heB2JEgnU9Nm3mLinHyBpsBAFWef8sPk1NuYu+YutwwbmvkEc2F1VnKFZmuCIQrjEPE4n0ar3esszs/hpL1flFHamNtmXsKj+FWmVi3x5o1EaktKafQRpGj5LIcboy+m5KwaCt6WjhCRQ88fd7m940yELcEitCbtR4fRS3Cccx07GoszaXtWoJSnU7YdFpEtU226+6P2Q2gbINPfUckNyTHHEfXsGASpXieal9Bg5tlkd6uTHWK2iYOQEuOawIAZGoyqkdDa3gv4cXNgkOand9qjvQ3q+zEo7l6+I6aIFsNu4i6NfcZan9CwdDv7+Gg7+/mfn9r9/o28Ppq8Xyf/ePXjH8Bh7EywA==",
"status":"SUCCESS"
}
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/enrollment/f2a2a844-8a04-49fd-8c23-d6d8980801c6 \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"enrollmentId":"f2a2a844-8a04-49fd-8c23-d6d8980801c6",
"creationDate":"2016-09-23T10:36:32.244+02:00",
"additionalData":{
},
"acsURL":"https://acs.my-bank.com",
"amount":1000,
"cardFingerprint":"823644ee8901d9f84d89b7ac3d8c69d874abd6e0",
"currency":"978",
"first6":"444433",
"last4":"1111",
"merchantCountry":"250",
"merchantName":"Marchand 001",
"merchantTransactionIdentifier":"REF001",
"merchantURL":"https://www.ma-boutique.com",
"paReq":"eJzNWWnPo0iS/iulmo9WNbcxLdc74r4xYO5vXOYG22CD+fWTtruqq7trd3tHq9VYRiRBZmSQEfE8kbD/59K1n+75dayG/utn5Bf486e8T4es6ouvn11H+LL7/M+PvVNe85w75untmn/s9Xwc4yL/VGVfP+/iLMVgKvmSIDjyBUfR05cYS5MvBE6g8I4gt3iMfP7Ym7Sdj68BrxZGUvgOiH+b+APM+wu6h75dghmuaRn308c+Ti+MbHzgFAkjyB767XLf5VeZ+4ARHMW28B56X+6h38eZt2drBNYuVfbhcfSsH+lCZv9yfN1Dzx77LJ7yDxRGSBhD4U8I9iuC/Ers9tBLvj8/1dHdcAO6ERjM+KNgD5blClbt8UGRYMT3q32+nIc+Bz3As31v76HfbTvH/Qf8ww/dYiTQDaR7J/jYT1X3o034r+CPAV0v+X6c4uk2foR76LfWPo3v9w+aphm6ZOSSjxXBVyzLrXj6/QPP+uqyz9PqAyaAUeD8GkW3xXCtprJ7mvpHwR56mgK9/PaxP1ZFDya75p9A4PTj18/lNJ1/haB5nn+ZsV+GawGh4EEgmIJAh2ysin98fo/KM7k/DR97Nu6HvkrjtlrjCXhbz6dyyD59n/BnKh37qRWBbJ79AtR+SRG8//KUwBhCfIZ+MOvvaPuzgdcx/jKWIE6BIjs/5U/v5Z9cW/76+R9/CFeuKvJx+nem+Kb+rcGL21v+YUTu0TJ2Wa8bpM2c/anAelUbNnJRAEf92HMPfTcLtH9czO/P/ZtKZNuTE2xeVfcxbMrB6jFNkgx/Hpq+NUbCOvfb0TmbvHkjSmks/JujoFvSFYJgQtREN4XzY2OmU5P7cdkfVy9tW/BwrUvaabHjqcw1JpM8NFc0U4bAi8hBejBX2pfD6IZzwXHrPbLENttR6/HASeO4XHa8mZYb2p56T/Uz5VJTj35oxVqSXDlaLu7lBO8O8ahqY0md8CgrhCtPoH0PH92dxs+QULqHhcKwAMYR6MiFykzrEnQX4PFsY9To73zkEj1KilPlFTkrydgKINN3Frq9K3nhw2wTuZ16QoyNdMptWLoE0LDlrYzW3IIgg8eSPFDLQzaldfY10dveCLJcp4TyulOJJfch1IuvX9+L/sNC79X88fZAQMAUF0/xu8Xm16k6gegGoKHLMjfULEsPl4KeZQbAjcXjIeLYMMTcNWbjuwIS0WlY0wZTNJeyqURqhhnacgWaY666Nc6sFXKeZYn8rHjuyhs6PYo04vJsqfNe0zqWw991Fn7LFr3zunYNj4yS9HabdkSZie096YRRFow27aNziLqFFRhrghrnMLDPCYovEkfHTGF4DK07PBKdU5QvIte4Jz4CdBitLCj3BLNmqUwNnZNno5ZRcF4OnI76T1n9ksE6Ry9GzT/8+j/P9qLgK52GRfZ4EY9ygnEW/1xnmsZlhpvp532VHoCPLPbuUYQvddsS7dilZU+aQI2SibOCs6vSaeLgBIbMLqtLdKfIAXcZD44pSehFU2r4apw8eYwkhm5wvj0L5MiZ82jbB97fIJa6S+zYU0lsi15NtZCQAuKbqDBltMQlzPRWfJXuk7SLB6+dMy+6+Ih2JMNC6B7nGcXs21yG0A65bF12fVxhxyRIKrKzkkeHXcea6Iy3pkKtabpxMfh6QSnqcZDXtb1ii0Cux1s9Cf4Y99QYBtUsZhDTDeqg+zfuLEMNvhnUURTz1tnhtMNs4Om+7lRTcIvDcR5psYVb97KTNfWc525YReKAMYtBktPGmKcMqru2ElSdFtdRlBbmfoq1LMi3oYLyBIRPdKEzNC3WVg08Re+ePs/4mWeg2RJ0Gtw77WauAPFiwyZtSRBwBEcXvKgzr/jIuMLyGcbyDrJumo8ZSjk9X91kw+BzgRsnblp/kkP0gaUtng4ggTkFS8pqzRU3/KMNnftAdZ151svuMemVm5i+iynQxaOnzjSwgB9aP7VX9jjCsD2mMc7I4sgNwy6cHs32lLt+KBi4qbN3ITSxGpFXRUOahjjdKuiUiGo5pYmJaczJyljvTEHE1VSOG8edmJonq5Ti6oZVVmuHreTmvK6Nr45qpEDwQvWBKC9SmDXCmJF3TKc2JBWq/pKX0QLbiXVi5F0idgG6JU6H6Dxrs7sT3ZDvjjQKi8wttGJSaFQ9NdN5s+GS6KLTdIJ1mnGxgy0jVjBy6TmYwixPhPoYGuhhR9Bcp5AnqGSx/FbJfVsyy/ahTRi1W3sdqq/x9oDIZOcg4l04a0VghhI3P0Hxz4j3MwgUxJVlGfrwDQJt2ijh0GEYiFv4QVvFwJ/RnU3PnBUq6hDJ5T01gNs0xqLneOU1nW5eEMGUOut5+sI5tPZO+cFhhEhxYX7RVnp6y0ZHad8wcPQJOAqU2xsqiDJhGQdco7EPYIEX1hSl6tgX4Ninbro9z2LxgiuOXww/DoxSFj0uQZEJjKmjI3NMUArWGTzgANDoXPgwOHCu09loByCTH0+ZXoM60wlnAxnm1Pl/sv0ozzL9zfb2Z7YrKWYgsU/0Mm8wwCeM/BfK4X9Llx39vM8W6it1rk3HErC1EZvOekQo1ajLGck2vYJjyhyUYkTGgoCYlU4cW5Y/Wih68aCWobFZCkNzVyEkJFpWaDCVgN3w67a+BbIkzPV8Vx+CLmybjgmDe2rFOzMjCYFFeux0kq8lX2/aLOlAYb6qcGmewkfARxfuLJXNre/uHHlZEYb3VZ403NATbP40nL3q1KqVF6XhVapIVqFzxgjJ7FHcO1nvJTeXcGPijsTlBPUUZ1mnk/foiVLxK8LMmR3ZO+302K1ZXaFTTfY0ugkxU1NtxcUeiJyk5UVs++CyxLF6ahzNGKvoQpnOrMbXh7S5ddgUnIgb3t3a1RYPfom6G7fBtX7qdIFNIO2iNH7vevlmljnaopkBUM/4LA9ifJbmF/TVDFPMwkC7glNx3LobTYxepRERoSLX5QMXzGQ682+YdN4wWcxM8YRRkFscTTzjSDrS/CsOWVxk/JyhAczqrDvLcyircwhQ1JUAtPoCWsKZRG+1B4VlWHrLXvRL1AkK31NxOr/i4G0XQB2gv2YZaKXRgTsW+hDOsWTDKTfcNdi7pR01JiyBPmMvRPlbiFKT9qJjgbP8H2LRe9HxLcSUUecexeFC42UdDZlkz4dqd8+AJVrX3jJxftvjG6XWATo/UnXazfdXieAazI8U73bUPWOJ5/25COOiCA/gYMVTtzRh8Ho+IenBvH/W6QzrgWvuIYpTv5UerQXsTnzv8Sw13nqXu+m98nRMMJf6N0oUKERBUSy2Hchd0N87RkEE5nznriO2a8bRh5ffrN2TBkFdooPcC2fJeq39gWFCXjAgTm3dmwbL27xhs+bCYTbWBzWeq38ua9j5XdbQFkOFG4GiplKiD+USDVbqUGzCDr3HTkmHlX57QntG6W+xlQ+nKTuo/lTD4cGpSdON1YN/mtMkOkrMFrvqnVZ5HRldZK/P/OXOMLaGOGmRzHHB9VpBXy1dlfoQvYnWyax5gHx03/t5qJyyTWor3rBVMRtnEktchaMUoxUaX7fQEKyy8YgXOsgGEcbZFTVhs9siGADMcy08wqo9QjhAwBxxGugujU4vzELbUMBF2s4rmXhb4/ApjoUbtD1VPblTh3NDbQspo2UDmRIaQQ2ju5KJhZzdEe5VqVwtcbCD4hZmpBseqAodDY9FWILGhF02nOfxjloqusGwC0wcUAjnil7AO+I2bm2Pwrm/SXslB2hPfPxOeyaz0IMtCVzg3EeCcRHugrc/p73/WOp40x+o/ptZr3lMd/RFR570x+N/ks1FYi1cDUq7l32pw7jKmKDtqtvuzM+vOWV+XnQge2i+B2u+MUSBvLArrbzHhA7dREfdTmfhvZNQ+ZlgMpFaZSG7pyC9E7G9RQ7f6az1bReRWa7hyDzBeHwbHj29cHkhclzv4IF1cODFA3LTafXFdGjy287BEDLdZRHGQvTib44vXLTtQerDWaCAXcbLH/+LXQZ3OuAZ0phEDNGqcgyj5YaDQrsy4A5sie/9gaeMijDaFbsfUIsOsDaXp5Ydlc3dO/EXLIop5K5G6TbNYm8bhoST0DW1SeVUE/ngButBO89Df+oBT9xkOvOhwq+JycOEh+5mEC6H96gNLnJqyjvfbR6pR1nMYWDOd8qtmDS4WpudwLgQLbD9ETnAUn673mhSkB/DFId9/3DICsLjBwc28yitVwfUFErPiOCEq9wNJHbDgT94znhIUFt1q4FYIPcaatZ5eoTpeoYPwISLlNOEI2FCvRo7xgmkmmwIpMK8jWaU+PUUcZvVGsZhycrY8zeBaT8uVWXji2hfGizWx94o6hWBbg698Q8uhibfdhlFIdlP+lodpmWK4gooUmCsFKy7HelCOivW71QItiyi6H+nwnuIGbPWv3LpTWMgX1KMnrXixzGqKHffx7Q/pZcj1T7HJ4BSQVz/heKxnX7xjvjdqs9bS0GPg5lJeZabJT7MHP0jxcszzbHMo/hGxRKryyKks1WhXOimrJTv9Gn7xCNBl/Ftv1B/o/M3XcJv2pXF4yCLJjj0chCVRLTL/47GD7WOHwD9JjXyP+KDJuoUwKp/lyrHZEX8o2cwJvrsY5+jrq3BPUDxHgr6vXU0yzkFO/q/7hZz+o+7xSNmmEvZYfRStnmVVxtvUrQ5Nutpcv6PS6X/koJpyja82PXWQ1yFhCA1qXdgs0U9W0iTPNzRMtxF3XCN1heB2JEgnU9Nm3mLinHyBpsBAFWef8sPk1NuYu+YutwwbmvkEc2F1VnKFZmuCIQrjEPE4n0ar3esszs/hpL1flFHamNtmXsKj+FWmVi3x5o1EaktKafQRpGj5LIcboy+m5KwaCt6WjhCRQ88fd7m940yELcEitCbtR4fRS3Cccx07GoszaXtWoJSnU7YdFpEtU226+6P2Q2gbINPfUckNyTHHEfXsGASpXieal9Bg5tlkd6uTHWK2iYOQEuOawIAZGoyqkdDa3gv4cXNgkOand9qjvQ3q+zEo7l6+I6aIFsNu4i6NfcZan9CwdDv7+Gg7+/mfn9r9/o28Ppq8Xyf/ePXjH8Bh7EywA==",
"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/f2a2a844-8a04-49fd-8c23-d6d8980801c6 \
-u 'doctest:4I9HJRTd'
Back to JSON Format
{
"enrollmentId":"f2a2a844-8a04-49fd-8c23-d6d8980801c6",
"creationDate":"2016-09-23T10:36:32.244+02:00",
"additionalData":{
},
"acsURL":"https://acs.my-bank.com",
"amount":1000,
"cardFingerprint":"823644ee8901d9f84d89b7ac3d8c69d874abd6e0",
"currency":"978",
"first6":"444433",
"last4":"1111",
"merchantCountry":"250",
"merchantName":"Marchand 001",
"merchantTransactionIdentifier":"REF001",
"merchantURL":"https://www.ma-boutique.com",
"paReq":"eJzNWWnPo0iS/iulmo9WNbcxLdc74r4xYO5vXOYG22CD+fWTtruqq7trd3tHq9VYRiRBZmSQEfE8kbD/59K1n+75dayG/utn5Bf486e8T4es6ouvn11H+LL7/M+PvVNe85w75untmn/s9Xwc4yL/VGVfP+/iLMVgKvmSIDjyBUfR05cYS5MvBE6g8I4gt3iMfP7Ym7Sdj68BrxZGUvgOiH+b+APM+wu6h75dghmuaRn308c+Ti+MbHzgFAkjyB767XLf5VeZ+4ARHMW28B56X+6h38eZt2drBNYuVfbhcfSsH+lCZv9yfN1Dzx77LJ7yDxRGSBhD4U8I9iuC/Ers9tBLvj8/1dHdcAO6ERjM+KNgD5blClbt8UGRYMT3q32+nIc+Bz3As31v76HfbTvH/Qf8ww/dYiTQDaR7J/jYT1X3o034r+CPAV0v+X6c4uk2foR76LfWPo3v9w+aphm6ZOSSjxXBVyzLrXj6/QPP+uqyz9PqAyaAUeD8GkW3xXCtprJ7mvpHwR56mgK9/PaxP1ZFDya75p9A4PTj18/lNJ1/haB5nn+ZsV+GawGh4EEgmIJAh2ysin98fo/KM7k/DR97Nu6HvkrjtlrjCXhbz6dyyD59n/BnKh37qRWBbJ79AtR+SRG8//KUwBhCfIZ+MOvvaPuzgdcx/jKWIE6BIjs/5U/v5Z9cW/76+R9/CFeuKvJx+nem+Kb+rcGL21v+YUTu0TJ2Wa8bpM2c/anAelUbNnJRAEf92HMPfTcLtH9czO/P/ZtKZNuTE2xeVfcxbMrB6jFNkgx/Hpq+NUbCOvfb0TmbvHkjSmks/JujoFvSFYJgQtREN4XzY2OmU5P7cdkfVy9tW/BwrUvaabHjqcw1JpM8NFc0U4bAi8hBejBX2pfD6IZzwXHrPbLENttR6/HASeO4XHa8mZYb2p56T/Uz5VJTj35oxVqSXDlaLu7lBO8O8ahqY0md8CgrhCtPoH0PH92dxs+QULqHhcKwAMYR6MiFykzrEnQX4PFsY9To73zkEj1KilPlFTkrydgKINN3Frq9K3nhw2wTuZ16QoyNdMptWLoE0LDlrYzW3IIgg8eSPFDLQzaldfY10dveCLJcp4TyulOJJfch1IuvX9+L/sNC79X88fZAQMAUF0/xu8Xm16k6gegGoKHLMjfULEsPl4KeZQbAjcXjIeLYMMTcNWbjuwIS0WlY0wZTNJeyqURqhhnacgWaY666Nc6sFXKeZYn8rHjuyhs6PYo04vJsqfNe0zqWw991Fn7LFr3zunYNj4yS9HabdkSZie096YRRFow27aNziLqFFRhrghrnMLDPCYovEkfHTGF4DK07PBKdU5QvIte4Jz4CdBitLCj3BLNmqUwNnZNno5ZRcF4OnI76T1n9ksE6Ry9GzT/8+j/P9qLgK52GRfZ4EY9ygnEW/1xnmsZlhpvp532VHoCPLPbuUYQvddsS7dilZU+aQI2SibOCs6vSaeLgBIbMLqtLdKfIAXcZD44pSehFU2r4apw8eYwkhm5wvj0L5MiZ82jbB97fIJa6S+zYU0lsi15NtZCQAuKbqDBltMQlzPRWfJXuk7SLB6+dMy+6+Ih2JMNC6B7nGcXs21yG0A65bF12fVxhxyRIKrKzkkeHXcea6Iy3pkKtabpxMfh6QSnqcZDXtb1ii0Cux1s9Cf4Y99QYBtUsZhDTDeqg+zfuLEMNvhnUURTz1tnhtMNs4Om+7lRTcIvDcR5psYVb97KTNfWc525YReKAMYtBktPGmKcMqru2ElSdFtdRlBbmfoq1LMi3oYLyBIRPdKEzNC3WVg08Re+ePs/4mWeg2RJ0Gtw77WauAPFiwyZtSRBwBEcXvKgzr/jIuMLyGcbyDrJumo8ZSjk9X91kw+BzgRsnblp/kkP0gaUtng4ggTkFS8pqzRU3/KMNnftAdZ151svuMemVm5i+iynQxaOnzjSwgB9aP7VX9jjCsD2mMc7I4sgNwy6cHs32lLt+KBi4qbN3ITSxGpFXRUOahjjdKuiUiGo5pYmJaczJyljvTEHE1VSOG8edmJonq5Ti6oZVVmuHreTmvK6Nr45qpEDwQvWBKC9SmDXCmJF3TKc2JBWq/pKX0QLbiXVi5F0idgG6JU6H6Dxrs7sT3ZDvjjQKi8wttGJSaFQ9NdN5s+GS6KLTdIJ1mnGxgy0jVjBy6TmYwixPhPoYGuhhR9Bcp5AnqGSx/FbJfVsyy/ahTRi1W3sdqq/x9oDIZOcg4l04a0VghhI3P0Hxz4j3MwgUxJVlGfrwDQJt2ijh0GEYiFv4QVvFwJ/RnU3PnBUq6hDJ5T01gNs0xqLneOU1nW5eEMGUOut5+sI5tPZO+cFhhEhxYX7RVnp6y0ZHad8wcPQJOAqU2xsqiDJhGQdco7EPYIEX1hSl6tgX4Ninbro9z2LxgiuOXww/DoxSFj0uQZEJjKmjI3NMUArWGTzgANDoXPgwOHCu09loByCTH0+ZXoM60wlnAxnm1Pl/sv0ozzL9zfb2Z7YrKWYgsU/0Mm8wwCeM/BfK4X9Llx39vM8W6it1rk3HErC1EZvOekQo1ajLGck2vYJjyhyUYkTGgoCYlU4cW5Y/Wih68aCWobFZCkNzVyEkJFpWaDCVgN3w67a+BbIkzPV8Vx+CLmybjgmDe2rFOzMjCYFFeux0kq8lX2/aLOlAYb6qcGmewkfARxfuLJXNre/uHHlZEYb3VZ403NATbP40nL3q1KqVF6XhVapIVqFzxgjJ7FHcO1nvJTeXcGPijsTlBPUUZ1mnk/foiVLxK8LMmR3ZO+302K1ZXaFTTfY0ugkxU1NtxcUeiJyk5UVs++CyxLF6ahzNGKvoQpnOrMbXh7S5ddgUnIgb3t3a1RYPfom6G7fBtX7qdIFNIO2iNH7vevlmljnaopkBUM/4LA9ifJbmF/TVDFPMwkC7glNx3LobTYxepRERoSLX5QMXzGQ682+YdN4wWcxM8YRRkFscTTzjSDrS/CsOWVxk/JyhAczqrDvLcyircwhQ1JUAtPoCWsKZRG+1B4VlWHrLXvRL1AkK31NxOr/i4G0XQB2gv2YZaKXRgTsW+hDOsWTDKTfcNdi7pR01JiyBPmMvRPlbiFKT9qJjgbP8H2LRe9HxLcSUUecexeFC42UdDZlkz4dqd8+AJVrX3jJxftvjG6XWATo/UnXazfdXieAazI8U73bUPWOJ5/25COOiCA/gYMVTtzRh8Ho+IenBvH/W6QzrgWvuIYpTv5UerQXsTnzv8Sw13nqXu+m98nRMMJf6N0oUKERBUSy2Hchd0N87RkEE5nznriO2a8bRh5ffrN2TBkFdooPcC2fJeq39gWFCXjAgTm3dmwbL27xhs+bCYTbWBzWeq38ua9j5XdbQFkOFG4GiplKiD+USDVbqUGzCDr3HTkmHlX57QntG6W+xlQ+nKTuo/lTD4cGpSdON1YN/mtMkOkrMFrvqnVZ5HRldZK/P/OXOMLaGOGmRzHHB9VpBXy1dlfoQvYnWyax5gHx03/t5qJyyTWor3rBVMRtnEktchaMUoxUaX7fQEKyy8YgXOsgGEcbZFTVhs9siGADMcy08wqo9QjhAwBxxGugujU4vzELbUMBF2s4rmXhb4/ApjoUbtD1VPblTh3NDbQspo2UDmRIaQQ2ju5KJhZzdEe5VqVwtcbCD4hZmpBseqAodDY9FWILGhF02nOfxjloqusGwC0wcUAjnil7AO+I2bm2Pwrm/SXslB2hPfPxOeyaz0IMtCVzg3EeCcRHugrc/p73/WOp40x+o/ptZr3lMd/RFR570x+N/ks1FYi1cDUq7l32pw7jKmKDtqtvuzM+vOWV+XnQge2i+B2u+MUSBvLArrbzHhA7dREfdTmfhvZNQ+ZlgMpFaZSG7pyC9E7G9RQ7f6az1bReRWa7hyDzBeHwbHj29cHkhclzv4IF1cODFA3LTafXFdGjy287BEDLdZRHGQvTib44vXLTtQerDWaCAXcbLH/+LXQZ3OuAZ0phEDNGqcgyj5YaDQrsy4A5sie/9gaeMijDaFbsfUIsOsDaXp5Ydlc3dO/EXLIop5K5G6TbNYm8bhoST0DW1SeVUE/ngButBO89Df+oBT9xkOvOhwq+JycOEh+5mEC6H96gNLnJqyjvfbR6pR1nMYWDOd8qtmDS4WpudwLgQLbD9ETnAUn673mhSkB/DFId9/3DICsLjBwc28yitVwfUFErPiOCEq9wNJHbDgT94znhIUFt1q4FYIPcaatZ5eoTpeoYPwISLlNOEI2FCvRo7xgmkmmwIpMK8jWaU+PUUcZvVGsZhycrY8zeBaT8uVWXji2hfGizWx94o6hWBbg698Q8uhibfdhlFIdlP+lodpmWK4gooUmCsFKy7HelCOivW71QItiyi6H+nwnuIGbPWv3LpTWMgX1KMnrXixzGqKHffx7Q/pZcj1T7HJ4BSQVz/heKxnX7xjvjdqs9bS0GPg5lJeZabJT7MHP0jxcszzbHMo/hGxRKryyKks1WhXOimrJTv9Gn7xCNBl/Ftv1B/o/M3XcJv2pXF4yCLJjj0chCVRLTL/47GD7WOHwD9JjXyP+KDJuoUwKp/lyrHZEX8o2cwJvrsY5+jrq3BPUDxHgr6vXU0yzkFO/q/7hZz+o+7xSNmmEvZYfRStnmVVxtvUrQ5Nutpcv6PS6X/koJpyja82PXWQ1yFhCA1qXdgs0U9W0iTPNzRMtxF3XCN1heB2JEgnU9Nm3mLinHyBpsBAFWef8sPk1NuYu+YutwwbmvkEc2F1VnKFZmuCIQrjEPE4n0ar3esszs/hpL1flFHamNtmXsKj+FWmVi3x5o1EaktKafQRpGj5LIcboy+m5KwaCt6WjhCRQ88fd7m940yELcEitCbtR4fRS3Cccx07GoszaXtWoJSnU7YdFpEtU226+6P2Q2gbINPfUckNyTHHEfXsGASpXieal9Bg5tlkd6uTHWK2iYOQEuOawIAZGoyqkdDa3gv4cXNgkOand9qjvQ3q+zEo7l6+I6aIFsNu4i6NfcZan9CwdDv7+Gg7+/mfn9r9/o28Ppq8Xyf/ePXjH8Bh7EywA==",
"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":"5b053b00-95d3-4192-b9ea-9f7a7c33197f",
"creationDate":"2016-09-30T10:40:09.230+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUtlu2zAQ/BVB7zIP3caKgRvDrQskcC4k6RtNbmwVFuVIVGDn60M6yvXEneViZjlDODs0u+AFu75uTRWyCQ0DNKrVtdlU4d3tIirCoLfSaLlrDVbhEfvwTMDttkOc36AaOhRwgX0vNxjUugqfijjVUvMI1yqPkixhkZRZHK1VuX7SSiuWsVDAanaNzwJGZeGEJxzIB3SMndpKYwVI9fxreSmSMqeMARkhNNgt54KyhMcZBfIOwcgGxULqdpBATgBUOxjbHQVP3dgHgKHbia21+ykhFns7UW1DgPgukC/t1eCr3rEcai3WD7vLfw9//8vfi0Evro+P9+nrzf3VZnk+q4D4CdDSouCUZbSMaUCLaUKntABy6oNsvLxglLpVRgB7rzH7fvO9A87gzgVyFGXueD4R4GHv8nATzrXPGjT2yr1gPL7WP//jjVTWecTNvOiv4mae2lXBkjzlPClokfPSm3sa8eS1c8kl9c7uARBPQsbcyBi5q358hTfMQMDu",
"status":"SUCCESS"
},
{
"enrollmentId":"95653833-f69b-4833-833b-e21e60ee3c13",
"creationDate":"2016-09-30T10:38:47.837+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUtlu2zAQ/BVB7zIvncaKgZvArQvEcJMUOd5ocmsrsCRHogrbX1/SkZvkiTvLxcxyhnB1qHfBX+z6qm3KkE1oGGCjW1M1mzL8/TCP8jDorWqM2rUNluER+/BKwsO2Q7y5Rz10KOEW+15tMKhMGa6TlMeJ4lFWmD9RnHMVFUzwCBORFiJRhV6rUMJqdodvEkZl6YQnHMgFOsZOb1VjJSj99m2xlHGRUcaAjBBq7BY3krKYi5QCeYfQqBrlXJl2UEDOAHQ7NLY7Sp64sQuAodvJrbX7KSEWezvRbU2A+C6QD+3V4KvesRwqI9dPu+XL089X9X0+mPnd8fkxOd0//tosrmclED8BRlmUnLKUFoIGNJ+KfBpnQM59ULWXl4xSt8oIYO81Zp9vPnfAGdy5QI6yyHK3/wUBHvYuDzfhXPtfg8FeuxeMx8f61z+8kdo6j8TrKj7dMv1SnJaMxVnCeZzxTIjMm3se8eSVc4ml7J3dAyCehIy5kTFyV335Cv8Abcy/xQ==",
"status":"SUCCESS"
},
{
"enrollmentId":"1962fbcc-a369-4038-80e3-69e391db1d11",
"creationDate":"2016-09-30T09:35:32.948+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUtlu2zAQ/BVB7zIP3caKgRvDiQMkyNUm7RtNrm0VluSIVGD360vGcpM+cWe5mBnOEi4OzS54x97UXVuFbELDAFvV6brdVOH350VUhIGxstVy17VYhUc04YWA522POH9CNfQo4BaNkRsMal2FqGWeSpZGWioWJUXCIqkKGa35ap2x9YoXeRoKuJ894puAUVk44QkHcoaOsVdb2VoBUr19W96JpMwpY0BGCA32y7mgLOFxRoGcILSyQbGQuhskkA8Aqhta2x8FT93YGcDQ78TW2v2UEIvGTlTXECC+C+RT+37wlXEsh1qL1evu7tfrzW95tRj04vH48yX98/TysFleziogfgK0tCg4ZRktYxrQfBqn09i966MPsvHyglHqrIwA9l5j9vXmawdcwL1byFGUeeH8nxHgYe/24SYc+78aNBrlXjAen/Yvr32QyrqMSvPAhjnd/4jrm4wlecq5M8t56T2dRjx57VJiGTuxewDEk5Bxb2Rcuav++wp/ARniwIY=",
"status":"SUCCESS"
},
{
"enrollmentId":"e3e04a3b-0903-4074-ac82-5046bcc9cb56",
"creationDate":"2016-09-30T09:34:11.659+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUl1T2zAQ/CsevzuS/O3MWUyACU1nYFICA+2bIh2JmdgOttwm/fU9BafAk29P593TruDiUO+839j1VduUvphw38NGt6ZqNqX/+DAPct/rrWqM2rUNlv4Re/9CwsO2Q7xeoR46lHCLfa826FWm9MME16HJXwKdowpiTJOgWEdRYPKYC6FSHRfKl7Cc3eObhFFZkvAkBHaGxNjprWqsBKXfLhd3Mi4y+h3YCKHGbnEtuYjDKOXA3iE0qkY5V6YdFLATAN0Oje2OMkxo7Axg6HZya+1+ypjF3k50WzNgrgvsQ3s5uKonlkNl5Pp5d/fr+furupkPZn5//PmU/F09/dgsrmYlMDcBRlmUIRcpLyLu8WwaxVO39akPqnbyUnBOq4wA9k5j9vnkcwfI4I4COcoiy2n/MwI87CkPmiDX/tdgsNd0g/Hzsf7VN2ektuRRZFbFn2U23PL1iuzLkjDkeSJ4UThzTyOOvCKXRCre2R0A5kjYmBsbI6fqy1P4B3CYwDE=",
"status":"SUCCESS"
},
{
"enrollmentId":"c229291b-3598-4aaf-845e-5e79718137d4",
"creationDate":"2016-09-30T09:27:39.362+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUtlu2zAQ/BVB7zIP6zRWDJwEbl20gZO4iNs3hlzbCnQ4IlXY/fqSjpykT9xZLmaWM4SrY1MHf7A3VdeWIZvQMMBWdbpqd2X4c72I8jAwVrZa1l2LZXhCE14JWO97xNtHVEOPAn6gMXKHQaXLkDPNaI48kirnUTxVaVTEWkbpFp+zmOp4m8hQwGr+gK8CRmXhhCccyAU6xl7tZWsFSPV6vbwTcZFRxoCMEBrsl7eCsphPUwrkDUIrGxQLqbtBAjkDUN3Q2v4keOLGLgCGvhZ7aw8zQiwaO1FdQ4D4LpAP7dXgK+NYjpUWz5v67vfm24v8shj04uH06yn5+/h0v1vezEsgfgK0tCg4ZSktpjSg2Yxns2kB5NwH2Xh5wSh1q4wADl5j/vnmcwecwb0L5CSKLHf7XxDg8eDycBPOtfcaNBrlXjAeH+vffPVGKus8YttNUX+PzSqt1gmLs4RzGid5lmfe3POIJ6+cSyxlb+weAPEkZMyNjJG76r+v8A9igMBC",
"status":"SUCCESS"
},
{
"enrollmentId":"888e3113-8156-475f-be2c-3aa564da50cd",
"creationDate":"2016-09-30T09:27:33.107+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUtlOwzAQ/JUo76mPJE1SbYwKqFAkEHeBN9fetkFN0iYOavl67JJyPHlnvZpZzxhOduXa+8CmLeoq99mA+h5WqtZFtcz9p8dJkPpea2Sl5bquMPf32PonAh5XDeL5A6quQQHX2LZyiV6hc19pmjIVqiDVyIJIUR5kc7oItF6kfE4xk6n0BdyO73EroFcWVnjAgRyhZWzUSlZGgFTb0+mNiLKEMgakh1BiMz0XlEU8HFIg3xAqWaKYSF13EsgBgKq7yjR7wWM7dgTQNWuxMmYzIsRgawaqLgkQ1wXyq33buaq1LLtCi/nL+ubt5epdXkw6Pbnfv87iz4fZ3XJ6Ns6BuAnQ0qDglA1pFlKPJiOejEL7rkMfZOnkBaPUrtID2DiN8d+bvx2wBjc2kL3IktTuf0SAu43Nw05Y9p8aNLbKvqA/ftc/u3RGKmM9Cs04ktN0MRtun2MWJTHnNIp5lEXO3MOIIy+sS2zIvtkdAOJISJ8b6SO31b+v8AVn8MCs",
"status":"SUCCESS"
},
{
"enrollmentId":"b0a8a655-1b7d-430a-b165-8e868c2978fd",
"creationDate":"2016-09-30T09:27:25.683+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUl1v2zAM/CuG3x19xHbsglaRtciWDS26tkOzvSkSm3iI7VSWt2S/flTqrB0gQDyKuCOPgstDs4t+oevrrq1iMeFxhK3pbN1uqvjb4yIp4qj3urV617VYxUfs40sFj1uHeP2AZnCo4Ab7Xm8wqm0VP09tyUU+TUq5xiRd2zwp9HOWlLbIijzjpUEeK7ib3+OLglFZkfBEAjtDYnRmq1uvQJuXD8tblZYzLgSwEUKDbnmtuEjlNOfAXiG0ukG10LYbNLATANMNrXdHJTMqOwMY3E5tvd9fMOax9xPTNQxYyAJ7074bQtQTy6G2ar3a3f5Yff6pPy4Gu7g/fn/K/jw8fd0sr+YVsFABVntUksbn5ZRHfHYh6WTATnnQTZBXgnNqZQSwDxrz9y/vM0AGO1rIUZWzgvo/I8DDnvZBFeTavxgs9oYmGK+39q8+BSONJ4+E+yL9iv++SXFJ9s0yKXmaZryQwdxTSSCvySWRi1f2AIAFEjbujY0rp+i/r/AX2EC/2w==",
"status":"SUCCESS"
},
{
"enrollmentId":"3f84c83e-c31a-402f-ab08-e977574cb0ed",
"creationDate":"2016-09-30T09:27:19.528+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUttymzAQ/RWGd6yLwYBnUcZNSuvONJPmMrm8CWlt0zHgINEx+fpKDm7SJ+1Z7ZyzOkdwcWz2wR/sTd21RchmNAywVZ2u220RPtyXURYGxspWy33XYhGOaMILAfe7HvHqDtXQo4CfaIzcYlDrItTVhqUKVbRJZRXFuUwiOU9lxKqN5otNVVWxDgXcrG7xVcCkLJzwjAM5Q8fYq51srQCpXr+sr0Wcp5QxIBOEBvv1laAs5vMFBfIOoZUNilLqbpBATgBUN7S2HwVP3NgZwNDvxc7aw5IQi8bOVNcQIL4L5EP7ZvCVcSzHWovqaX/98vTjt/xWDrq8HZ8fk7e7x1/b9eWqAOInQEuLglO2oPmcBjRd8nTJciCnPsjGywtGqVtlAnDwGqvPN5874AzuXSCjyNPM7X9GgMeDy8NNONf+1aDRKPeC6fhY//K7N1JZ51EyfuXjAzVlVpUpi9OEcxrPsyzj3tzTiCevnUtswd7ZPQDiSciUG5kid9V/X+Ev5fPBfA==",
"status":"SUCCESS"
},
{
"enrollmentId":"751b8a31-6a43-4a41-9515-c037f7354dff",
"creationDate":"2016-09-30T09:27:13.979+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUtlu2zAQ/BVB7zIP0ZJlrBi4MdS6QAI3d/rGkBtbhQ5HogI7X1/SkXM8cWe5mFnOEM72dRW8YteXbZOHbELDABvdmrLZ5OHtTRHNwqC3qjGqahvMwwP24ZmEm22HuLxGPXQo4QL7Xm0wKE0eakxNlnKMMiqSSJgnE810kkQqFjqj0+dnnZlQwnpxhS8SRmXphCccyAk6xk5vVWMlKP3yY3UpRZZSxoCMEGrsVktJmeBxQoG8Q2hUjbJQph0UkCMA3Q6N7Q6ST93YCcDQVXJr7W5OiMXeTnRbEyC+C+RTez34qncs+9LIp4fq8u/D73/qZzGY4urweD99u77/s1mdL3IgfgKMsig5ZQnNYhrQdM7TOYuBHPugai8vGaVulRHAzmssvt587YAzuHOBHGSWztz+JwS437k83IRz7aMGg712LxiPz/XPf3kjtXUezYY7sbtl1ZJti5iJdMo5FXHMM+HNPY548tK5xBL2zu4BEE9CxtzIGLmrvn2F/+0awGo=",
"status":"SUCCESS"
},
{
"enrollmentId":"65381529-de53-4e50-88f1-c3ed32ef6dac",
"creationDate":"2016-09-30T09:27:05.659+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUl1v4jAQ/CtR3oPXJiQEbVxxRbRUatXrh0rvzbUXSEUSSJwK7tefTcO1ffLOejWznjFeHMpt8EFNW9RVHvIBhAFVujZFtc7D56d5NA6D1qrKqG1dUR4eqQ0vJD5tGqLZI+muIYm31LZqTUFh8hBi80bjbBWJ8TCJYkUQZcB1RLFQsFqZRGQmlHg/faC9xF5ZOuGBQHaGjrHRG1VZiUrvfy3uZJylwDmyHmJJzWImgcdimACyT4iVKknOlak7hewEUNddZZujFCM3dgbYNVu5sXY3YcxSawe6Lhky30X2pX3f+ap1LIfCyLfl9u7P8uZdXc07M384vr6M/j6+/F4vLqc5Mj+BRlmSAngC2RACSCcincAI2amPqvTykgO4VXqAO68x/X7zvYPO4MYFcpRZOnb7nxHSYefycBPOtf81Gmq1e0F* Connection #0 to host api.centralpay.dev left intact
/fK1/ee2N1NZb9vEq7G28Xya7WcrjdCQExM4cSL25pxFPXjiXeMI/2T1A5klYnxvrI3fVj6/wD2/iwD8=",
"status":"SUCCESS"
}
],
"totalCount":1516
}
List enrollments
This function allows you to search objects from a multi-criteria search.
« 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":"5b053b00-95d3-4192-b9ea-9f7a7c33197f",
"creationDate":"2016-09-30T10:40:09.230+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUtlu2zAQ/BVB7zIP3caKgRvDrQskcC4k6RtNbmwVFuVIVGDn60M6yvXEneViZjlDODs0u+AFu75uTRWyCQ0DNKrVtdlU4d3tIirCoLfSaLlrDVbhEfvwTMDttkOc36AaOhRwgX0vNxjUugqfijjVUvMI1yqPkixhkZRZHK1VuX7SSiuWsVDAanaNzwJGZeGEJxzIB3SMndpKYwVI9fxreSmSMqeMARkhNNgt54KyhMcZBfIOwcgGxULqdpBATgBUOxjbHQVP3dgHgKHbia21+ykhFns7UW1DgPgukC/t1eCr3rEcai3WD7vLfw9//8vfi0Evro+P9+nrzf3VZnk+q4D4CdDSouCUZbSMaUCLaUKntABy6oNsvLxglLpVRgB7rzH7fvO9A87gzgVyFGXueD4R4GHv8nATzrXPGjT2yr1gPL7WP//jjVTWecTNvOiv4mae2lXBkjzlPClokfPSm3sa8eS1c8kl9c7uARBPQsbcyBi5q358hTfMQMDu",
"status":"SUCCESS"
},
{
"enrollmentId":"95653833-f69b-4833-833b-e21e60ee3c13",
"creationDate":"2016-09-30T10:38:47.837+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUtlu2zAQ/BVB7zIvncaKgZvArQvEcJMUOd5ocmsrsCRHogrbX1/SkZvkiTvLxcxyhnB1qHfBX+z6qm3KkE1oGGCjW1M1mzL8/TCP8jDorWqM2rUNluER+/BKwsO2Q7y5Rz10KOEW+15tMKhMGa6TlMeJ4lFWmD9RnHMVFUzwCBORFiJRhV6rUMJqdodvEkZl6YQnHMgFOsZOb1VjJSj99m2xlHGRUcaAjBBq7BY3krKYi5QCeYfQqBrlXJl2UEDOAHQ7NLY7Sp64sQuAodvJrbX7KSEWezvRbU2A+C6QD+3V4KvesRwqI9dPu+XL089X9X0+mPnd8fkxOd0//tosrmclED8BRlmUnLKUFoIGNJ+KfBpnQM59ULWXl4xSt8oIYO81Zp9vPnfAGdy5QI6yyHK3/wUBHvYuDzfhXPtfg8FeuxeMx8f61z+8kdo6j8TrKj7dMv1SnJaMxVnCeZzxTIjMm3se8eSVc4ml7J3dAyCehIy5kTFyV335Cv8Abcy/xQ==",
"status":"SUCCESS"
},
{
"enrollmentId":"1962fbcc-a369-4038-80e3-69e391db1d11",
"creationDate":"2016-09-30T09:35:32.948+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUtlu2zAQ/BVB7zIP3caKgRvDiQMkyNUm7RtNrm0VluSIVGD360vGcpM+cWe5mBnOEi4OzS54x97UXVuFbELDAFvV6brdVOH350VUhIGxstVy17VYhUc04YWA522POH9CNfQo4BaNkRsMal2FqGWeSpZGWioWJUXCIqkKGa35ap2x9YoXeRoKuJ894puAUVk44QkHcoaOsVdb2VoBUr19W96JpMwpY0BGCA32y7mgLOFxRoGcILSyQbGQuhskkA8Aqhta2x8FT93YGcDQ78TW2v2UEIvGTlTXECC+C+RT+37wlXEsh1qL1evu7tfrzW95tRj04vH48yX98/TysFleziogfgK0tCg4ZRktYxrQfBqn09i966MPsvHyglHqrIwA9l5j9vXmawdcwL1byFGUeeH8nxHgYe/24SYc+78aNBrlXjAen/Yvr32QyrqMSvPAhjnd/4jrm4wlecq5M8t56T2dRjx57VJiGTuxewDEk5Bxb2Rcuav++wp/ARniwIY=",
"status":"SUCCESS"
},
{
"enrollmentId":"e3e04a3b-0903-4074-ac82-5046bcc9cb56",
"creationDate":"2016-09-30T09:34:11.659+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUl1T2zAQ/CsevzuS/O3MWUyACU1nYFICA+2bIh2JmdgOttwm/fU9BafAk29P593TruDiUO+839j1VduUvphw38NGt6ZqNqX/+DAPct/rrWqM2rUNlv4Re/9CwsO2Q7xeoR46lHCLfa826FWm9MME16HJXwKdowpiTJOgWEdRYPKYC6FSHRfKl7Cc3eObhFFZkvAkBHaGxNjprWqsBKXfLhd3Mi4y+h3YCKHGbnEtuYjDKOXA3iE0qkY5V6YdFLATAN0Oje2OMkxo7Axg6HZya+1+ypjF3k50WzNgrgvsQ3s5uKonlkNl5Pp5d/fr+furupkPZn5//PmU/F09/dgsrmYlMDcBRlmUIRcpLyLu8WwaxVO39akPqnbyUnBOq4wA9k5j9vnkcwfI4I4COcoiy2n/MwI87CkPmiDX/tdgsNd0g/Hzsf7VN2ektuRRZFbFn2U23PL1iuzLkjDkeSJ4UThzTyOOvCKXRCre2R0A5kjYmBsbI6fqy1P4B3CYwDE=",
"status":"SUCCESS"
},
{
"enrollmentId":"c229291b-3598-4aaf-845e-5e79718137d4",
"creationDate":"2016-09-30T09:27:39.362+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUtlu2zAQ/BVB7zIP6zRWDJwEbl20gZO4iNs3hlzbCnQ4IlXY/fqSjpykT9xZLmaWM4SrY1MHf7A3VdeWIZvQMMBWdbpqd2X4c72I8jAwVrZa1l2LZXhCE14JWO97xNtHVEOPAn6gMXKHQaXLkDPNaI48kirnUTxVaVTEWkbpFp+zmOp4m8hQwGr+gK8CRmXhhCccyAU6xl7tZWsFSPV6vbwTcZFRxoCMEBrsl7eCsphPUwrkDUIrGxQLqbtBAjkDUN3Q2v4keOLGLgCGvhZ7aw8zQiwaO1FdQ4D4LpAP7dXgK+NYjpUWz5v67vfm24v8shj04uH06yn5+/h0v1vezEsgfgK0tCg4ZSktpjSg2Yxns2kB5NwH2Xh5wSh1q4wADl5j/vnmcwecwb0L5CSKLHf7XxDg8eDycBPOtfcaNBrlXjAeH+vffPVGKus8YttNUX+PzSqt1gmLs4RzGid5lmfe3POIJ6+cSyxlb+weAPEkZMyNjJG76r+v8A9igMBC",
"status":"SUCCESS"
},
{
"enrollmentId":"888e3113-8156-475f-be2c-3aa564da50cd",
"creationDate":"2016-09-30T09:27:33.107+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUtlOwzAQ/JUo76mPJE1SbYwKqFAkEHeBN9fetkFN0iYOavl67JJyPHlnvZpZzxhOduXa+8CmLeoq99mA+h5WqtZFtcz9p8dJkPpea2Sl5bquMPf32PonAh5XDeL5A6quQQHX2LZyiV6hc19pmjIVqiDVyIJIUR5kc7oItF6kfE4xk6n0BdyO73EroFcWVnjAgRyhZWzUSlZGgFTb0+mNiLKEMgakh1BiMz0XlEU8HFIg3xAqWaKYSF13EsgBgKq7yjR7wWM7dgTQNWuxMmYzIsRgawaqLgkQ1wXyq33buaq1LLtCi/nL+ubt5epdXkw6Pbnfv87iz4fZ3XJ6Ns6BuAnQ0qDglA1pFlKPJiOejEL7rkMfZOnkBaPUrtID2DiN8d+bvx2wBjc2kL3IktTuf0SAu43Nw05Y9p8aNLbKvqA/ftc/u3RGKmM9Cs04ktN0MRtun2MWJTHnNIp5lEXO3MOIIy+sS2zIvtkdAOJISJ8b6SO31b+v8AVn8MCs",
"status":"SUCCESS"
},
{
"enrollmentId":"b0a8a655-1b7d-430a-b165-8e868c2978fd",
"creationDate":"2016-09-30T09:27:25.683+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUl1v2zAM/CuG3x19xHbsglaRtciWDS26tkOzvSkSm3iI7VSWt2S/flTqrB0gQDyKuCOPgstDs4t+oevrrq1iMeFxhK3pbN1uqvjb4yIp4qj3urV617VYxUfs40sFj1uHeP2AZnCo4Ab7Xm8wqm0VP09tyUU+TUq5xiRd2zwp9HOWlLbIijzjpUEeK7ib3+OLglFZkfBEAjtDYnRmq1uvQJuXD8tblZYzLgSwEUKDbnmtuEjlNOfAXiG0ukG10LYbNLATANMNrXdHJTMqOwMY3E5tvd9fMOax9xPTNQxYyAJ7074bQtQTy6G2ar3a3f5Yff6pPy4Gu7g/fn/K/jw8fd0sr+YVsFABVntUksbn5ZRHfHYh6WTATnnQTZBXgnNqZQSwDxrz9y/vM0AGO1rIUZWzgvo/I8DDnvZBFeTavxgs9oYmGK+39q8+BSONJ4+E+yL9iv++SXFJ9s0yKXmaZryQwdxTSSCvySWRi1f2AIAFEjbujY0rp+i/r/AX2EC/2w==",
"status":"SUCCESS"
},
{
"enrollmentId":"3f84c83e-c31a-402f-ab08-e977574cb0ed",
"creationDate":"2016-09-30T09:27:19.528+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUttymzAQ/RWGd6yLwYBnUcZNSuvONJPmMrm8CWlt0zHgINEx+fpKDm7SJ+1Z7ZyzOkdwcWz2wR/sTd21RchmNAywVZ2u220RPtyXURYGxspWy33XYhGOaMILAfe7HvHqDtXQo4CfaIzcYlDrItTVhqUKVbRJZRXFuUwiOU9lxKqN5otNVVWxDgXcrG7xVcCkLJzwjAM5Q8fYq51srQCpXr+sr0Wcp5QxIBOEBvv1laAs5vMFBfIOoZUNilLqbpBATgBUN7S2HwVP3NgZwNDvxc7aw5IQi8bOVNcQIL4L5EP7ZvCVcSzHWovqaX/98vTjt/xWDrq8HZ8fk7e7x1/b9eWqAOInQEuLglO2oPmcBjRd8nTJciCnPsjGywtGqVtlAnDwGqvPN5874AzuXSCjyNPM7X9GgMeDy8NNONf+1aDRKPeC6fhY//K7N1JZ51EyfuXjAzVlVpUpi9OEcxrPsyzj3tzTiCevnUtswd7ZPQDiSciUG5kid9V/X+Ev5fPBfA==",
"status":"SUCCESS"
},
{
"enrollmentId":"751b8a31-6a43-4a41-9515-c037f7354dff",
"creationDate":"2016-09-30T09:27:13.979+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUtlu2zAQ/BVB7zIP0ZJlrBi4MdS6QAI3d/rGkBtbhQ5HogI7X1/SkXM8cWe5mFnOEM72dRW8YteXbZOHbELDABvdmrLZ5OHtTRHNwqC3qjGqahvMwwP24ZmEm22HuLxGPXQo4QL7Xm0wKE0eakxNlnKMMiqSSJgnE810kkQqFjqj0+dnnZlQwnpxhS8SRmXphCccyAk6xk5vVWMlKP3yY3UpRZZSxoCMEGrsVktJmeBxQoG8Q2hUjbJQph0UkCMA3Q6N7Q6ST93YCcDQVXJr7W5OiMXeTnRbEyC+C+RTez34qncs+9LIp4fq8u/D73/qZzGY4urweD99u77/s1mdL3IgfgKMsig5ZQnNYhrQdM7TOYuBHPugai8vGaVulRHAzmssvt587YAzuHOBHGSWztz+JwS437k83IRz7aMGg712LxiPz/XPf3kjtXUezYY7sbtl1ZJti5iJdMo5FXHMM+HNPY548tK5xBL2zu4BEE9CxtzIGLmrvn2F/+0awGo=",
"status":"SUCCESS"
},
{
"enrollmentId":"65381529-de53-4e50-88f1-c3ed32ef6dac",
"creationDate":"2016-09-30T09:27:05.659+02:00",
"additionalData":{
},
"acsURL":"https://netsafe.hdfcbank.com/ACSWeb/com.enstage.entransact.servers.AccessControlServerSSL?ty=V",
"amount":1000,
"cardFingerprint":"ba39a864fb0919878ea6d132f38b93992be0b399",
"currency":"978",
"first6":"461787",
"last4":"9012",
"merchantCountry":"250",
"merchantName":"Fadoua",
"merchantTransactionIdentifier":"myMerchantTransId",
"merchantURL":"http://test.com/",
"paReq":"eJxVUl1v4jAQ/CtR3oPXJiQEbVxxRbRUatXrh0rvzbUXSEUSSJwK7tefTcO1ffLOejWznjFeHMpt8EFNW9RVHvIBhAFVujZFtc7D56d5NA6D1qrKqG1dUR4eqQ0vJD5tGqLZI+muIYm31LZqTUFh8hBi80bjbBWJ8TCJYkUQZcB1RLFQsFqZRGQmlHg/faC9xF5ZOuGBQHaGjrHRG1VZiUrvfy3uZJylwDmyHmJJzWImgcdimACyT4iVKknOlak7hewEUNddZZujFCM3dgbYNVu5sXY3YcxSawe6Lhky30X2pX3f+ap1LIfCyLfl9u7P8uZdXc07M384vr6M/j6+/F4vLqc5Mj+BRlmSAngC2RACSCcincAI2amPqvTykgO4VXqAO68x/X7zvYPO4MYFcpRZOnb7nxHSYefycBPOtf81Gmq1e0F* Connection #0 to host api.centralpay.dev left intact
/fK1/ee2N1NZb9vEq7G28Xya7WcrjdCQExM4cSL25pxFPXjiXeMI/2T1A5klYnxvrI3fVj6/wD2/iwD8=",
"status":"SUCCESS"
}
],
"totalCount":1516
}
RECURRING
Recurring
Subscription Model
A Subscription Model contains the details of the pricing information for your different products and feature levels. For example, you can have a €30 /month plan for basic offer and a different €100 /month subscription model (plan) for your premium offer.
Subscription Model
A Subscription Model contains the details of the pricing information for your different products and feature levels. For example, you can have a €30 /month plan for basic offer and a different €100 /month subscription model (plan) for your premium offer.
Subscription Model object
The Json "Subscription Model" Object
The "Subscription Model" object response represents a model of subscription.
| subscriptionModelId String (36) |
Subscription Model ID Note: UUID Format |
|
| creationDate OffsetDateTime |
Creation date | |
| merchantSubscriptionModelId String |
Merchant ID | |
| pointOfSaleId UUID |
POS ID | |
| contractId UUID |
Contract ID | |
| amount Number |
Montant unitaire des échéances | |
| currency String |
Devise Note: Format préféré |
|
| name String |
Display name | |
| description String |
Description | |
| intervalUnit Enum IntervalUnit |
Interval unit | |
| intervalCount Integer |
Number of intervals | |
| iterationCount Integer |
Number of interation Note : by default infinite > 1 if DAY : <= 365 if WEEK : <= 50 if MONTH : <= 24 if YEAR : <= 5 |
|
| additionalData[*] Map |
Merchant data |
Exemple of curl code
curl -v https://test-api.centralpay.net/v2/rest/subscriptionModel \
-u 'doctest:4I9HJRTd' \
-d amount=2990 \
-d currency='EUR' \
-d name=Abonnement_Test \
-d intervalUnit=MONTH
-d intervalCount=1
-d interationCount=12
Back to JSON Format
{
"subscriptionModelId":"6b380c8f-9bd5-404a-92c9-314eff24ddbf",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-28T15:59:53.639+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":2990,
"currency":"EUR",
"name":"Abonnement_Test",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"interationCount":12,
"additionalData":{
}
}
Create a subscription model
This function allows you to create a model of subscription.
This function allows you to create a Subscription model
| merchantSubscriptionModelId UUID (36) |
CentralPay Merchand Subscription Model ID Required: no |
|
pointOfSaleId UUID (36) |
CentralPay Point Of Sale ID
Required: no |
| customerId UUID (36) |
CentralPay Client ID Required: yes |
| contractId UUID (36) |
CentralPay Contract ID Required: no |
| amount | Amount Required: yes |
| currency | Currency Required: yes |
| name | Display name Required: yes |
| description | Description Required: no |
| intervalUnit | Unit of interval
Required: yesValue must be DAY / WEEK / MONTH / YEAR |
| intervalCount | Number of interval
Required: no Default value is '1' |
| interationCount | Number of iteration
Required: no Infinite by default |
| 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/subscriptionModel \
-u 'doctest:4I9HJRTd' \
-d amount=2990 \
-d currency='EUR' \
-d name=Abonnement_Test \
-d intervalUnit=MONTH
-d intervalCount=1
-d interationCount=12
Back to JSON Format
{
"subscriptionModelId":"6b380c8f-9bd5-404a-92c9-314eff24ddbf",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-28T15:59:53.639+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":2990,
"currency":"EUR",
"name":"Abonnement_Test",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"interationCount":12,
"additionalData":{
}
}
Example of html code
curl -v https://test-api.centralpay.net/v2/rest/subscriptionModel/f76ebdc7-1203-40ff-8105-f06607af2bee \
-u 'junit7:A45J!wx1@145' \
-d name=cpfmi
Back to Json format
{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
}
Update a Subscription Model
This function allows you to update a Subscription Model
| subscriptionModelId (URL) SubscriptionModel |
Subscription Model ID Required: yes Validation: Existing UUID belong to the merchant |
| merchantSubscriptionModelId String |
Merchant ID Required: no Validation: .{0,100} Unset with null value |
| name String |
Display name Required: no Validation: .{3,100} |
| description String |
Description Required: no Validation: .{0,256} Unset with null value |
| additionalData String (303) |
Merchant data
Required: no |
Example of html code
curl -v https://test-api.centralpay.net/v2/rest/subscriptionModel/f76ebdc7-1203-40ff-8105-f06607af2bee \
-u 'junit7:A45J!wx1@145' \
-d name=cpfmi
Back to Json format
{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
}
HTTP Request
GET https://test-api.centralpay.net/v2/rest/subscriptionModel/<subscriptionModelId>
Example of curl code
curl -G -v --noproxy '*' --insecure https://test-api.centralpay.net/v2/rest/subscriptionModel/f76ebdc7-1203-... \ -u 'junit7:A45J!wx1@145'
Back to Json format
{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
}
Retrieve a Subscription Model
This function allows tou to retrieve a Subscription Model
| subscriptionModelId (URL) SubscriptionModel |
Subscription Model ID Required: yes Validation: Existing UUID belong to the merchant |
HTTP Request
GET https://test-api.centralpay.net/v2/rest/subscriptionModel/<subscriptionModelId>
Example of curl code
curl -G -v --noproxy '*' --insecure https://test-api.centralpay.net/v2/rest/subscriptionModel/f76ebdc7-1203-... \ -u 'junit7:A45J!wx1@145'
Back to Json format
{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
}
Example of curl code
curl https://test-api.centralpay.net/v2/rest/subscriptionModel?merchantSubscriptionModelId= \
-u 'junit7:A45J!wx1@145'
List Subscription Models
This function allows you to list Subscription Models
| merchantSubscriptionModelId String |
Merchant ID Required: no Validation: .{0,100} |
Example of curl code
curl https://test-api.centralpay.net/v2/rest/subscriptionModel?merchantSubscriptionModelId= \
-u 'junit7:A45J!wx1@145'
Subscription
Subscriptions allow you to charge a customer's card on a recurring basis. it represents recurring payment that will be automatically charged on a customer you've previously created. Frequency and amount are defined by a SubscriptionModel.
Subscriptions are billed to customer's current default card.
Subscription object
The Json "Subscription" Object
The "Subscription" object response represents a subscription.
| subscriptionId String (36) |
Subscription ID Note: UUID Format |
| creationDate OffsetDateTime |
Creation date |
| merchantSubscriptionId String |
Merchant ID |
| subscriptionModel String |
Subscription model |
| customerId String (36) |
Customer ID |
| endUserIp String |
End user IP |
| cardId Enum RefundStatus |
Card ID |
| quantity Integer |
Quantity |
| startingDate String |
Subscription starting date |
| endingDate Object |
Subscription ending date |
| currentPeriodStart LocalDate |
Current periode starting date |
| currentPeriodEnd LocalDate |
Current periode ending date |
| status SubscriptionStatus |
Statut ACTIVE | CANCELED | FAILURE | UNPAID |
| cancellationDate OffsetDateTime |
Cancellation date ( action ) |
| cancelAtPeriodEnd OffsetDateTime |
Canceled at period end |
| lastInvoice Invoice |
Last date of payment |
| additionalData[*] Map |
merchant data |
Exemple of curl code
curl https://test-api.centralpay.net/v2/rest/subscription \
-u 'junit7:A45J!wx1@145' \
--data-urlencode subscriptionModelId=f76ebdc7-1203-40ff-8105-f06607af2bee \
--data-urlencode customerId=5ce2f9a8-002d-4c41-b812-fffa7d9a9033 \
--data-urlencode endUserIp=100.10.10.10
Back to JSON Format
{
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"creationDate":"2017-03-28T10:33:46.627+02:00",
"merchantSubscriptionId":null,
"subscriptionModel":{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
},
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"cardId":"5385458a-1bf5-4992-b0a2-63ba1a8375d7",
"quantity":1,
"startingDate":"2017-03-28",
"endingDate":null,
"currentPeriodStart":"2017-03-28",
"currentPeriodEnd":"2017-04-27",
"status":"ACTIVE",
"cancellationDate":null,
"cancelAtPeriodEnd":null,
"lastInvoice":{
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"creationDate":"2017-03-28T10:33:46.879+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":500,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"description":null,
"attemptCount":1,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"cd207049-ce35-4df9-9b31-2da91a50e413"
],
"eventReceivedDate":null,
"type":"SUBSCRIPTION",
"additionalData":{
}
},
"additionalData":{
},
"endUserIp":"100.10.10.10"
}
Create a subscription
This function allows you to create a subscription
|
merchantSubscriptionId String(36) |
Merchant ID Required: no Validation: Between 0 and 100 Cette valeur est transmise dans le paramètre HTTP merchantTransactionId lors des transactions |
|
subscriptionModelId SubscriptionModel |
Subscription model ID Required: yes Validation: Existing UUID belong to the merchant Attribut subscriptions dans Customer |
|
customerId Customer |
Customer ID Required: yes Validation: Existing UUID belong to the merchant Attribut subscriptions dans Customer |
|
endUserIp String |
Final customer IP Required: yes Validation: InetAddressValidator |
|
cardId Card |
Card ID Required: no Validation: Existing UUID belog to the customer not expired at StartingDate By default last sutomer card |
|
quantity Number |
Quantity Required: no Validation: Greater or equal to 1 by Default 1 |
|
startingDate LocalDate |
Starting date Required: no Validation: Today or later By default today |
|
additionalData[*] String |
Merchant data Required: no Validation: Key {45} Value {256} |
|
3ds[enrollmentId] UUID |
Enlistment ID Required: no Validation: Existing UUID belong to the customer Si le marchand est passé via notre MPI, juste pour tracer |
|
3ds[paRes] String |
PaRes Required: No Validation: [A-Za-z0-9+\/]{0,10000}={0,2} If empty, is considered as missing |
|
3ds[xid] String |
XID Required: No Validation: .{0,20} If empty, is considered as missing |
|
3ds[cavv] String |
CAVV Required: No Validation: [A-Za-z0-9+\/]{0,45}={0,2} If empty, is considered as missing |
|
3ds[eci] String |
ECI Required: No Validation: [0-9]{2} If empty, is considered as missing |
|
3ds[status] Enum ThreeDSstatus |
Statut Required: No Validation: Y | A | N | U If empty, is considered as missing |
Exemple of curl code
curl https://test-api.centralpay.net/v2/rest/subscription \
-u 'junit7:A45J!wx1@145' \
--data-urlencode subscriptionModelId=f76ebdc7-1203-40ff-8105-f06607af2bee \
--data-urlencode customerId=5ce2f9a8-002d-4c41-b812-fffa7d9a9033 \
--data-urlencode endUserIp=100.10.10.10
Back to JSON Format
{
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"creationDate":"2017-03-28T10:33:46.627+02:00",
"merchantSubscriptionId":null,
"subscriptionModel":{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
},
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"cardId":"5385458a-1bf5-4992-b0a2-63ba1a8375d7",
"quantity":1,
"startingDate":"2017-03-28",
"endingDate":null,
"currentPeriodStart":"2017-03-28",
"currentPeriodEnd":"2017-04-27",
"status":"ACTIVE",
"cancellationDate":null,
"cancelAtPeriodEnd":null,
"lastInvoice":{
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"creationDate":"2017-03-28T10:33:46.879+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":500,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"description":null,
"attemptCount":1,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"cd207049-ce35-4df9-9b31-2da91a50e413"
],
"eventReceivedDate":null,
"type":"SUBSCRIPTION",
"additionalData":{
}
},
"additionalData":{
},
"endUserIp":"100.10.10.10"
}
Example of html code
curl https://test-api.centralpay.net/v2/rest/subscription/8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb \
-u 'junit7:A45J!wx1@145' \
-d merchantSubscriptionId=REF_FMI
Back to Json format
{
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"creationDate":"2017-03-28T10:33:46.627+02:00",
"merchantSubscriptionId":"REF_FMI",
"subscriptionModel":{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
},
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"cardId":"5385458a-1bf5-4992-b0a2-63ba1a8375d7",
"quantity":1,
"startingDate":"2017-03-28",
"endingDate":null,
"currentPeriodStart":"2017-03-28",
"currentPeriodEnd":"2017-04-27",
"status":"ACTIVE",
"cancellationDate":null,
"cancelAtPeriodEnd":null,
"lastInvoice":{
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"creationDate":"2017-03-28T10:33:46.879+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":500,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"description":null,
"attemptCount":1,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"cd207049-ce35-4df9-9b31-2da91a50e413"
],
"eventReceivedDate":null,
"type":"SUBSCRIPTION",
"additionalData":{
}
},
"additionalData":{
},
"endUserIp":"100.10.10.10"
}
Update a subscription
This function allows you to update a subscription.
|
subscriptionId (URL) Subscription |
Subscription ID Required: yes Validation: Existing UUID belong to the merchant |
|
merchantSubscriptionId String(36) |
Merchant ID Required: no Validation: Between 0 and 100 Unset with null value |
|
cardId Card |
Card ID Required: no Validation: Existing UUID belong to the not expired customer |
|
quantity Number |
Quantity Required: no Validation: greater than or equal to 1 Required: no is concidered at the next invoice |
|
additionalData[*] String |
Merchant data Required: no Validation: Key {45} Value {256} Unset with null value |
Example of html code
curl https://test-api.centralpay.net/v2/rest/subscription/8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb \
-u 'junit7:A45J!wx1@145' \
-d merchantSubscriptionId=REF_FMI
Back to Json format
{
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"creationDate":"2017-03-28T10:33:46.627+02:00",
"merchantSubscriptionId":"REF_FMI",
"subscriptionModel":{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
},
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"cardId":"5385458a-1bf5-4992-b0a2-63ba1a8375d7",
"quantity":1,
"startingDate":"2017-03-28",
"endingDate":null,
"currentPeriodStart":"2017-03-28",
"currentPeriodEnd":"2017-04-27",
"status":"ACTIVE",
"cancellationDate":null,
"cancelAtPeriodEnd":null,
"lastInvoice":{
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"creationDate":"2017-03-28T10:33:46.879+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":500,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"description":null,
"attemptCount":1,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"cd207049-ce35-4df9-9b31-2da91a50e413"
],
"eventReceivedDate":null,
"type":"SUBSCRIPTION",
"additionalData":{
}
},
"additionalData":{
},
"endUserIp":"100.10.10.10"
}
Example of curl code
curl https://test-api.centralpay.net/v2/rest/subscription/8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb/cancel \
-u 'junit7:A45J!wx1@145' \
--data-urlencode atPeriodEnd=true<
Back to Json format
{
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"creationDate":"2017-03-28T10:33:46.627+02:00",
"merchantSubscriptionId":"REF_FMI",
"subscriptionModel":{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
},
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"cardId":"5385458a-1bf5-4992-b0a2-63ba1a8375d7",
"quantity":1,
"startingDate":"2017-03-28",
"endingDate":"2017-04-27",
"currentPeriodStart":"2017-03-28",
"currentPeriodEnd":"2017-04-27",
"status":"ACTIVE",
"cancellationDate":"2017-03-28T11:21:50.397+02:00",
"cancelAtPeriodEnd":true,
"lastInvoice":{
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"creationDate":"2017-03-28T10:33:46.879+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":500,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"description":null,
"attemptCount":1,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"cd207049-ce35-4df9-9b31-2da91a50e413"
],
"eventReceivedDate":null,
"type":"SUBSCRIPTION",
"additionalData":{
}
},
"additionalData":{
},
"endUserIp":"100.10.10.10"
}
Cancel a Subscription
This function allows you to cancel a Subscription with the Subscription ID.
|
subscriptionId (URL) Subscription |
Subscription ID Required: yes Validation: Existing UUID belong to the merchant |
|
atPeriodEnd Boolean |
Canceled at current period end Required: no Validation: False if subscription has not start (currentPeriodStart = NULL) False by default |
Example of curl code
curl https://test-api.centralpay.net/v2/rest/subscription/8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb/cancel \
-u 'junit7:A45J!wx1@145' \
--data-urlencode atPeriodEnd=true<
Back to Json format
{
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"creationDate":"2017-03-28T10:33:46.627+02:00",
"merchantSubscriptionId":"REF_FMI",
"subscriptionModel":{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
},
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"cardId":"5385458a-1bf5-4992-b0a2-63ba1a8375d7",
"quantity":1,
"startingDate":"2017-03-28",
"endingDate":"2017-04-27",
"currentPeriodStart":"2017-03-28",
"currentPeriodEnd":"2017-04-27",
"status":"ACTIVE",
"cancellationDate":"2017-03-28T11:21:50.397+02:00",
"cancelAtPeriodEnd":true,
"lastInvoice":{
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"creationDate":"2017-03-28T10:33:46.879+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":500,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"description":null,
"attemptCount":1,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"cd207049-ce35-4df9-9b31-2da91a50e413"
],
"eventReceivedDate":null,
"type":"SUBSCRIPTION",
"additionalData":{
}
},
"additionalData":{
},
"endUserIp":"100.10.10.10"
}
Example of curl code
curl https://test-api.centralpay.net/v2/rest/subscription/8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb/reactivate \
-X POST \
-u 'junit7:A45J!wx1@145' '
Back to Json format
{
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"creationDate":"2017-03-28T10:33:46.627+02:00",
"merchantSubscriptionId":"REF_FMI",
"subscriptionModel":{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
},
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"cardId":"5385458a-1bf5-4992-b0a2-63ba1a8375d7",
"quantity":1,
"startingDate":"2017-03-28",
"endingDate":null,
"currentPeriodStart":"2017-03-28",
"currentPeriodEnd":"2017-04-27",
"status":"ACTIVE",
"cancellationDate":null,
"cancelAtPeriodEnd":null,
"lastInvoice":{
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"creationDate":"2017-03-28T10:33:46.879+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":500,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"description":null,
"attemptCount":1,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"cd207049-ce35-4df9-9b31-2da91a50e413"
],
"eventReceivedDate":null,
"type":"SUBSCRIPTION",
"additionalData":{
}
},
"additionalData":{
},
"endUserIp":"100.10.10.10"
}
Reactivate a Subscription
This function allows you to reactivate a Subscription
|
subscriptionId (URL) Subscription |
Subscription ID Required: yes Validation: Existing UUID belong to the merchant |
Example of curl code
curl https://test-api.centralpay.net/v2/rest/subscription/8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb/reactivate \
-X POST \
-u 'junit7:A45J!wx1@145' '
Back to Json format
{
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"creationDate":"2017-03-28T10:33:46.627+02:00",
"merchantSubscriptionId":"REF_FMI",
"subscriptionModel":{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
},
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"cardId":"5385458a-1bf5-4992-b0a2-63ba1a8375d7",
"quantity":1,
"startingDate":"2017-03-28",
"endingDate":null,
"currentPeriodStart":"2017-03-28",
"currentPeriodEnd":"2017-04-27",
"status":"ACTIVE",
"cancellationDate":null,
"cancelAtPeriodEnd":null,
"lastInvoice":{
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"creationDate":"2017-03-28T10:33:46.879+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":500,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"description":null,
"attemptCount":1,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"cd207049-ce35-4df9-9b31-2da91a50e413"
],
"eventReceivedDate":null,
"type":"SUBSCRIPTION",
"additionalData":{
}
},
"additionalData":{
},
"endUserIp":"100.10.10.10"
}
Example of curl code
curl https://test-api.centralpay.net/v2/rest/subscription/8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb \
-u 'junit7:A45J!wx1@145'
Back to Json format
{
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"creationDate":"2017-03-28T10:33:46.627+02:00",
"merchantSubscriptionId":"REF_FMI",
"subscriptionModel":{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
},
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"cardId":"5385458a-1bf5-4992-b0a2-63ba1a8375d7",
"quantity":1,
"startingDate":"2017-03-28",
"endingDate":null,
"currentPeriodStart":"2017-03-28",
"currentPeriodEnd":"2017-04-27",
"status":"ACTIVE",
"cancellationDate":null,
"cancelAtPeriodEnd":null,
"lastInvoice":{
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"creationDate":"2017-03-28T10:33:46.879+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":500,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"description":null,
"attemptCount":1,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"cd207049-ce35-4df9-9b31-2da91a50e413"
],
"eventReceivedDate":null,
"type":"SUBSCRIPTION",
"additionalData":{
}
},
"additionalData":{
},
"endUserIp":"100.10.10.10"
}
Retrieve a Subscription
This function allows you to retrieve a Subscription
|
subscriptionId (URL) Subscription |
Subscription ID Required: yes Validation: Existing UUID belong to the merchant |
Example of curl code
curl https://test-api.centralpay.net/v2/rest/subscription/8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb \
-u 'junit7:A45J!wx1@145'
Back to Json format
{
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"creationDate":"2017-03-28T10:33:46.627+02:00",
"merchantSubscriptionId":"REF_FMI",
"subscriptionModel":{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
},
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"cardId":"5385458a-1bf5-4992-b0a2-63ba1a8375d7",
"quantity":1,
"startingDate":"2017-03-28",
"endingDate":null,
"currentPeriodStart":"2017-03-28",
"currentPeriodEnd":"2017-04-27",
"status":"ACTIVE",
"cancellationDate":null,
"cancelAtPeriodEnd":null,
"lastInvoice":{
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"creationDate":"2017-03-28T10:33:46.879+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":500,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"description":null,
"attemptCount":1,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"cd207049-ce35-4df9-9b31-2da91a50e413"
],
"eventReceivedDate":null,
"type":"SUBSCRIPTION",
"additionalData":{
}
},
"additionalData":{
},
"endUserIp":"100.10.10.10"
}
Example of curl code
curl https://test-api.centralpay.net/v2/rest/subscription?customerId=5ce2f9a8-002d-4c41-b812-fffa7d9a9033 \
-u 'junit7:A45J!wx1@145'
Back to JSON Format
{
"list":[
{
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"creationDate":"2017-03-28T10:33:46.627+02:00",
"merchantSubscriptionId":"REF_FMI",
"subscriptionModel":{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
},
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"cardId":"5385458a-1bf5-4992-b0a2-63ba1a8375d7",
"quantity":1,
"startingDate":"2017-03-28",
"endingDate":null,
"currentPeriodStart":"2017-03-28",
"currentPeriodEnd":"2017-04-27",
"status":"ACTIVE",
"cancellationDate":null,
"cancelAtPeriodEnd":null,
"lastInvoice":{
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"creationDate":"2017-03-28T10:33:46.879+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":500,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"description":null,
"attemptCount":1,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"cd207049-ce35-4df9-9b31-2da91a50e413"
],
"eventReceivedDate":null,
"type":"SUBSCRIPTION",
"additionalData":{
}
},
"additionalData":{
},
"endUserIp":"100.10.10.10"
}
],
"totalCount":1
}
List Subscriptions
This function allows you to list Subscriptions
|
merchantSubscriptionId String |
Merchant ID Required: no Validation: .{0,100} |
|
subscriptionModelId SubscriptionModel |
Subscription model ID Required: no Validation: Existing UUDI belong to the merchant |
|
customerId Customer |
Customer ID Required: no Validation: Existing UUDI belong to the merchant |
|
status SubscriptionStatus |
Statut Required: no |
Example of curl code
curl https://test-api.centralpay.net/v2/rest/subscription?customerId=5ce2f9a8-002d-4c41-b812-fffa7d9a9033 \
-u 'junit7:A45J!wx1@145'
Back to JSON Format
{
"list":[
{
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"creationDate":"2017-03-28T10:33:46.627+02:00",
"merchantSubscriptionId":"REF_FMI",
"subscriptionModel":{
"subscriptionModelId":"f76ebdc7-1203-40ff-8105-f06607af2bee",
"merchantSubscriptionModelId":null,
"creationDate":"2017-03-27T17:40:20.325+02:00",
"pointOfSaleId":"6605eb8b-f4c8-4ed6-885e-573332f70fb5",
"contractId":"7f96d35d-da83-4a70-8205-ed6d62590ab2",
"amount":500,
"currency":"EUR",
"name":"cpfmi",
"description":null,
"intervalUnit":"MONTH",
"intervalCount":1,
"additionalData":{
}
},
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"cardId":"5385458a-1bf5-4992-b0a2-63ba1a8375d7",
"quantity":1,
"startingDate":"2017-03-28",
"endingDate":null,
"currentPeriodStart":"2017-03-28",
"currentPeriodEnd":"2017-04-27",
"status":"ACTIVE",
"cancellationDate":null,
"cancelAtPeriodEnd":null,
"lastInvoice":{
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"creationDate":"2017-03-28T10:33:46.879+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":500,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"description":null,
"attemptCount":1,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"cd207049-ce35-4df9-9b31-2da91a50e413"
],
"eventReceivedDate":null,
"type":"SUBSCRIPTION",
"additionalData":{
}
},
"additionalData":{
},
"endUserIp":"100.10.10.10"
}
],
"totalCount":1
}
Invoice
Invoices are statements of what a customer owes for a billing period. It includes subscriptions, invoice items or any adjustments you'd need to make.
Once an invoice is created, payment is automatically attempted. You can define the time you wish the invoice is started on merchant portal.
Note that the payment, while automatic, does not happen exactly at the time of invoice creation. If you have configured webhooks, the invoice will wait until one hour after the last webhook is successfully sent (or the last webhook times out after failing).
Invoice Object
The Json "Invoice" Object
The « Invoice» object represents the invoice of a transaction.
Note: UUID Format
| InvoiceId String (36) |
Invoice ID Note: UUID Format |
|
| creationDate OffsetDateTime |
Creation date | |
| merchantInvoiceId String |
Merchant ID | |
| subscriptionId String (36) |
Subscription ID | |
| customerId String (36) |
Customer ID Note: UUID Format |
|
| amount Integer |
Total amount Note: Via le Subscription |
|
| currency String |
Devise Note: Via SubscriptionModel Format préféré |
|
| closed Boolean |
Is closed Note: A la création : si subscription.status = UNPAID alors closed = true sinon closed = false |
|
| invoiceItems List ‹InvoiceItem› |
Items list Note: A la création : associer tous les InvoiceItem "en attente" et les désassocier de la Subscription |
|
| description String |
Description | |
| attemptCount Integer |
Number of auto transaction tests Note: 0 when created |
|
| nextTransactionAttempt OffsetDateTime |
Date of the next transaction test Note: Use the hour of transaction Invoice (h) in the Merchant configuration. If now <= h : today at hour (h) if not then tomorrow hour (h) |
|
| paid Boolean |
Paid Note: False when created |
|
| transactions List‹UUID› |
List of transactions ID Note: Empty when created |
|
| eventReceivedDate OffsetDateTime |
Receipt date of creation event Note: Date actuelle si événement XXX non écouté ou rempli après l'envoi de l'événement (pas à la création) |
|
| type Enum CreationSource |
Type Note: SUBSCRIPTION | MANUAL |
|
| additionalData[*] Map |
Merchant data |
Exemple of curl code
curl https://test-api.centralpay.net/v2/rest/invoice \
-u 'junit7:A45J!wx1@145' \
--data-urlencode subscriptionId=8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb
Back to JSON Format
{
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"creationDate":"2017-03-28T12:36:42.874+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":2900,
"currency":"EUR",
"closed":false,
"invoiceItems":[
{
"invoiceItemId":"a889aa8c-6b71-45a2-bd82-66b4e6757071",
"creationDate":"2017-03-28T12:36:11.162+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":2900,
"totalAmount":2900,
"currency":"EUR",
"description":null,
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
],
"description":null,
"attemptCount":0,
"nextTransactionAttempt":"2017-03-28T15:00+02:00",
"paid":false,
"transactions":[
],
"eventReceivedDate":null,
"type":"MANUAL",
"additionalData":{
}
}
Create an Invoice
This function allows you to create an Invoice
|
merchantInvoiceId String |
Merchant ID Required: no Validation: .{0,100} |
|
subscriptionId Subscription |
Subscription ID Required: yes Validation: Existing UUID belong to the merchant |
|
description String |
Description Required: no Validation: .{0,256} |
|
additionalData[*] String |
Merchant ID Required: no Validation: Clé : .{45} |
Exemple of curl code
curl https://test-api.centralpay.net/v2/rest/invoice \
-u 'junit7:A45J!wx1@145' \
--data-urlencode subscriptionId=8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb
Back to JSON Format
{
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"creationDate":"2017-03-28T12:36:42.874+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":2900,
"currency":"EUR",
"closed":false,
"invoiceItems":[
{
"invoiceItemId":"a889aa8c-6b71-45a2-bd82-66b4e6757071",
"creationDate":"2017-03-28T12:36:11.162+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":2900,
"totalAmount":2900,
"currency":"EUR",
"description":null,
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
],
"description":null,
"attemptCount":0,
"nextTransactionAttempt":"2017-03-28T15:00+02:00",
"paid":false,
"transactions":[
],
"eventReceivedDate":null,
"type":"MANUAL",
"additionalData":{
}
}
Example of html code
curl -v --noproxy '*' --insecure https://test-api.centralpay.net/v2/rest/invoice/f00454ae-30ab-4de8-8efa-ae00dabe6837 \
-u 'junit7:A45J!wx1@145' \
-d description=Facture_Abonnement_Sport
Back to Json format
{
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"creationDate":"2017-03-28T12:36:42.874+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":2900,
"currency":"EUR",
"closed":false,
"invoiceItems":[
{
"invoiceItemId":"a889aa8c-6b71-45a2-bd82-66b4e6757071",
"creationDate":"2017-03-28T12:36:11.162+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":2900,
"totalAmount":2900,
"currency":"EUR",
"description":null,
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
],
"description":"Facture_Abonnement_Sport",
"attemptCount":0,
"nextTransactionAttempt":"2017-03-28T15:00+02:00",
"paid":false,
"transactions":[
],
"eventReceivedDate":null,
"type":"MANUAL",
"additionalData":{
}
}
Update an Invoice
This function allows you to update an Invoice
|
invoiceId (URL) Invoice |
Invoice ID Required: yes Validation: Existing UUID belong to the merchant |
|
merchantInvoiceId String |
Merchant ID Required: no Validation: .{0,100} Unset with null value |
|
description String |
Description Required: no Validation: .{0,256} Unset with null value |
|
additionalData[*] String |
Merchant data Required: no Validation: Clé : .{45} Unset with null value |
Example of html code
curl -v --noproxy '*' --insecure https://test-api.centralpay.net/v2/rest/invoice/f00454ae-30ab-4de8-8efa-ae00dabe6837 \
-u 'junit7:A45J!wx1@145' \
-d description=Facture_Abonnement_Sport
Back to Json format
{
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"creationDate":"2017-03-28T12:36:42.874+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":2900,
"currency":"EUR",
"closed":false,
"invoiceItems":[
{
"invoiceItemId":"a889aa8c-6b71-45a2-bd82-66b4e6757071",
"creationDate":"2017-03-28T12:36:11.162+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":2900,
"totalAmount":2900,
"currency":"EUR",
"description":null,
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
],
"description":"Facture_Abonnement_Sport",
"attemptCount":0,
"nextTransactionAttempt":"2017-03-28T15:00+02:00",
"paid":false,
"transactions":[
],
"eventReceivedDate":null,
"type":"MANUAL",
"additionalData":{
}
}
HTTP Request
POST https://test-api.centralpay.net/v2/rest/invoice/<invoiceId>
HTTP Response
OBJ Json de type Invoice
Example of curl code
curl https://test-api.centralpay.net/v2/rest/invoice/f00454ae-30ab-4de8-8efa-ae00dabe6837/close \
-X POST \
-u 'junit7:A45J!wx1@145'
Back to Json format
{
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"creationDate":"2017-03-28T12:36:42.874+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":2900,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"a889aa8c-6b71-45a2-bd82-66b4e6757071",
"creationDate":"2017-03-28T12:36:11.162+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":2900,
"totalAmount":2900,
"currency":"EUR",
"description":null,
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
],
"description":"Facture_Abonnement_Sport",
"attemptCount":0,
"nextTransactionAttempt":"2017-03-28T15:00+02:00",
"paid":false,
"transactions":[
],
"eventReceivedDate":null,
"type":"MANUAL",
"additionalData":{
}
}
Close an Invoice
This function allows you to close an Invoice
|
invoiceId (URL) Invoice |
Invoice ID Required: yes Validation: Existing UUID belong to the merchant |
HTTP Request
POST https://test-api.centralpay.net/v2/rest/invoice/<invoiceId>
HTTP Response
OBJ Json de type Invoice
Example of curl code
curl https://test-api.centralpay.net/v2/rest/invoice/f00454ae-30ab-4de8-8efa-ae00dabe6837/close \
-X POST \
-u 'junit7:A45J!wx1@145'
Back to Json format
{
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"creationDate":"2017-03-28T12:36:42.874+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":2900,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"a889aa8c-6b71-45a2-bd82-66b4e6757071",
"creationDate":"2017-03-28T12:36:11.162+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":2900,
"totalAmount":2900,
"currency":"EUR",
"description":null,
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
],
"description":"Facture_Abonnement_Sport",
"attemptCount":0,
"nextTransactionAttempt":"2017-03-28T15:00+02:00",
"paid":false,
"transactions":[
],
"eventReceivedDate":null,
"type":"MANUAL",
"additionalData":{
}
}
Exemple of curl code
curl https://test-api.centralpay.net/v2/rest/invoice/f00454ae-30ab-4de8-8efa-ae00dabe6837/reopen \
-X POST \
-u 'junit7:A45J!wx1@145'
Back to JSON Format
{
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"creationDate":"2017-03-28T12:36:42.874+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":2900,
"currency":"EUR",
"closed":false,
"invoiceItems":[
{
"invoiceItemId":"a889aa8c-6b71-45a2-bd82-66b4e6757071",
"creationDate":"2017-03-28T12:36:11.162+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":2900,
"totalAmount":2900,
"currency":"EUR",
"description":null,
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
],
"description":"Facture_Abonnement_Sport",
"attemptCount":0,
"nextTransactionAttempt":"2017-03-28T15:00+02:00",
"paid":false,
"transactions":[
],
"eventReceivedDate":null,
"type":"MANUAL",
"additionalData":{
}
}
Reopen an Invoice
This function allows you to reopen an Invoice
|
invoiceId (URL) Invoice |
Invoice ID Required: yes Validation: Existing UUID belong to the merchant |
Exemple of curl code
curl https://test-api.centralpay.net/v2/rest/invoice/f00454ae-30ab-4de8-8efa-ae00dabe6837/reopen \
-X POST \
-u 'junit7:A45J!wx1@145'
Back to JSON Format
{
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"creationDate":"2017-03-28T12:36:42.874+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":2900,
"currency":"EUR",
"closed":false,
"invoiceItems":[
{
"invoiceItemId":"a889aa8c-6b71-45a2-bd82-66b4e6757071",
"creationDate":"2017-03-28T12:36:11.162+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":2900,
"totalAmount":2900,
"currency":"EUR",
"description":null,
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
],
"description":"Facture_Abonnement_Sport",
"attemptCount":0,
"nextTransactionAttempt":"2017-03-28T15:00+02:00",
"paid":false,
"transactions":[
],
"eventReceivedDate":null,
"type":"MANUAL",
"additionalData":{
}
}
Exemple of curl code
curl https://test-api.centralpay.net/v2/rest/invoice/f00454ae-30ab-4de8-8efa-ae00dabe6837/pay \
-X POST \
-u 'junit7:A45J!wx1@145'
Back to JSON Format
{
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"creationDate":"2017-03-28T12:36:42.874+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":2900,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"a889aa8c-6b71-45a2-bd82-66b4e6757071",
"creationDate":"2017-03-28T12:36:11.162+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":2900,
"totalAmount":2900,
"currency":"EUR",
"description":null,
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
],
"description":"Facture_Abonnement_Sport",
"attemptCount":0,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"8e92d457-a3f2-4f90-9bfb-4017da26b2ae"
],
"eventReceivedDate":null,
"type":"MANUAL",
"additionalData":{
}
}
Pay an Invoice
This function allows you to pay an Invoice
|
invoiceId (URL) Invoice |
Invoice ID Required: yes Validation: Existing UUID belong to the merchant |
Exemple of curl code
curl https://test-api.centralpay.net/v2/rest/invoice/f00454ae-30ab-4de8-8efa-ae00dabe6837/pay \
-X POST \
-u 'junit7:A45J!wx1@145'
Back to JSON Format
{
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"creationDate":"2017-03-28T12:36:42.874+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":2900,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"a889aa8c-6b71-45a2-bd82-66b4e6757071",
"creationDate":"2017-03-28T12:36:11.162+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":2900,
"totalAmount":2900,
"currency":"EUR",
"description":null,
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
],
"description":"Facture_Abonnement_Sport",
"attemptCount":0,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"8e92d457-a3f2-4f90-9bfb-4017da26b2ae"
],
"eventReceivedDate":null,
"type":"MANUAL",
"additionalData":{
}
}
Example of curl code
curl https://test-api.centralpay.net/v2/rest/invoice/f00454ae-30ab-4de8-8efa-ae00dabe6837 \
-u 'junit7:A45J!wx1@145'
Back to Json format
{
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"creationDate":"2017-03-28T12:36:42.874+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":2900,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"a889aa8c-6b71-45a2-bd82-66b4e6757071",
"creationDate":"2017-03-28T12:36:11.162+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":2900,
"totalAmount":2900,
"currency":"EUR",
"description":null,
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
],
"description":"Facture_Abonnement_Sport",
"attemptCount":0,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"8e92d457-a3f2-4f90-9bfb-4017da26b2ae"
],
"eventReceivedDate":null,
"type":"MANUAL",
"additionalData":{
}
}
Retrieve an Invoice
This function allows you to retrieve an Invoice
|
invoiceId (URL) Invoice |
Invoice ID Required: yes Validation: Existing UUID belong to the merchant |
Example of curl code
curl https://test-api.centralpay.net/v2/rest/invoice/f00454ae-30ab-4de8-8efa-ae00dabe6837 \
-u 'junit7:A45J!wx1@145'
Back to Json format
{
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"creationDate":"2017-03-28T12:36:42.874+02:00",
"merchantInvoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"amount":2900,
"currency":"EUR",
"closed":true,
"invoiceItems":[
{
"invoiceItemId":"a889aa8c-6b71-45a2-bd82-66b4e6757071",
"creationDate":"2017-03-28T12:36:11.162+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":2900,
"totalAmount":2900,
"currency":"EUR",
"description":null,
"invoiceId":"f00454ae-30ab-4de8-8efa-ae00dabe6837",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
],
"description":"Facture_Abonnement_Sport",
"attemptCount":0,
"nextTransactionAttempt":null,
"paid":true,
"transactions":[
"8e92d457-a3f2-4f90-9bfb-4017da26b2ae"
],
"eventReceivedDate":null,
"type":"MANUAL",
"additionalData":{
}
}
List Invoices
This function allows you to list Invoices
|
merchantInvoiceId String |
Merchant ID Required: no Validation: .{0,100} |
|
subscriptionId Subscription |
Subscription ID Required: no Validation: Existing UUID belog to the merchant |
|
customerId Customer |
Customer ID Required: no Validation: Existing UUID belog to the merchant |
|
paid Boolean |
Paid Required: no |
|
type Enum CreationSource |
Type Required: no |
Invoice Item
Invoice Item
InvoiceItem object
The Json "InvoiceItem" Object
The "InvoiceItem" object response represents a InvoiceItem
| invoiceItemId String (36) |
InvoiceItem ID Note: UUID Format |
| creationDate OffsetDateTime |
Creation date |
| merchantInvoiceItemId String |
Merchant ID |
| quantity Integer |
Quantity |
| amount Integer |
Unit amount |
| totalAmount Integer |
Total amount quantity * amount |
| currency String |
Devise Format préféré Via le Invoice |
| description String |
Description |
| InvoiceID UUID |
Invoice ID |
| subscriptionId UUID |
Subscription ID Via le Invoice ou Subscription |
| customerId UUID |
Customer ID Via le Invoice ou Subscription |
| type Enum CreationSource |
Type SUBSCRIPTION | MANUAL |
| additionalData[*] Map |
merchant data |
Exemple of curl code
curl https://test-api.centralpay/v2/rest/invoiceItem \
-u 'junit7:A45J!wx1@145' \
--data-urlencode subscriptionId=8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb \
--data-urlencode amount=4500
Back to JSON Format
{
"invoiceItemId":"5a1d9467-f4a9-4de4-9e2a-44dccc655f14",
"creationDate":"2017-03-28T11:59:25.397+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":4500,
"totalAmount":4500,
"currency":"EUR",
"description":null,
"invoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
Create InvoiceItem
This function allows you to create an InvoiceItem
|
merchantInvoiceItemId String |
Merchant ID Required: no Validation: .{0,100} |
|
subscriptionId Subscription |
Subscription ID Required: yes Validation: Existing UUID belong to the merchant |
|
invoiceId Invoice |
Invoice ID Required: no Validation: UUID Existant Appartient au marchand Lié à la Subscription |
|
quantity Number |
Quantity Required: no Validation: Greater or equal to 1 1 By default |
|
amount Number |
Unit amount Required: yes Validation: >= -9999999 et ‹= 9999999 En centimes |
|
description String |
Description Required: no Validation: .{0,256} |
|
additionalData[*] String |
Merchant data Required: no Validation: Clé : .{45} |
Exemple of curl code
curl https://test-api.centralpay/v2/rest/invoiceItem \
-u 'junit7:A45J!wx1@145' \
--data-urlencode subscriptionId=8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb \
--data-urlencode amount=4500
Back to JSON Format
{
"invoiceItemId":"5a1d9467-f4a9-4de4-9e2a-44dccc655f14",
"creationDate":"2017-03-28T11:59:25.397+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":4500,
"totalAmount":4500,
"currency":"EUR",
"description":null,
"invoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
Example of html code
curl https://test-api.centralpay.net/v2/rest/invoiceItem/5a1d9467-f4a9-4de4-9e2a-44dccc655f14 \
-u 'junit7:A45J!wx1@145' \
-d quantity=3
Back to Json format
{
"invoiceItemId":"5a1d9467-f4a9-4de4-9e2a-44dccc655f14",
"creationDate":"2017-03-28T11:59:25.397+02:00",
"merchantInvoiceItemId":null,
"quantity":3,
"amount":4500,
"totalAmount":13500,
"currency":"EUR",
"description":null,
"invoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
Update an InvoiceItem
This function allows you to update an InvoiceItem
|
invoiceItemId (URL) InvoiceItem |
InvoiceItem ID Required: yes Validation: Existing UUID belong to the merchant |
|
merchantInvoiceItemId String |
Merchant ID Required: no Validation: .{0,100} Unset with null value |
|
quantity Number |
Quantity Required: no Validation: ›=1 Recalculer totalAmount |
|
amount Number |
Unit amount Required: no Validation: ›= -9999999 et ‹= 9999999 Recalculer totalAmount |
|
description String |
Description Required: no Validation: .{0,256} Unset with null value |
|
additionalData[*] String |
Merchant data Required: no Validation: Clé : .{45} Unset with null value |
Example of html code
curl https://test-api.centralpay.net/v2/rest/invoiceItem/5a1d9467-f4a9-4de4-9e2a-44dccc655f14 \
-u 'junit7:A45J!wx1@145' \
-d quantity=3
Back to Json format
{
"invoiceItemId":"5a1d9467-f4a9-4de4-9e2a-44dccc655f14",
"creationDate":"2017-03-28T11:59:25.397+02:00",
"merchantInvoiceItemId":null,
"quantity":3,
"amount":4500,
"totalAmount":13500,
"currency":"EUR",
"description":null,
"invoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
Example of curl code
curl https://test-api.centralpay.net/v2/rest/invoiceItem/5a1d9467-f4a9-4de4-9e2a-44dccc655f14 \
-X DELETE \
-u 'junit7:A45J!wx1@145'
Back to Json format
{
"invoiceItemId":"5a1d9467-f4a9-4de4-9e2a-44dccc655f14",
"creationDate":"2017-03-28T11:59:25.397+02:00",
"merchantInvoiceItemId":null,
"quantity":3,
"amount":4500,
"totalAmount":13500,
"currency":"EUR",
"description":null,
"invoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
Delete an InvoiceItem
This function allows you to delete an InvoiceItem
|
invoiceItemId (URL) InvoiceItem |
InvoiceItem ID Required: yes Validation: Existing UUID belong to the merchant |
Example of curl code
curl https://test-api.centralpay.net/v2/rest/invoiceItem/5a1d9467-f4a9-4de4-9e2a-44dccc655f14 \
-X DELETE \
-u 'junit7:A45J!wx1@145'
Back to Json format
{
"invoiceItemId":"5a1d9467-f4a9-4de4-9e2a-44dccc655f14",
"creationDate":"2017-03-28T11:59:25.397+02:00",
"merchantInvoiceItemId":null,
"quantity":3,
"amount":4500,
"totalAmount":13500,
"currency":"EUR",
"description":null,
"invoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
Example of curl code
curl https://test-api.centralpay.net/v2/rest/invoiceItem/5a1d9467-f4a9-4de4-9e2a-44dccc655f14 \
-u 'junit7:A45J!wx1@145'
Back to Json format
{
"invoiceItemId":"5a1d9467-f4a9-4de4-9e2a-44dccc655f14",
"creationDate":"2017-03-28T11:59:25.397+02:00",
"merchantInvoiceItemId":null,
"quantity":3,
"amount":4500,
"totalAmount":13500,
"currency":"EUR",
"description":null,
"invoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
Retrieve an InvoiceItem
This function allows to retrieve an InvoiceItem
|
invoiceItemId (URL) InvoiceItem |
InvoiceItem ID Required: yes Validation: Existing UUID belong to the merchant |
Example of curl code
curl https://test-api.centralpay.net/v2/rest/invoiceItem/5a1d9467-f4a9-4de4-9e2a-44dccc655f14 \
-u 'junit7:A45J!wx1@145'
Back to Json format
{
"invoiceItemId":"5a1d9467-f4a9-4de4-9e2a-44dccc655f14",
"creationDate":"2017-03-28T11:59:25.397+02:00",
"merchantInvoiceItemId":null,
"quantity":3,
"amount":4500,
"totalAmount":13500,
"currency":"EUR",
"description":null,
"invoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
}
Example of curl code
curl https://test-api.centralpay.net/v2/rest/invoiceItem?customerId=5ce2f9a8-002d-4c41-b812-fffa7d9a9033 \
-u 'junit7:A45J!wx1@145'
Back to JSON Format
{
"list":[
{
"invoiceItemId":"5a1d9467-f4a9-4de4-9e2a-44dccc655f14",
"creationDate":"2017-03-28T11:59:25.397+02:00",
"merchantInvoiceItemId":null,
"quantity":3,
"amount":4500,
"totalAmount":13500,
"currency":"EUR",
"description":null,
"invoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
},
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"totalCount":2
}
List InvoiceItems
This function allows you to list InvoiceItems
|
merchantInvoiceItemId
String |
Merchant ID Required: no Validation: .{0,100} |
|
subscriptionId
Subscription |
Subscription ID Required: no Validation: Existing UUID belong to the merchant |
|
customerId
Customer |
Customer ID Required: no Validation: Existing UUID belong to the merchant |
|
type
Enum CreationSource |
Type Required: no |
Example of curl code
curl https://test-api.centralpay.net/v2/rest/invoiceItem?customerId=5ce2f9a8-002d-4c41-b812-fffa7d9a9033 \
-u 'junit7:A45J!wx1@145'
Back to JSON Format
{
"list":[
{
"invoiceItemId":"5a1d9467-f4a9-4de4-9e2a-44dccc655f14",
"creationDate":"2017-03-28T11:59:25.397+02:00",
"merchantInvoiceItemId":null,
"quantity":3,
"amount":4500,
"totalAmount":13500,
"currency":"EUR",
"description":null,
"invoiceId":null,
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"MANUAL",
"additionalData":{
}
},
{
"invoiceItemId":"1b756031-d60b-4e36-b94b-0e789ab6feae",
"creationDate":"2017-03-28T10:33:46.706+02:00",
"merchantInvoiceItemId":null,
"quantity":1,
"amount":500,
"totalAmount":500,
"currency":"EUR",
"description":null,
"invoiceId":"5d6383fd-560e-4533-9a72-74699633e885",
"subscriptionId":"8ddd2c0d-5617-42fc-a0a1-86ad263f7fbb",
"customerId":"5ce2f9a8-002d-4c41-b812-fffa7d9a9033",
"type":"SUBSCRIPTION",
"additionalData":{
}
}
],
"totalCount":2
}
Installment Payment
Scheduled Payments or split payments allows customers to pay for a purchase in several instalments, instead of one single payment.
This is usually done for large amounts, so that the customer doesn't have to spend too much at once for an order.
Centralpay platform will process the first installment immediately or at a specified date (startingDate).
Centralpay can also allow the merchant :
- to charge some additional extra fees (feeAmount) that will be added to the amount.
- to define a deposit (depositAmount) that will be deducted from the amount. It can also start at a specific date (depositStartingDate)
Note: round up are applied to the first payment (not applied if the deposit is used)
In case of acceptation of the first installment by the issuing bank, the platform will process the following installments at the given dates automatically.
You can receive a Webhook notification for each transaction and the Customer an email notification for each successull payment.
Example:
You wish to charge your customer 1 000 € split in 3 months from the 05/07/2018, with a deposit of 200€ on the 28/06/2018 and add a 10 € fees.
| Field | Value |
| amount | 1 000,00 € |
| depositAmount | 200,00 € |
| feeAmount | 10,00 € |
| intervalUnit | MONTH |
|
intervalCount |
1 |
| iterationCount | 3 |
| depositStartingDate | 28/06/2018 |
| startingDate | 05/07/2018 |
The result will be :
| Date | Amount | Detail |
| 28/06/2018 | 200,00 € |
Deposit
|
| 05/07/2018 | 276,68 € |
(amount-depositAmount) - (Round down( amount-depositAmount ) / iterationCount X (iterationCount-1)) + feeAmount = (1000€-200€) - (Round down( 1000€-200€ ) / 3 X (3-1)) + 10€ |
| 05/08/2018 | 266,66 € |
Round down( (amount-depositAmount)/iterationCount ) = Round down( (1000€-200€)/3 ) |
| 05/09/2018 | 266,66 € |
Round down( (amount-depositAmount)/iterationCount ) = Round down( (1000€-200€)/3 ) |
InstallmentPayment Object
The Json "InstallmentPayment" Object
The "InstallmentPayment" object response represents a Installment Payment.
| installmentPaymentId String (36) |
Installment Payment ID Note: UUID Format |
| creationDate String |
Creation date Note: ISO 8601 |
| merchantInstallmentPaymentId String |
Installment Payment merchant ID |
| pointOfSaleId String (36) |
Point of Sale ID Note: UUID Format |
|
contractId String (36) |
Contract IDNote: UUID Format |
| customerId String (36) |
Customer IDNote: UUID Format |
|
cardId |