About FLOA Pay
General information about FLOA Pay
| Logo |
|
|---|---|
| Info | FLOA Pay allows a merchant to offer 3X, 4X, 1XD or 3XD installment plans for customers during checkout. During the first step FLOA Pay checks the customer for eligibility for chosen installment. Then, in case of positive result, FLOA Pay redirects the customer to FLOA Pay Hosted Payment page. A merchant can be configured on FLOA Pay side for AUTO Capture or for MANUAL Capture. In case of AUTO Capture, FLOA Pay does not expect capture from the merchant. FLOA Pay does capture automatically based on the authorization. In case of MANUAL Capture, the merchant needs to call Capture API. After a credit check, FLOA Pay assumes the entire customer's payment default risk for each transaction. The merchant receives full amount of the installment from FLOA Pay after capture. |
| Type | Payments by Invoice and Installments |
Further information can be found on the webpage of Floa Pay (https://www.floapay.com/).
Process flow chart
Paygate interface
Format Description a alphabetical as alphabetical with special characters n numeric an alphanumeric ans alphanumeric with special characters ns numeric with special characters bool boolean expression (true or false) 3 fixed length with 3 digits/characters ..3 variable length with maximum 3 digits/characters enum enumeration of allowed values dttm ISODateTime (YYYY-MM-DDThh:mm:ss) Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.Definitions
Data formats
Abbreviations
Comment If a parameter is mandatory, then it must be present If a parameter is optional, then it can be present, but it is not required If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional
Authorization
To create an installment, call the following URL:
Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. |
TransID | ans..64 | M | Merchant transaction number, which must be unique |
| RefNr | ans..30 | O | Unique reference number |
Amount | n..10 | M | Total order amount in the smallest currency unit (e.g. EUR Cent) incl. rebates and taxes. |
Currency | a3 | M | Currency, three digits DIN / ISO 4217 Only EUR permissible. |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
URLSuccess | ans..256 | M | Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData. |
URLFailure | ans..256 | M | Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData. |
Response | a7 | O | Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
URLNotify | ans..256 | M | Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead. |
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
| Language | ans..5 | O | Language. "fr-FR" is default value. Possible values:
|
| MerchantIDExt | n..10 | O | MerchantID provided by FLOA Pay. |
| PayType | n..10 | O | MerchantSiteID provided by FLOA Pay. |
| CustomerID | ans..30 | M | The unique identifier of the customer inside the information system of the merchant. |
| FirstName | ans..64 | M | First name of the buyer. |
| LastName | ans..64 | M | Last name of the buyer. |
| MaidenName | ans..64 | O | Birth name. |
| Salutation | ans..3 | O | Salutation. |
| DateOfBirth | dttm | O | Date of birth of the buyer. Format: YYYY-MM-DD |
| PlaceOfBirth | ans..6 | O | The birth zip code.
|
| MobileNr | ans..15 | M | Home or cell phone number. |
| ans..60 | M | Email address of the buyer. | |
| AddrStreet | ans..32 | M | The main address. |
| AddrStreet2 | ans..32 | O | Additional address 1 (building, apartment, door code). |
| AddrZIP | ans..5 | M | Zip code |
| AddrCity | ans..50 | M | City |
| AddrCountryCode | ans..2 | M | Country code. Must follow the ISO 3166-2 standards. |
| PersonID | ans..8 | C | Tax Indentificaiton Number, mandatory for customerst in Spain and Italy. Mandatory if Country="ES" or Country="IT" |
| Date | ans..10 | M | Date of purchase of the order. Format DD/MM/YYYY. |
| Channel | ans..18 | M | Sales channel. Possible values:
|
| DeliveryChannel | ans..3 | M | Merchant delivery method. "STD" is default value. |
| NumberArticles | ans..3 | M | Number of articles in the order. |
| ActivationDelay | n..3 | C | Number of days of deferral. Only for 1XD. |
| Homepage | ans..256 | M | URL of the homepage of the merchant site. |
| URLBack | ans..256 | M | URL back to the previous page of the merchant site |
| Fee | n..10 | O | Total amount of fees associated with the order (in cents) |
| Discount | n..10 | O | Total amount of discounts associated with the order (in cents) |
| OrderShippingCost | n..10 | O | Total amount of delivery costs for the order (in cents) |
| sdStreet | ans..32 | O | Shipping address line 1 |
| sdStreet2 | ans..32 | O | Shipping address line 2 |
| sdZIP | ans..5 | O | Shipping postal code |
| sdCity | ans..50 | O | Shipping city |
| sdCountryCode | ans..2 | O | Alpha-2 ISO country code (e.g. FR) |
| CustomerHistory | ans..1024 | O | Customer history information as JSON string in Base64 format. See JSON object: CustomerHistory |
| TravelDetails | ans..1024 | O | Travel details information (including passport data) as JSON string in Base64 format. See JSON object: TravelDetails |
| StayDetails | ans..1024 | O | Stay details information as JSON string in Base64 format. See JSON object: StayDetails |
| ProductDetails | ans..1024 | O | Product details information as JSON string in Base64 format. See JSON object: ProductDetails |
The following table describes the result parameters that the Paygate transmits to your URLSuccess, URLFailure or URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. |
XID | an32 | M | ID for all single transactions for one payment assigned by Paygate |
TransID | ans..64 | M | Merchant’s transaction number |
RefNr | ans..30 | O | Merchant’s unique reference number |
Status | a..30 | M | AUTHORIZE_REQUEST or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
CodeExt | ans..1024 | O | Error code from FLOA Pay, if agreed with Computop Helpdesk |
ErrorText | ans..1024 | O | Error text from FLOA Pay, if agreed with Computop Helpdesk |
Cancel
Only full reversal is allowed.
To cancell an installment, call the following URL:
Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Paygate for the payment to be reversed |
TransID | ans..64 | M | Merchant ID for the identification of the payment process to be reversed |
| RefNr | ans..30 | O | Merchant’s unique reference number |
Amount | n..10 | M | Total order amount in the smallest currency unit (e.g. EUR Cent) incl. rebates and taxes. |
Currency | a..3 | M | Currency, three digits DIN / ISO 4217 Only EUR permissible. |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
| ReqID | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
The following table describes the result parameters with which the Computop Paygate responds to your system.
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. |
XID | an32 | M | ID for all single transactions for one payment assigned by Paygate |
TransID | ans..64 | M | Merchant’s transaction number |
RefNr | ans..30 | O | Merchant’s unique reference number |
Status | a..30 | M | OK or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
CodeExt | ans..1024 | O | Error code from FLOA Pay, if agreed with Computop Helpdesk |
ErrorText | ans..1024 | O | Error text from FLOA Pay, if agreed with Computop Helpdesk |
Credit
Both full refund and partial refund are allowed.
To refund an installment, call the following URL:
Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Paygate for the payment to be reversed |
TransID | ans..64 | M | Merchant ID for the identification of the payment process to be reversed |
| RefNr | ans..30 | O | Merchant’s unique reference number |
Amount | n..10 | M | Total order amount in the smallest currency unit (e.g. EUR Cent) incl. rebates and taxes. |
Currency | a..3 | M | Currency, three digits DIN / ISO 4217 Only EUR permissible. |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
| ReqID | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
The following table describes the result parameters with which the Computop Paygate responds to your system.
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. |
XID | an32 | M | ID for all single transactions for one payment assigned by Paygate |
TransID | ans..64 | M | Merchant’s transaction number |
RefNr | ans..30 | O | Merchant’s unique reference number |
Status | a..30 | M | OK or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
CodeExt | ans..1024 | O | Error code from FLOA Pay, if agreed with Computop Helpdesk |
ErrorText | ans..1024 | O | Error text from FLOA Pay, if agreed with Computop Helpdesk |
Capture
Both full capture and partial capture are possible.
To capture an installment, call the following URL:
Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Paygate for the payment to be reversed |
TransID | ans..64 | M | Merchant ID for the identification of the payment process to be reversed |
| RefNr | ans..30 | O | Merchant’s unique reference number |
Amount | n..10 | M | Total order amount in the smallest currency unit (e.g. EUR Cent) incl. rebates and taxes. |
Currency | a..3 | M | Currency, three digits DIN / ISO 4217 Only EUR permissible. |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
| ReqID | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
The following table describes the result parameters with which the Computop Paygate responds to your system.
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. |
XID | an32 | M | ID for all single transactions for one payment assigned by Paygate |
TransID | ans..64 | M | Merchant’s transaction number |
RefNr | ans..30 | O | Merchant’s unique reference number |
Status | a..30 | M | OK or FAILED |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
CodeExt | ans..1024 | O | Error code from FLOA Pay, if agreed with Computop Helpdesk |
ErrorText | ans..1024 | O | Error text from FLOA Pay, if agreed with Computop Helpdesk |
JSON Objects
CustomerHistory
| Key | Format | CND | Description |
|---|---|---|---|
| CanceledOrderAmount | n..10 | O | Total amount in cents of orders cancelled in the last 2 years |
| CanceledOrderCount | n..3 | O | Number of orders placed and cancelled by the customer in the last 2 years |
| FirstOrderDate | ans..10 | O | Date of first customer order in format DD/MM/YYYY. |
| FraudAlertCount | n..3 | O | Number of fraud alerts regarding customer orders in the last 2 years |
| LastOrderDate | ans..10 | O | Date of last customer order in format DD/MM/YYYY. |
| PaymentIncidentCount | n..3 | O | Number of payment incidents involving customer orders in the last 2 years |
| RefusedManyTimesOrderCount | n..3 | O | Number of orders whose payment in instalments has been refused in the last 2 years |
| UnvalidatedOrderCount | n..3 | O | Number of orders refused in the validation phase in the last 2 years |
| ValidatedOneTimeOrderCount | n..3 | O | Number of orders paid in 1 installment in the last 2 years |
| ValidatedOrderCount | n..3 | O | Number of orders validated in the last 2 years |
| ClientIpAddressRecurrence | n..3 | O | Customer IP address recurrence in the last 2 years |
| OngoingLitigationOrderAmount | n..10 | O | Current amounts in dispute not settled |
| PaidLitigationOrderAmount24Month | n..10 | O | Amount of litigation settled in the last 2 years |
| ScoreSimulationCount7Days | n..3 | O | Number of simulated scores in the last 7 days |
Schema of CustomerHistory
TravelDetails
| Key | Format | CND | Description |
|---|---|---|---|
| Insurance | ans..30 | O | Type of supplementary insurance chosen by the customer. Depends on the merchant. |
| TravelType | ans..30 | O | Type of flights: - Unknown: Unknown- OneWay: One way- TwoWay: Round trip - Multiple: Multi-destination |
| DepartureDate | ans..16 | C Mandatory for tour operators, Optional for all others. | Start date format: DD/MM/YYYY HH:MM |
| ReturnDate | ans..30 | C Mandatory for tour operators, Optional for all others. | Return date format: DD/MM/YYYY HH:MM |
| DestinationCountry | ans..2 | C Mandatory for tour operators, Optional for all others. | Alpha-2 ISO code of the destination country |
| TicketCount | n..3 | O | Number of tickets. |
| TravellerCount | n..3 | C Mandatory for tour operators, Optional for all others. | Number of passengers |
| travelClass | ans..16 | O | Type of class chosen: - Unknown |
| OwnTicket | n..1 | O | Indicator to identify whether the holder of the credit card used to fund the trip is participating: |
| MainDepartureCompany | ans..3 | O | Airline Company One Way Flight |
| TravellerPassportList | Array | O | Information concerning the passport(s) of the traveler(s) Array of TravellerPassport (see JSON object: TravellerPassport) |
| DepartureAirport | ans..3 | O | IATA code of the airport of departure |
| ArrivalAirport | ans..3 | O | IATA code of the arrival airport |
| DiscountCode | ans..30 | O | Discount code |
| LuggageSupplement | ans..30 | O | Luggage supplement |
| ModificationCancellation | n..1 | O | Modification-cancellation. |
TravellerPassport
| Key | Format | CND | Description |
|---|---|---|---|
| ExpirationDate | ans..10 | O | Passport expiration date in DD/MM/YYYY format |
| IssuanceCountry | ans..2 | O | Alpha-2 ISO code of the country of issue of the passport |
Schema of TravelDetails
StayDetails
| Key | Format | CND | Description |
|---|---|---|---|
| Company | ans..50 | O | Shipowner/Operator/Hotel chain |
| Destination | ans..50 | O | Destination city |
| NightNumber | n..3 | O | Number of overnight stays |
| RoomRange | n..3 | O | Room range |
Schema of StayDetails
ProductDetails
| Key | Format | CND | Description |
|---|---|---|---|
| Category1 | ans..30 | O | Product category number 1 |
| Category2 | ans..30 | O | Product category number 2 |
| Category3 | ans..30 | O | Product category number 3 |
Schema of ProductDetails
