Web Services

Welcome to the reference documentation for REST payment web services.

Transactions

List of web services used when creating and manipulating transactions:

Description Web service
Create a new transaction with an embedded form Charge/CreatePayment
Cancel or refunding a transaction Transaction/CancelOrRefund
Create a transaction based on an existing transaction Transaction/Duplicate
Retrieve all the information about a transaction Transaction/Get
Update a transaction Transaction/Update
Validate a pending transaction Transaction/Validate
Retrieve all transactions linked to an Order ID Order/Get

Tokens

List of web services used when creating and manipulating payment method tokens (also called identifiers):

Description Web service
Create a token Charge/CreateToken
Retrieve all the information about a token Token/Get
Cancel an existing token Token/Cancel
Update an existing token Token/Update
Reactivate a token Token/Reactivate
Create a token using a transaction Charge/CreateTokenFromTransaction

Recurring payments

List of web services used when creating and manipulating recurring payments:

Description Web service
Create a new recurring payment Charge/CreateSubscription
Update an existing recurring payment Subscription/Update
Retrieve all the information about a recurring payment Subscription/Get
Cancel a recurring payment Subscription/Cancel

Payment orders

List of web services used when creating and manipulating payment orders:

Description Web service
Create a payment order Charge/CreatePaymentOrder
Retrieve a payment order Charge/PaymentOrder/Get
Update a payment order Charge/PaymentOrder/Update

Miscellaneous

Description Web service
Test your integration (minimalist Web Service) Charge/SDKTest

PCI-DSS Web Services

The following web services are reserved to PCI-DSS merchants:

Description Web service
Create a new transaction PCI/Charge/CreatePayment
Create a token PCI/Charge/CreateToken
Verify a payment method PCI/Charge/VerifyPaymentMethod
Update an existing token PCI/Token/Update

Web services limited to PSP

List of web services used when creating and manipulating payment orders:

Description Web service
Authenticate a future transaction Charge/Authenticate

Responses

Description Web service
Response to Charge/CreatePayment within the context of embedded form Charge/PaymentForm
Order of redirection returned by Charge/CreatePayment Charge/RedirectRequest
OrderTransactions OrderTransactions
PaymentOrder PaymentOrder
Payment Payment
PaymentForm PaymentForm
ResponseCodeAnswer ResponseCodeAnswer
Subscription Subscription
SubscriptionCreated SubscriptionCreated
Token Token
Transaction Transaction