The notification is done by sending an HTML form in POST mode to the address provided by the merchantNotifyUrl field of the payment authorization request :
- Value given in configuration/merchantNotifyUrl in case of a Payment Page or iFrame integration
- Value given in notificationUrl in case of a Full API integration
- Value given in Urls/MerchantNotifyUrl in a File Page integration
The content type of the notification is application/x-www-form-urlencoded
The notification is done from server to server in silent mode. It waits for an HTTP 200 return to be validated. In case of failure, the notification is sent again up to 5 times. After 5 attempts, the notification will not be sent anymore.
Each sending attempt is spaced 5 minutes apart.
Notification can only be done on URLs in https://.
Relative URLs are not allowed.
The notification is done from server to server in silent mode. It waits for an HTTP 200 return to be validated. In case of failure, the notification is sent again up to 5 times. After 5 attempts, the notification will not be sent anymore.
Output parameters
| Field | Description | Type |
|---|---|---|
| version* | Version of the payment platform used (=1.0) | String |
| merchantID* | Merchant ID | String |
| merchantSiteID* | Merchant site ID | String |
| paymentOptionRef* | Payment method identifier | String |
| orderRef* | Unique reference of the order at the merchant | String(30) |
| freeText | Free text | String |
| invoiceId | Billing number | String |
| customerRef* | Customer reference | String(30) |
| date* | Order date (format: YYYYMMDD) | String |
| amount* | Total amount including VAT of the order (in cents) | String |
| decimalPosition* | Position of the decimal separator | String(10) |
| currency* | Order currency (=EUR) | String |
| country* | Country code (=FR) | String(2) |
| returnCode* | Payment result code : 0 : Successful (Transaction ok) 1 : Refused (Transaction is refused for various reasons) 2 : Refused by bank (Transaction is refused by our PSP or customer's bank) 3 : Failed (Technical failure) 4 : Pending (Transaction waiting for a manual review) 5 : Unknown (Transaction is on an indetermined state, consider that the transaction is refused) 6 : Canceled (Transaction cancelled) | String |
| merchantAccountRef | VAD contract Identifier implemented, in the merchant's nomenclature | String |
| scheduleDate1..n | Due date (installment payments only) | String |
| scheduleAmount1..n | Payment amount (installment payments only) | String |
| cardType | Type of card used for payment | String |
| storedCardID1..n | Registered card identifiers to be proposed for payment | String |
| storedCardLabel1..n | Names of registered cards to be proposed for payment | String |
| scoringToken* | Token returned by Eligibility in eligibilities[].token | String |
| hmac* | Seal from data certification | String |
*This information is always sent; the other information is only sent if used in the payment call
Payment notification example
<form method="post" name="PaymentForm" action="[url notification]">
<input type="hidden" name="version" value="1.0"/>
<input type="hidden" name="merchantID" value="xx"/>
<input type="hidden" name="merchantSiteID" value="xxx"/>
<input type="hidden" name="paymentOptionRef" value="xx"/>
<input type="hidden" name="orderRef" value="011729685"/>
<input type="hidden" name="freeText" value="Texte"/>
<input type="hidden" name="invoiceID" value="115224183"/>
<input type="hidden" name="customerRef" value="000000091XLW"/>
<input type="hidden" name="date" value="20090706"/>
<input type="hidden" name="amount" value="31998"/>
<input type="hidden" name="decimalPosition" value="2"/>
<input type="hidden" name="currency" value="EUR"/>
<input type="hidden" name="country" value="FR"/>
<input type="hidden" name="returnCode" value="0"/>
<input type="hidden" name="merchantAccountRef" value="CBCE@SIPS"/>
<input type="hidden" name="scheduleDate1" value="20201015"/>
<input type="hidden" name="scheduleAmount1" value="8001"/>
<input type="hidden" name="scheduleDate2" value="20201114"/>
<input type="hidden" name="scheduleAmount2" value="7999"/>
<input type="hidden" name="scheduleDate3" value="20201214"/>
<input type="hidden" name="scheduleAmount3" value="7999"/>
<input type="hidden" name="scheduleDate4" value="20210113"/>
<input type="hidden" name="scheduleAmount4" value="7999"/>
<input type="hidden" name="cardType" value="CB"/>
<input type="hidden" name="scoringToken" value="66F36A5FD022B920941F213FAE7AE95E7C97EEB7"/>
<input type="hidden" name="hmac" value="66F36A5FD022B920941F213FAE7AE95E7C97EEB7"/>
</form>