It is imperative after the creation or the update of a WALLET, to use the webservice getWebWallet, which will guarantee you the result obtained.
The method retrieves information from a virtual wallet created via the web interface.
Request to send
The "getWebWalletRequest" request includes:
Element | Description | Required | Type | Example |
version | Version of Payline web services | Yes | N2 | To be valued with the latest version: see the table of versions. |
token | Time-stamped session token that identifies the merchant. | Yes | AN50 |
Answer back
The "getWebWalletResponse" message is the response of an information request from a virtual wallet.
The answer has the following structure:
Element | Description | Required | Type | Example | Condition |
| result | Information on the result of the information request of the wallet | Yes | Object result | See below the elements | |
| wallet | Portfolio Information | no | Object wallet | See below the elements | |
| owner | Holder Information | no | Object owner | See below the elements | |
privateDataList | Information on personal information | no | |||
| extendedCard | Additional information on the map | no | ExtendedCardType Object | See below the elements | |
media | Detection of the media used during the payment. - Computer | no | AN25 | Mobile | |
| numberOfAttempt | The number of attempts made by the customer during his web payment. List of possible values: | no | N1 | 5 | |
| contractNumberWalletList | A chart of the contract numbers of the wallet. | no | Object contractNumberWalletList | See below the elements | Not used in Widget RELEASE 4.53mode |
The reference elements
Object result
Element | Description | Format | Example |
|---|---|---|---|
code | The return code of the web service: Accepted transaction: 00000, 02400, 02500, 02501, 02517, 02520, 02616, 03000, 04000. Other code: Transaction not accepted | N5 | See details of Payline Return Codes |
ShortMessage | Short message of the result of the transaction | AN50 | |
longMessage | Message of the result of the transaction | AN255 | |
| partnerCode | Return code from partner (payment method) and SAA acquirer | AN50 | from version 14 |
| partnerCodeLabel | Partner's wording | AN255 | from version 14 |
Object wallet
Element | Description | Required | Type | Example | Condition | ||||||||||||||||||||||||
walletId | The unique identifier of the virtual wallet. You must provide Payline with a unique identifier that corresponds to one and only one buyer on your information system. It is with this same identifier you can request a payment by virtual wallet. | Yes | AN50 | ||||||||||||||||||||||||||
| lastName | The name of the buyer. This information is useful for finding a portfolio in the Trading Administration Center. | no | AN100 | ||||||||||||||||||||||||||
firstName | First name of the buyer. | no | AN100 | ||||||||||||||||||||||||||
The email address of the buyer. Payline will use this information to send a proof of payment to your customer. | no | AN150 | |||||||||||||||||||||||||||
shippingAddress | Delivery address of the buyer | no | |||||||||||||||||||||||||||
| card | Buyer card information | Yes | Object card | ||||||||||||||||||||||||||
| how | comments | no | AN255 | ||||||||||||||||||||||||||
| default | Card saved by default | no | AN1 | Y or N: Default card | |||||||||||||||||||||||||
| cardStatus | Possible values: | no | AN3 | EXP | |||||||||||||||||||||||||
| cardBrand | Indicates the mark used for the operation:
It is taken into account only if the means of payment allows the choice of the mark. | no | N1 | CB | from version 15 | ||||||||||||||||||||||||
Object owner
Element | Description | Required | Type | Example | |
lastName | cardholder name | no | AN30 | Pierre | Applicable only for AMEX |
firstName | First name of the holder | no | AN15 | Paul | Applicable only for AMEX |
billingAddress | Billing address | no | Applicable only for AMEX | ||
issueCardDate | Date of issue of the card | no | AN4 | Format: mmyy | Applicable only for AMEX |
Object privateDataList
Element | Description | Required | Format | Example |
|---|---|---|---|---|
privateData | List containing privateData Number of items 0 to 100 | Yes |
Object privateData
Element | Description | Required | Format | Example |
|---|---|---|---|---|
key | The name of the key of value | Yes | AN50 | wear |
value | Value associated with the key | Yes | AN50 | dupond or durand, etc. |
ExtendedCardType Object
Element | Comment | Required | Example |
country | Country of issue of the card | AN2 | ISO CODE: example FR |
isCvd | The card is it a blue card | AN1 | Y OR N |
bank | The bank of the card used for payment | YEAR | Credit Lyonnais |
type | The type of payment card | AN20 | MASTERCARD |
network | Refers to the attachment of the card to an entity managing the acceptance of the card at a national or international level | AN20 | MASTERCARD |
product | Indicates the category to which the card type belongs: see product codes | YEAR | Gold / Premier for a VISA card |
Object contractNumberWalletList
Element | How | required | Format | Example | Condition |
|---|---|---|---|---|---|
contractNumberWallet | List containing the contract numbers of the portfolio. Number of elements 0 to 10. The Widget mode uses the multi-PDV and multi-contract wallet: the wallet is linked to the merchant level. | No. | Not used in Widget mode. RELEASE 4.53 |