• France
lyra.com
Search
Categories
Tags
Europe (English)
France
Spain
Europe (English)
India
Home
Implementation
Embedded form (cards)
REST payment API
REST PCI-DSS payment API
REST SEPA API
Hosted payment
Data collection form
File exchange
Mobile payment
Snippets
Plugins
Marketplace
Back Office
Merchant Back Office
Expert Back Office
Guides
Help
FAQ
Video tutorials
Support

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 refund 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 the payment method data associated with an existing alias Token/Update
Update buyer data associated with an existing alias Token/UpdateCustomerDetails
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

Wallets

Description Web service
Adding a card to a wallet during the payment.
Value the field formActionàCUSTOMER_WALLET and fill this field mandatory customer.reference.
Charge/CreatePayment
Adding a card in a wallet without payment.
Consult The registering of a card in a wallet without payment for more information.
Charge/CreateToken
Update buyer details for all cards associated with a wallet CustomerWallet/Update
Retrieve the list of tokens associated with a wallet CustomerWallet/Get

Payment orders

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

Description Web service
Creating 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
Creating a transaction with external authentication 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

Description Web service
Cardholder authentication service PCI/Charge/Authenticate

Responses

Description Web service
AuthenticationResponseData AuthenticationResponseData
CustomerWallet CustomerWallet
Response to Charge/CreatePayment within the context of embedded form Charge/PaymentForm
OrderTransactions OrderTransactions
PaymentOrder PaymentOrder
Payment Payment
ResponseCodeAnswer Common/ResponseCodeAnswer
Subscription Subscription
SubscriptionCreated SubscriptionCreated
Token Token
Transaction Transaction
Recruitment

Head Office :

LYRA NETWORK
109, rue de l’innovation
31670 Labège
FRANCE

2.17.0-doc-1.8