Web Services

Welcome to the reference documentation for REST payment Web Services.

Transactions

List of Web Services implied in creating and manipulating transactions:

Description Web Service
Creating a new transaction with an embedded form Charge/CreatePayment
Capturing a previously accepted transaction Transaction/Capture
Canceling or refunding a transaction Transaction/CancelOrRefund
Creating a transaction based on an existing transaction Transaction/Duplicate
Retrieving all the information about a transaction Transaction/Get
Modifying a transaction Transaction/Update
Validating a pending transaction Transaction/Validate
Retrieving all transactions linked with an Order ID Order/Get

Tokens

List of Web Services implied in creating and manipulating payment method tokens (also called identifiers):

Description Web Service
Create a token Charge/CreateToken
Retrieving all the information about a token Token/Get
Canceling an existing token Token/Cancel
Reactivating a token Token/Reactivate
Creating a token using a transaction Charge/CreateTokenFromTransaction

Recurring payments

List of Web Services implied in creating and manipulating recurring payments:

Description Web Service
Creating a new recurring payment Charge/CreateSubscription
Updating an existing recurring payment Subscription/Update
Retrieving all the information about a recurring payment Subscription/Get
Canceling a recurring payment Subscription/Cancel

Miscellaneous

Description Web Service
Testing your integration (minimalist Web Service) Charge/SDKTest

PCI-DSS Web Services

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

Description Web Service
Authenticating a future transaction Charge/Authenticate (PCI)
Creating a new transaction Charge/CreatePayment (PCI)
Create a token Charge/CreateToken (PCI)

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
Payment Payment
PaymentForm PaymentForm
ResponseCodeAnswer ResponseCodeAnswer
Subscription Subscription
SubscriptionCreated SubscriptionCreated
Token Token
Transaction Transaction
Type/String Type/String