S-money API

Recommendations for iframe integration

Hadassa — 2019-02-25T10:58:32Z

2.1 Enter the card data

2.1 iframe dimensions

The iframe is 390 pixels x 400 pixels, these are the dimensions recommended for the 3-D Secure protocol display, these values should not be modified to keep the ideal display, they are valid for all the pages viewed in the iframe.

These values specified in the external CSS file, which targets directly the iframe to fix its dimensions, here in the example, the name of the CSS file is « Site.css »

2.1.2 HTML

A CSS file (here « Site.css ») must be called in the html code to customise the iframe. A container (« cntnr-iframe ») may be necessary for centering the iframe on the page.

 


 
scrolling="no">

2.1.3 CSS to the outside iframe (customisation of the parent container of the form)

1 - Apply the background

It is possible to put a background with the css on the body, for example (behind the iframe) and to place a background with a transparency effect on the iframe (example below)

body {

…

background:url('background.gif') no-repeat center center;

background-size: cover;

height:100%;

…

}

#iframe1 {

…

background-color: rgba(0, 0, 0, 0.2);

…

}

2. 2. Centering the iframe

.cntnr-iframe {

position : relative ;

width : 100% ;

height : 100% ;

{

set a different height, if the iframe should not be 

centered on the entire window, the minimum height should be 400

pixels

}

#iframe1 {

…

width: 390px;

height: 400px; 

position: absolute;

left:50%;

top: 50%;

margin-top: -200px; (équivalent à la moitié de la hauteur spécifiée en css (400px))

margin-left:-195px; (équivalent à la moitié de la largeur spécifiée en css (390px))

…

}

3 - Reduce the size of the iframe

It is possible to reduce the size of the iframe using the transform scale technique. It is recommended to reduce to 0.82 for sreen width less than 320px. This technique should be used with a lot of precaution: it is recommended to avoid setting less than 0.82 to keep a text readable. Otherwise, a value greater than 0.82 will not allow a display adapted for a small phone.

#iframe1 {

…

transform : scale(0.82,0.82);

…

}

2.1.4CSS within iframe (form customisation)

Other css styles are loaded within iframe, which allows to display properly different elements of the page in the iframe.

It is then within these CSS where yu can find styles to modify typos, colours, the positioning of the form elements, styles of the tooltip… the display of all the elements of the page loaded within iframe are managed by these CSS.

These css styles can be found in the head tags of the page loaded within iframe and can be modified. Modifications should be communicated to the S-money team.

2.2 Validation

Once a payment or bank card registration has been completed, 2 validation scenarios are possible:

Internet user arrives on the validation page which redirects automatically to the landing page.
The validation page will not be visible to the user because the redirection is done directly.

Internet user is redirected to a page which contains a return button. He/she only needs to click on this button to arrive a new page.

2.2.1 Case 1: Validation with automatic redirection

To obtain automatic redirection, it is necessary to integrate in the source code of the validation page, automatic redirection with JavaScript below which appears in the script tags script, which can be found in the head tags. It is necessary to enter the address intended for redirection instead of « http://www.example.com »

…

2.2.2 Cas 2 : Validation with manual redirection using a button

1 - HTML

The target attribute="_parent" of the link is mandatory for the correct redirection in the window. In this example, there is a div « container » and a div « inner » for centering vertically and horizontally the content of the page.


 
 
 Bravo !
 Votre paiement a été effectué avec succès.

 Retour à l'accueil

2 - CSS

The CSS file specific to the page could be included directly in the source code.
The css below allows horizontal and vertical centering in smooth way on all types of media (mobiles, tablettes…).

body {
 text-align :center ;

}

.container {
 display:table;
 height:100%;
 width:80%;
 margin:0 auto;

}

.inner {
 display:table-cell;
 padding:50px 0;
 text-align:center; 
 vertical-align:middle;

}

Modify a payment installment

Hadassa — 2016-07-05T14:42:33Z

To modify a payment installment, please have a look at the example in the right margin of this page.

Error cases :

HTTP code	Error code	Explication
404	356	Operation cannot be found
500	706	The amount of the refund exceeds the amount of the original operation

Request :
PUT /api/[domaine_partenaire]/payins/cardpayments/orderid/sequenceNumber/ HTTP/1.1
Accept: application/vnd.s-money.v1+json
Content-Type: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

{
 "amount":420,
 "date":"2014-09-01T00:00:00.000000+02:00",
 "fee":90

}

Response :
HTTP/1.1 201 CREATED
Content-Type: application/vnd.s-money.v1+json
Location: /api/[domaine_partenaire]/payins/cardpayments/refund123

{
 "sequenceNumber":1,
 "amount":420,
 "date":"2014-09-01T00:00:00.000000+02:00",
 "fee":90,
 "status":2

}

Cancel a payment installment

Hadassa — 2016-07-05T14:33:25Z

To cancel a payment installment, please have a look at the example in the right margin of this page.

Error cases

HTTP code	Error code	Explication
404	356	Operation cannot be found
500	706	The amount of the refund exceeds the amount of the original operation

Request :
PUT /api/[domaine_partenaire]/payins/cardpayments/orderid
/sequenceNumber/ HTTP/1.1
Accept: application/vnd.s-money.v1+json
Content-Type: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

{
 "status":5

}

Response :
HTTP/1.1 201 CREATED
Content-Type: application/vnd.s-money.v1+json
Location: /api/[domaine_partenaire]/payins/cardpayments/refund123

{
 "sequenceNumber":1,
 "amount":520,
 "date":"2014-09-01T00:00:00.000000+02:00",
 "fee":90,
 "status":5

}

Refund a payment installment

Hadassa — 2016-07-05T14:20:15Z

To refund a payment installment, please have a look at the example in the right margin of this page.

Error cases:

HTTP Code	Error code	Explication
404	356	Operation cannot be found
500	706	The amount of the refund exceeds the amount of the original operation

Request :
POST /api/[domaine_partenaire]/payins/cardpayments/orderid /sequenceNumber/refunds HTTP/1.1
Accept: application/vnd.s-money.v2+json
Content-Type: application/vnd.s-money.v2+json
Authorization: Bearer ACCESS_TOKEN

{
 "amount": 1020,
 "orderId": "refund123",
 "fee":10

}

Response :
HTTP/1.1 201 CREATED
Content-Type: application/vnd.s-money.v2+json
Location: /api/[domaine_partenaire]/payins/cardpayments/refund123

{
 "id":6,
 "orderId": "refund123"
 "amount":1020,
 "fee":10,
 "status":1,
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "originalPayment":{
 "id":5,
 "orderId":"123",
 "href":"/api/[domaine_partenaire]/payins/cardpayments/123/1" 
 },
 "type":1

}

Refund an incoming payment

Hadassa — 2016-07-05T14:16:22Z

To refund an incoming payment, please have a look at the example in the right margin of this page.

Error cases

HTTP code	Error code	Explication
404	356	Operation cannot be found
500	706	The amount of the refund exceeds the amount of the original operation

Request :
POST /api/[domaine_partenaire]/payins/cardpayments/orderid/refunds HTTP/1.1
Accept: application/vnd.s-money.v2+json
Content-Type: application/vnd.s-money.v2+json
Authorization: Bearer ACCESS_TOKEN

{
 "amount": 1020, 
 "orderId": "refund123",
 "fee":10

}

Response :
HTTP/1.1 201 CREATED
Content-Type: application/vnd.s-money.v2+json
Location: /api/[domaine_partenaire]/payins/cardpayments/refund123

{
 "id":6,
 "orderId": "refund123",
 "amount":1020,
 "fee":10,
 "status":1,
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "originalPayment":{
 "id":5,
 "orderId":"123",
 "href":"/api/[domaine_partenaire]/payins/cardpayments/123" 
 },
 "type":1

}

Retrieve a payment installment

Hadassa — 2016-07-05T14:14:16Z

To retrieve a payment installment, please have a look at the example in the right margin of this page.

Error cases:

HTTP code	Error code	Explication
404	356	Operation cannot be found

Request :
GET /api/[domaine_partenaire]/payins/cardpayments/orderid/sequenceNumber HTTP/1.1
Accept: application/vnd.s-money.v2+json
Authorization: Bearer ACCESS_TOKEN

Response :
HTTP/1.1 200 OK
Content-Type: application/vnd.s-money.v1+json

{
 "sequenceNumber":2,
 "amount":500,
 "date":"2014-10-01T00:00:00.000000+02:00",
 "fee":90,
 "status": 0

}

Retrieve an incoming payment

Hadassa — 2016-07-05T14:02:15Z

To retrieve an incoming payment, please have a look at the example in the right margin of this page.

Error cases:

HTTP code	Error code	Explication
404	356	Operation cannot be found

Request :
GET /api/[domaine_partenaire]/payins/cardpayments/orderid HTTP/1.1
Accept: application/vnd.s-money.v2+json
Authorization: Bearer ACCESS_TOKEN

Response :
HTTP/1.1 200 OK
Content-Type: application/vnd.s-money.v1+json

{
 "id":5, 
 "orderId":"123",
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/[domaine_partenaire]/accounts/123"
 },
 "amount":1020, 
 "fee":150,
 "status":1,
 "message": "déjeuner au restaurant",
 "payerInfo": 
 {
 "Name": "Pierre Dupont",
 "Mail": "pierre@dupont.fr"
 },
 "ismine":false, 
 "card":{
 "id":21,
 "appcardid":"card123",
 "name":"carte bancaire",
 "hint":"597010XXXXXX0009",
 "country":"FR"
 },
 "paymentDate":
 "2013-09-10T15:49:58.791121+02:00",
 "errorCode":0, 
 "extraResults":{
 "bankAuthResult":null,
 "riskControlResult":null,
 "threedsResult":10,
 "warrantyResult":true
 },
 "type":0,
 "paymentSchedule":[{
 "sequenceNumber":1,
 "amount":520,
 "date":"2014-09-01T00:00:00.000000+02:00",
 "fee":90,
 "status": 1
 },
 {
 "sequenceNumber":2,
 "amount":500,
 "date":"2014-10-01T00:00:00.000000+02:00",
 "fee":90,
 "status": 0
 },
 {…}]

}

Retrieve the list of incoming payments

Hadassa — 2016-07-05T14:00:10Z

To retrieve the list of incoming payments, please have a look at the example in the right margin of this page.

Request :
GET /api/[domaine_partenaire]/payins/cardpayments HTTP/1.1
Accept: application/vnd.s-money.v2+json
Authorization: Bearer ACCESS_TOKEN

Response :
HTTP/1.1 200 OK
Content-Type: application/vnd.s-money.v1+json

[{
 "id":5,
 "orderId":"123",
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":
 "/api/[domaine_partenaire]/accounts/123"
 },
 "amount":1020,
 "fee":150,
 "status":1,
 "message": "déjeuner au restaurant",
 "payerInfo": 
 {
 "Name": "Pierre Dupont",
 "Mail": "pierre@dupont.fr"
 },
 "ismine":false,
 "card":{
 "id":21,
 "appcardid":"card123",
 "name":"carte bancaire",
 "hint":"597010XXXXXX0009",
 "country":"FR"
 },
 "paymentDate":"2013-09-10T15:49:58.791121+02:00",
 "errorCode":0,
 "extraResults": {
 "bankAuthResult":null,
 "riskControlResult":null,
 "threedsResult":10,
 "warrantyResult":true
 },
 "type":0,
 "paymentSchedule":[{
 "sequenceNumber":1,
 "amount":520,
 "date":"2014-09-01T00:00:00.000000+02:00",
 "fee":90,
 "status": 1
 },
 {
 "sequenceNumber":2,
 "amount":500,
 "date":"2014-10-01T00:00:00.000000+02:00",
 "fee":90,
 "status": 0
 },
 {…}]
 }, 

{…}]

Create a bank card payment

Hadassa — 2016-07-05T13:56:27Z

Send the data of the card payment request to the S-money server

To create a bank card payment, please have a look at the example in the right margin of this page.

Send the data of the completed payment to the third-party server

The third-party server needs to provide the S-money server with an url server, so that the latter can communicate the results of the payment execution.

The HTTP POST method is used to invoke the third-party server.

The parameters of the HTTP request are:

Parameter	Type	Description
id	string	Operation OrderId
error	Int	Error code for failed payments, 0 if no error. 1 = The merchant needs to contact the bank of the holder 2 = Payment refused 3 = Payment cancelled by the client 4 = Holder not 3D-Secure enrolled 5 = 3D-Secure authentication error 6 = SystemPay technical error
type	Int	Operation type 1 = card payment
status	Int	Operation status -1 = unknown 0 = waiting 1 = completed 2 = refunded 3 = refused 4 = waiting for validation 5 = Cancelled 6 = waiting to be sent
sequencenumber	Int	Sequence number of the multiple payment (if multiple payment)
userid	String	User identifier in the third-party application
userstatus	Int	User status 0 = Not confirmed 1 = OK 2 = Frozen 3 = On the fly 4 = Being closed 5 = Closed 6 = Waiting for KYC (transfers blocked)

Redirection at the end of a card payment

The third-party server should provide the S-money server with an url which allows the S-money server to redirect the client to the third-party environment.

The url can be either associated to a web scheme (http/https) or a private scheme when a request will be made from a third-party application.

Returned information should be used only for informative purposes and should not be, under any circumstances, used for the payment validation by the server.

The parameters of the HTTP request are:

Parameter	Type	Description
Id	String	OrderId of the payment
type	Int	Operation type 1 = card payment
Result	Int

Transaction status
0 : No errors.
2 : The merchant needs to contact the bank of the holder.
5 : Payment refused.
17 : Client cancellation.
30 : Request format error. To compare with the value of
vads_extra_result.
96 : Technical error of the payment. |

Request :
POST /api/[domaine_partenaire]/payins/cardpayments HTTP/1.1
Accept: application/vnd.s-money.v2+json
Content-Type: application/vnd.s-money.v2+json
Authorization: Bearer ACCESS_TOKEN

{
 "amount": 1020, 
 "orderId": "123",
 "availableCards":"CB",
 "beneficiary":{
 "appaccountid": "123" 
 },
 "message": "déjeuner au restaurant",
 "ismine": false,
 "Require3DS" : "false"
 "urlReturn": "http://test.com/returnurl/",
 "urlCallback":"https://test.com/callbackurl/", 
 "fee":180, 
 "payerInfo": 
 {
 "Name": "Pierre Dupont",
 "Mail": "pierre@dupont.fr"
 },
 "extraparameters": 
 {
 "profilename" : "testprofile", 
 "systempaylanguage" :"fr" 
 }
 "card":{
 "appcardid":"card123",
 "name":"carte bancaire"
 },
 "paymentSchedule":{
 "firstAmount": 520,
 "count": 2, 
 "period": 30,
 "firstFee":180
 }
 Ou
 [{
 "amount":520,
 "date":"2014-09-01T00:00:00.000000+02:00",
 "fee":90
 },
 {…}]

}

Response :
HTTP/1.1 201 CREATED
Content-Type: application/vnd.s-money.v1+json
Location: /api/[domaine_partenaire]/payins/cardpayments/orderid

{
 "id":5, 
 "orderId":"123",
 "beneficiary":{
 "id":87,
 "appaccountid":"123",
 "displayname":"Jean Dupont",
 "href":"/api/[domaine_partenaire]/accounts/123"
 },
 "amount":1020, 
 "fee":180,
 "status":0,
 "message": "déjeuner au restaurant",
 "ismine":false,
 "extraParameters": {
 "profileName": “testprofile”,
 "systemPayLanguage": "fr"
 },
 "card":{"appcardid":"card123", "name":"carte bancaire"},
 "paymentDate":null,
 "href":"{url à appeler}", 
 "type":0,
 "payerInfo": 
 {
 "Name": "Pierre Dupont",
 "Mail": "pierre@dupont.fr"
 },
 "paymentSchedule":[{
 "sequenceNumber":1,
 "amount":520,
 "date":"2014-09-01T00:00:00.000000+02:00",
 "fee":90,
 "status": 1
 },
 {
 "sequenceNumber":2,
 "amount":500,
 "date":"2014-10-01T00:00:00.000000+02:00",
 "fee":90,
 "status": 0
 },
 {…}]

}

The href parameter contains the url to which the third-party application should redirect the client's web browser to make a payment.

Resources

Hadassa — 2016-07-05T13:49:39Z

Card payments can be accessed through:

Access to card payments of the connected user
/api/[partner_domain]/payins/cardpayments

Access to card payments of the user belonging to the connected third-party application
/api/[partner_domain]/users/appUserId/payins/cardpayments

1.CardPayment v2

Contains information about a bank card payment

Property	Type	Example	Description
Id	Long	123	Payment ID
OrderId	String	456	Payment identifier in the third-party application
PaymentDate	DateTime	2013-09-10 T15:49:58 .791121+02:00	Payment date
Amount	Long	2350	Payment amount (in cents)
Fee	Long		Fee amount (the amount value does not include the fee amount)
Status	Int	1	Payment status 0 = Waiting 1 = Completed 2 = Refunded 3 = Failed 4 = Waiting for validation 5 = Cancelled 6 =Waiting for transfer
Beneficiary	SubAccountRef		Item containg recipient's details If not indicated, the account used is the main sub-account of the connected user
Message	String	"Restaurant Lunch"	Payment message
IsMine	Bool	true	True, if the account holder is also the bank card holder (it refers to an account top-up and not a payment), False if the bank card holder is not the owner of the account holder
ErrorCode	Int	0	Error code for failed payments, 0 if no errors. 1 = The merchant needs to contact cardholder's bank 2 = Payment refused 3 = Payment cancelled by the client 4 = Holder not 3D-Secure enrolled 5 = 3D- Secure error authentication 6 = Systempay error technique
ExtraResults	ExtraResults		Contains detailed return codes
UrlReturn	String		Client's callback URL invoked once the payment is done
UrlCallback	String		Specify the url of the callback server invoked at the end of the payment
AvailableCards	String	"CB;VISA"	List of cards to be displayed on the registration page. Possible values (to be separated with ‘ ;') : CB MASTERCARD MAESTRO VISA VISA_ELECTRON PAYPAL (activation exclusively on demand) ECV SOFORT
Type	Int	0	Payment types: 0 = Payment 1 = Refund
Card	Card		Details of the card associated with the payment. When creating a payment, please find out, if the card needs to be registered. It will be linked automatically to the user, if the parameter « IsMine » is true. (contact S-money to subscribe to this option)
PaymentSchedule	PaymentSchedule		Payment deadlines table (contact S-money to subscribe to this option)
Payments	Payments		Table of payments for payments to multiple receivers
PayerInfo	PayerInfo		Information concerning the payer
Require3DS	Bool	true	Allows to activate or deactivate 3DS, if the parameter is not transmitted, the 3DS will be always asked. (contact S-money to subscribe to the option)
Extraparameters	Extraparameters		List of parameters allowing to apply a predefined profile to the transaction.

2.ExtraResults

Property	Type	Description
BankAuthResult	Int	Return code of the authorisation request returned by the issuing bank, if available 0 = approved or successfully resolved transaction 2 = contact the card issuer 3 = invalid merchant 4 = retain the card 5 = do not honour 7 = retain the card, special conditions 8 = approve after identification 12 = invalid transaction 13 = invalid amount 14 = invalid holder number 15 = Unknown card issuer 17 = Client cancellation 19 = Repeat the transaction later 20 = Wrong answer (error in the server domain) 24 = File update is not supported 25 = Impossible to localize the registration in the file 26 = Registration duplicated, former registration replaced 27 = Error in « edit » on file update field 28 = Access to file not allowed 29 = Update is impossible 30 = format error 31 = acquiring organization identifier is unknown 33 = card validity date is expired 34 = suspicion of fraud 38 = Card validity date is expired 41 = card lost 43 = card stolen 51 = insufficient funds or credit exceeded 54 = card validity date is expired 55 = Wrong confidential code 56 = card not presented in the file 57 = transaction is not allowed for this holder 58 = transaction not permitted to terminal 59 = suspicion of fraud 60 = card acceptor must contact acquirer 61 = withdrawal amount exceeds the limit 63 = security rules not respected 68 = response not received or received too late 75 = Maximum number of failed confidential code attempts exceeded 76 = Holder is already blocked, former record kept 90 = temporary system unavailability 91 = card issuer inaccessible 94 = transaction duplicated 96 = system is not working properly 97 = global supervision timeout expiration 98 = server unavailable, routing network requested again 99 = incident in the initiator domain Numeric code of the risk controls result Null = No control performed 0 = All the controls completed successfully 2 = the card exceeded amounts authorised 3 = The card belongs to the grey list of the merchant 4 = The card-issuing country belongs to the grey list of the merchant or the card-issuing country does not belong to the white list of the merchant. 5 = The IP address belongs to the grey list of the merchant 6 = The bin code belongs to the grey list of the merchant 7 = Detection of the blue e-card 8 = Detection of the national commercial card 9 = Detection of a foreign commercial card 14 = Detection of a systematic authorisation card 20 = Coherence control: no corresponding country (IP country, country card, client country) 30 = The country of the IP address belongs to the grey list 99 = Technical problem encountered by the server when processing local controls Final status of the 3D-Secure process 0 = initial status 1 = Status not applicable (global, reason not specified) 2 = Status not applicable (integrator disabled) 3 = Non e-commerce payment 4 = Payment without 3DS (payment per identifier, paypal, cetelem, etc.) 5 = Merchant not 3DS enrolled 6 = Technical error of the 3D process, no 3DS 7 = Holder not enrolled, no 3DS 8 = Invalid signature 9 = Problem coming from the ACS 10 = The 3DS process correctly completed 11 = The 3DS was performed by the integrator 12 = Problem coming from the DS 13 = Timeout during DS connection 14 = Maintain for the delivery of this status 15 = Status not applicable (3DS present but deactivated) 16 = Payment channel for which 3DS is not available (payments per file...) 98 = initialization of the 3DS process is OK 99 = Unknown status
ThreedsResult	Int	Final status of the 3D-Secure process 0 = Initial status 1 = Status not applicable (global, reason not specified) 2 = Statut not applicable (integrator disabled) 3 = Non e-commerce payment 4 = Payment without 3DS (payment per identifier, paypal, cetelem, etc.) 5 = Merchant not 3DS enrolled 6 = Technical error of the 3D process, no 3DS 7 = Holder not enrolled, no 3DS 8 = Invalid signature 9 = Problem coming from the ACS 10 = The 3DS process correctly completed 11 = The 3DS was performed by the integrator 12 = Problem coming from the DS 13 = Timeout during DS connection 14 = Maintain for the delivery of this status 15 = Status not applicable (3DS present but deactivated) 16 = Payment channel for which 3DS is not available (payments per file...) 98 = initialization of the 3DS process is OK 99 = Unknown status
WarrantyResult	bool	Payment Warranty

3. SubaccountRef

This item allows identifying the accounts between which the operations are made.

Property	Type	Example	Description
Id	Long	98	Account identifier.
AppAccountId	String	"123"	Account identifier provided by the third-party application.
DisplayName	String	"Jean Dupont"	Account display name
Href	Uri	"/api/[partner_domain] /accounts/123"	Uri for the account details

Property	Type	Example	Description
Id	Long	1	Card ID
AppCardId	String	"card123"	Name of the card
Name	String	"Carte bancaire"	Name of the card
Hint	String	"597010XXXXXX0009"	Hide the card number
Network	Long	1	UNKNOWN = -1, AMEX = 0, CB = 1, MASTERCARD = 2, VISA = 3, MAESTRO = 4, ECARTEBLEUE = 5, AUROREMULTI = 6, BUYSTER = 7, COFINOGA = 8, JCB = 9, ONEY = 10, ONEY_SANDBOX = 11, PAYPAL = 12, PAYPAL_SB = 13, PAYSAFECARD = 14, VISA_ELECTRON = 15, COF3XCB = 16, COF3XCB_SB = 17, SOFORT_BANKING = 19, BANCONTACT = 20, IDEAL = 21, POSTFINANCE = 22, POSTFINANCE_EFIN = 23
Country	String	"FR"	ISO country code of the card used for the payment.

4.Card

Property	Type	Example	Description
Id	Long	1	Card ID
AppCardId	String	"card123"	Card identifier in the third-party application
Name	String	"Carte bancaire"	Card name
Hint	String	"597010XXXXXX0009"	Hide the card number
Country	String	"FR"	ISO country code of the card issued for the payment
ExpiryDate	DateTime	2017-07-01T00:00:00	Card expiry date (date from which a payment with this card will be no longer possible)

5. PaymentSchedule

The PaymentSchedule table allows managing payments in installments.

Property	Type	Example	Description
SequenceNumber	Int	1	Payment number. For payments in 3 installments, the value can be 1,2 or 3.
Amount	long	150	Amount of the installment payment
Date	DateTime	2013-09-10T 00:00:00.000000 +02:00	The date on which the payment will be sent
Status	Int	1	Payment status 0 = Waiting 1 = Completed 2 = Refunded 3 = Failed 4 = Waiting for validation 5 = Cancelled 6 = Waiting to be sent
Fee	long		Fee amount (the property "amount" does not include the fee amount)

It is possible to move to the creation of a payment either directly in the installments array or the item below which calculates automatically the amounts and dates of the installment:

Property	Type	Example	Description
FirstAmount	Long	10000	Amount of the first installment
Count	Int	3	Number of installments
Period	Int	30	Number of days between each installment
FirstFee	long		Fee amount of the first installment (the property "FirstAmount" does not include the fee amount)

The calculation of installments (amount and fee) is made with the help of the following rule:

N° d'échéance	Montant de l'échéance
1	Amount of the first installment
2	The entire value of [(total amount - amount of the first installment) / (installment number - 1)]
…
N (=installment number)	The entire value of [(total amount - amount of the first installment) / (installment number - 1)] + the rest of the division

6. Payerinfo

Property	Type	Exemple	Description
Name	String	"Jean Dupont"	Payer name and surname
Mail	String	"jean@dupont.fr	Payer e-mail

7. Payments

The Payments Array allows managing the list of payments created during a payment to multiple recipients

Property	Type	Example	Description
OrderId	Sring	"paiement123"	Payment identifier in the third-party application
Amount	long	1500	Payment amount
Status	Int	1	Payment status 0 = Waiting 1 = Completed 2 = Refunded 3 = Failed 4 = Waiting for validation 5 = Cancelled 6 = Waiting to be sent
Beneficiary	SubAccountRef		Item containg the details of the account of the payment recipient.
Fee	long	100	Fee amount (the property "Amount" does not include the fee amount)

8. Extraparameters

Property	Type	Example	Description
ProfileName	String	"directpayment"	A profile is a set of predefined parameters, which will be applied to the transaction, if it such a transaction is made.
SystempayLanguage	String	"fr"	Parameter enables the translation of the payment form page. Languages available in Systempay : German: de English: en Chinese: zh Spanish: es French: fr Italian: it Japanese: ja Dutch: nl Polish: pl Portugese: pt Russian: ru Swedish: sv Turkish: tr