Before starting the integration of FLOA, we strongly recommend the review of the following documentation : Integration process and advice - FLOA Pay (direct)

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

Procecss flow for FLOA Pay installments

Notice: FLOA Pay makes eligibility check based on the provided data and in case of success redirects the customer to the payment page. The result of the authorisation is provided in the callback and in the notification.

interface

Authorization

In order to create an installment with FLOA Pay, please use the following URL:

floapay.aspx

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description
MerchantID	ans..30	M	MerchantID, assigned by . Additionally this parameter has to be passed in plain language too.

Key	Format	CND	Description
TransID	ans..64	M	TransactionID provided by you which should be unique for each payment

Key	Format	CND	Description	Beschreibung
RefNr	an..30	O	Merchant’s unique reference number	Eindeutige Referenznummer des Händlers

Key	Format	CND	Description
Amount	n..10	M	Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , if you want to capture amounts <100 (smallest currency unit).

No Table Excerpt macro with name Currency_EUR found. Did you publish the page with the Table Excerpt macro?

Key	Format	CND	Description
MAC	an64	M	Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify)

Key	Format	CND	Description
URLSuccess	ans..256	M	Complete URL which calls up 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 and shop, please use the parameter UserData. Common notes: We recommend to use parameter "response=encrypted" to get an encrypted response by However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Key	Format	CND	Description
URLFailure	ans..256	M	Complete URL which calls up 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 and shop, please use the parameter UserData. Common notes: We recommend to use parameter "response=encrypted" to get an encrypted response by However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Key	Format	CND	Description
Response	a7	O	Status response sent by to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

Key	Format	CND	Description
URLNotify	ans..256	M	Complete URL which 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. Common notes: We recommend to use parameter "response=encrypted" to get an encrypted response by However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Key	Format	CND	Description
UserData	ans..1024	O	If specified at request, forwards the parameter with the payment result to the shop.

Key	Format	CND	Description
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 / action is submitted again with the same ReqID, will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Key	Format	CND	Description	Beschreibung
EventToken	ans..5	O	In case the parameter is not sent, this is common authorization request In case EventToken=SCHEDULE, the request returns estimated schedule based on Amount.
Language	ans..5	O	Language. "fr-FR" is default value. Possible values: "fr-FR" for a French order in French "fr-BE" for a Belgian order in French "nl-BE" for a Belgian order in Flemish "en-BE" for a Belgian order in English "es-ES" for a Spanish order in Spanish language "it-IT" for an Italian order in Italian language	Sprache. "fr-FR" ist der Standardwert. Mögliche Werte: "fr-FR" für eine französische Bestellung in Französisch "fr-BE" für eine belgische Bestellung in Französisch "nl-BE" für eine belgische Bestellung in Flämisch "en-BE" für eine belgische Bestellung in Englisch "es-ES" für eine spanische Bestellung in Spanisch "it-IT" für eine italienische Bestellung in Italienisch
MerchantIDExt	n..10	O	MerchantID provided by FLOA Pay	Von FLOA Pay bereitgestellte MerchantID
PayType	n..10	O	MerchantSiteID provided by FLOA Pay	Von FLOA Pay bereitgestellte MerchantSiteID
CustomerID	ans..30	C	The unique identifier of the customer inside the information system of the merchant Mandatory in case parameter EventToken is not sent.	Die eindeutige Kennung des Kunden im Informationssystem des Händlers
FirstName	ans..64	C	First name of the buyer Mandatory in case parameter EventToken is not sent.	Vorname des Käufers
LastName	ans..64	C	Last name of the buyer Mandatory in case parameter EventToken is not sent.	Nachname des Käufers
MaidenName	ans..64	O	Birth name	Geburtsname
Salutation	ans..3	O	Salutation	Anrede
DateOfBirth	dttm	O	Date of birth of the buyer. Format: YYYY-MM-DD	Geburtsdatum des Käufers. Format: JJJJ-MM-TT
PlaceOfBirth	ans..6	O	The birth zip code. Must contain 2, 3 or 5 caracters Must be "99" if foreigner Must be "972" for Martinique Must be "06000" for Nice and not "6000"	Postleitzahl des Geburtsortes. Muss 2, 3 oder 5 Zeichen enthalten Muss "99" sein, wenn Ausländer Muss "972" für Martinique sein Muss "06000" für Nizza sein und nicht "6000"
MobileNr	ans..15	C	Home or cell phone number Mandatory in case parameter EventToken is not sent.	Privat- oder Handynummer
Email	ans..60	C	Email address of the buyer Mandatory in case parameter EventToken is not sent.	E-Mail-Adresse des Käufers
AddrStreet	ans..32	O	The main address	Die Hauptadresse
AddrStreet2	ans..32	O	Additional address 1 (building, apartment, door code)	Zusatzadresse 1 (Gebäude, Wohnung, Türcode)
AddrZIP	ans..10	O	Zip code	Postleitzahl
AddrCity	ans..50	O	City	Ort
AddrCountryCode	ans..2	C	Country code 2 digits according to ISO 3166-2 Mandatory in case parameter EventToken is not sent.	Ländercode zweistellig gemäß ISO 3166-2
PersonID	ans..8	C	Tax Indentification number, mandatory for customer in Spain and Italy. Mandatory if Country="ES" or Country="IT"	Steueridentifikationsnummer, obligatorisch für Kunden in Spanien und Italien. Obligatorisch wenn Country="ES" oder Country="IT"
Date	ans..10	C	Date of purchase of the order. Format: DD/MM/YYYY Mandatory in case parameter EventToken is not sent.	Kaufdatum der Bestellung. Format: TT/MM/JJJJ
Channel	ans..18	C	Sales channel. Possible values: DESKTOP TABLET TABLET_IPAD SMARTPHONE SMARTPHONE_ANDROID SMARTPHONE_IPHONE Mandatory in case parameter EventToken is not sent.	Verkaufskanal. Mögliche Werte: DESKTOP TABLET TABLET_IPAD SMARTPHONE SMARTPHONE_ANDROID SMARTPHONE_IPHONE
DeliveryChannel	ans..3	C	Merchant delivery method. "STD" is default value. Mandatory in case parameter EventToken is not sent.	Liefermethode des Händlers. „STD“ ist der Standardwert.
NumberArticles	ans..3	C	Number of articles in the order Mandatory in case parameter EventToken is not sent.	Anzahl der Artikel in der Bestellung
ActivationDelay	n..3	C	Only for 1XD: Number of days of deferral	Nur für 1XD: Anzahl Tage der Zurückstellung
Homepage	ans..256	C	URL of the homepage of the merchant site Mandatory in case parameter EventToken is not sent.	URL der Homepage der Händlerseite
URLBack	ans..256	C	URL back to the previous page of the merchant site Mandatory in case parameter EventToken is not sent.	URL zurück zur vorherigen Seite der Händlerseite
Fee	n..10	O	Total amount of fees associated with the order (in cents)	Gesamtbetrag der mit der Bestellung verbundenen Gebühren (in Cent)
Discount	n..10	O	Total amount of discounts associated with the order (in cents)	Gesamtbetrag der mit der Bestellung verbundenen Rabatte (in Cent)
shAmount	n..10	O	Total amount of delivery costs for the order (in cents)	Gesamtbetrag der Versandkosten für die Bestellung (in Cent)
sdStreet	ans..32	O	Shipping address line 1	Lieferadresse Zeile 1
sdStreet2	ans..32	O	Shipping address line 2	Lieferadresse Zeile 2
sdZIP	ans..10	O	Shipping postal code	Postleitzahl der Lieferadresse
sdCity	ans..50	O	Shipping city	Ort der Lieferadresse
sdCountryCode	ans..2	O	Alpha-2 ISO country code (e.g. FR)	Alpha-2 ISO-Ländercode (z. B. FR)
CustomerHistory	ans..1024	O	Customer history information as JSON string in Base64 format. See JSON object: CustomerHistory	Informationen zur Kundenhistorie als JSON-String im Base64-Format. Siehe JSON-Objekt: CustomerHistory
TravelDetails	ans..1024	O	Travel details information (including passport data) as JSON string in Base64 format. See JSON object: TravelDetails	Reisedetails (einschließlich Passdaten) als JSON-String im Base64-Format. Siehe JSON-Objekt: TravelDetails
StayDetails	ans..1024	O	Stay details information as JSON string in Base64 format. See JSON object: StayDetails	Aufenthaltsdetails als JSON-String im Base64-Format. Siehe JSON-Objekt: StayDetails
ProductDetails	ans..1024	O	Product details information as JSON string in Base64 format. See JSON object: ProductDetails	Produktdetails als JSON-String im Base64-Format. Siehe JSON-Objekt: ProductDetails
AdditionalFields	ans..1024	O	Array of AdditionalField JSON object as string in Base64 format.	Array of AdditionalField JSON object as string in Base64 format.

Parameter for installments with FLOA Pay

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description
MID	ans..30	M	MerchantID, assigned by

Key	Format	CND	Description
PayID	an32	M	ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Key	Format	CND	Description
XID	an32	M	ID for all single transactions (authorisation, capture, credit note) for one payment assigned by

Key	Format	CND	Description
TransID	ans..64	M	TransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

refnr

ans..30

O

Merchant’s unique reference number

The format depends on the available paymethods for your MerchantId. Please choose your format in that way that all paymethods are covered.

We recommend to use the most restrictive format for this parameter (AN12 - M) and create unique RefNr.

Additional information : Data reconciliation : Key Data

Key	Format	CND	Description	Beschreibung
Status	a..50	M	AUTHORIZE_REQUEST (URLSuccess) or FAILED (URLFailure)	AUTHORIZE_REQUEST (URLSuccess) oder FAILED (URLFailure)

Key	Format	CND	Description
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!

Key	Format	CND	Description
Code	n8	M	Error code according to Response Codes (A4 Response codes)

Key	Format	CND	Description
UserData	ans..1024	O	If specified at request, forwards the parameter with the payment result to the shop.

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Error code from FLOA Pay, if agreed with

Fehlercode von FLOA Pay, wenn mit The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen

ErrorText

ans..256

O

Error text from FLOA Pay, if agreed with

Fehlertext von FLOA Pay, wenn mit The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen

PaymentDetails

ans..512

O

In case EventToken=SCHEDULE the parameter contains information about estimated schedule in the following format.

Example: <TotalAmount>;<Date1>;<Amount1>;<Date2>;<Amount2>;<Date3>;<Amount3>;...

<TotalAmount> is full amount which customer will pay (purchase amount + interest, fees, etc.)

<Date1> is date of first repayment

<Amount1> is amount of first repayment

etc.

Return parameters for installments with FLOA Pay

Capture

Captures are possible via a Server-to-Server connection. Both full capture and partial capture are possible. To capture a FLOA Pay installment via a Server-to-Server connection, please use the following URL:

capture.aspx

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description
MerchantID	ans..30	M	MerchantID, assigned by . Additionally this parameter has to be passed in plain language too.

Key	Format	CND	Description
PayID	an32	M	ID assigned by for the payment to be captured

Key	Format	CND	Description
TransID	ans..64	M	TransactionID provided by you which should be unique for each payment

Key	Format	CND	Description
Amount	n..10	M	Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , if you want to capture amounts <100 (smallest currency unit).

No Table Excerpt macro with name Currency_EUR found. Did you publish the page with the Table Excerpt macro?

Key	Format	CND	Description
MAC	an64	M	Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify)

Key	Format	CND	Description
UserData	ans..1024	O	If specified at request, forwards the parameter with the payment result to the shop.

Key

Format

CND

Description

refnr

ans..30

O

Merchant’s unique reference number

The format depends on the available paymethods for your MerchantId. Please choose your format in that way that all paymethods are covered.

We recommend to use the most restrictive format for this parameter (AN12 - M) and create unique RefNr.

Additional information : Data reconciliation : Key Data

Key	Format	CND	Description
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 / action is submitted again with the same ReqID, will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for captures with FLOA Pay

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description
MID	ans..30	M	MerchantID, assigned by

Key	Format	CND	Description
PayID	an32	M	ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Key	Format	CND	Description
XID	an32	M	ID for all single transactions (authorisation, capture, credit note) for one payment assigned by

Key	Format	CND	Description
TransID	ans..64	M	TransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

refnr

ans..30

O

Merchant’s unique reference number

The format depends on the available paymethods for your MerchantId. Please choose your format in that way that all paymethods are covered.

We recommend to use the most restrictive format for this parameter (AN12 - M) and create unique RefNr.

Additional information : Data reconciliation : Key Data

Key	Format	CND	Description
Status	a..50	M	OK (URLSuccess) or FAILED (URLFailure)

Key	Format	CND	Description
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!

Key	Format	CND	Description
Code	n8	M	Error code according to Response Codes (A4 Response codes)

Key	Format	CND	Description
UserData	ans..1024	O	If specified at request, forwards the parameter with the payment result to the shop.

Key	Format	CND	Description	Beschreibung
CodeExt	n..10	O	Error code from FLOA Pay, if agreed with	Fehlercode von FLOA Pay, wenn mit The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen
ErrorText	ans..256	O	Error text from FLOA Pay, if agreed with	Fehlertext von FLOA Pay, wenn mit The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen

Response parameters for captures with FLOA Pay

Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. Both full refund and partial refund are allowed. To refund a FLOA Pay installment, please use the following URL:

credit.aspx

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description
MerchantID	ans..30	M	MerchantID, assigned by . Additionally this parameter has to be passed in plain language too.

Key	Format	CND	Description
PayID	an32	M	ID assigned by for the payment to be credited

Key	Format	CND	Description
TransID	ans..64	M	TransactionID provided by you which should be unique for each payment

Key	Format	CND	Description
Amount	n..10	M	Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , if you want to capture amounts <100 (smallest currency unit).

No Table Excerpt macro with name Currency_EUR found. Did you publish the page with the Table Excerpt macro?

Key	Format	CND	Description
MAC	an64	M	Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify)

Key	Format	CND	Description
UserData	ans..1024	O	If specified at request, forwards the parameter with the payment result to the shop.

Key

Format

CND

Description

refnr

ans..30

O

Merchant’s unique reference number

The format depends on the available paymethods for your MerchantId. Please choose your format in that way that all paymethods are covered.

We recommend to use the most restrictive format for this parameter (AN12 - M) and create unique RefNr.

Additional information : Data reconciliation : Key Data

Key	Format	CND	Description
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 / action is submitted again with the same ReqID, will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for credits of payments with FLOA Pay

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description
MID	ans..30	M	MerchantID, assigned by

Key	Format	CND	Description
PayID	an32	M	ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Key	Format	CND	Description
XID	an32	M	ID for all single transactions (authorisation, capture, credit note) for one payment assigned by

Key	Format	CND	Description
TransID	ans..64	M	TransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

refnr

ans..30

O

Merchant’s unique reference number

The format depends on the available paymethods for your MerchantId. Please choose your format in that way that all paymethods are covered.

We recommend to use the most restrictive format for this parameter (AN12 - M) and create unique RefNr.

Additional information : Data reconciliation : Key Data

Key	Format	CND	Description
Status	a..50	M	OK (URLSuccess) or FAILED (URLFailure)

Key	Format	CND	Description
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!

Key	Format	CND	Description
Code	n8	M	Error code according to Response Codes (A4 Response codes)

Key	Format	CND	Description
UserData	ans..1024	O	If specified at request, forwards the parameter with the payment result to the shop.

Key	Format	CND	Description	Beschreibung
CodeExt	n..10	O	Error code from FLOA Pay, if agreed with	Fehlercode von FLOA Pay, wenn mit The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen
ErrorText	ans..256	O	Error text from FLOA Pay, if agreed with	Fehlertext von FLOA Pay, wenn mit The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen

Response parameters for credits of payments with FLOA Pay

Reverse

Reversals are possible via a Server-to-Server connection. Only full reversal is allowed. In order to reverse a FLOA Pay installment, please use the following URL:

reverse.aspx

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description
MerchantID	ans..30	M	MerchantID, assigned by . Additionally this parameter has to be passed in plain language too.

Key	Format	CND	Description
PayID	an32	M	ID assigned by for the payment to be reversed

Key	Format	CND	Description
TransID	ans..64	M	TransactionID provided by you which should be unique for each payment

Key	Format	CND	Description
Amount	n..10	M	Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , if you want to capture amounts <100 (smallest currency unit).

No Table Excerpt macro with name Currency_EUR found. Did you publish the page with the Table Excerpt macro?

Key	Format	CND	Description
MAC	an64	M	Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify)

Key	Format	CND	Description
UserData	ans..1024	O	If specified at request, forwards the parameter with the payment result to the shop.

Key

Format

CND

Description

refnr

ans..30

O

Merchant’s unique reference number

The format depends on the available paymethods for your MerchantId. Please choose your format in that way that all paymethods are covered.

We recommend to use the most restrictive format for this parameter (AN12 - M) and create unique RefNr.

Additional information : Data reconciliation : Key Data

Key	Format	CND	Description
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 / action is submitted again with the same ReqID, will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for reversals of payments with FLOA Pay

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description
MID	ans..30	M	MerchantID, assigned by

Key	Format	CND	Description
PayID	an32	M	ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Key	Format	CND	Description
XID	an32	M	ID for all single transactions (authorisation, capture, credit note) for one payment assigned by

Key	Format	CND	Description
TransID	ans..64	M	TransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

refnr

ans..30

O

Merchant’s unique reference number

The format depends on the available paymethods for your MerchantId. Please choose your format in that way that all paymethods are covered.

We recommend to use the most restrictive format for this parameter (AN12 - M) and create unique RefNr.

Additional information : Data reconciliation : Key Data

Key	Format	CND	Description
Status	a..50	M	OK (URLSuccess) or FAILED (URLFailure)

Key	Format	CND	Description
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!

Key	Format	CND	Description
Code	n8	M	Error code according to Response Codes (A4 Response codes)

Key	Format	CND	Description
UserData	ans..1024	O	If specified at request, forwards the parameter with the payment result to the shop.

Key	Format	CND	Description	Beschreibung
CodeExt	n..10	O	Error code from FLOA Pay, if agreed with	Fehlercode von FLOA Pay, wenn mit The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen
ErrorText	ans..256	O	Error text from FLOA Pay, if agreed with	Fehlertext von FLOA Pay, wenn mit The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgesprochen

Reponse parameters for reversals of payments with FLOA Pay

JSON Objects

The JavaScript Object Notation, JSON for short, is a compact data format in an easy-to-read text format for the purpose of exchanging data between applications. JSON does not depend on the programming language. Parsers exist in practically all widely used languages. You can find more information about JSON via this link:

https://wiki.selfhtml.org/wiki/JavaScript/JSON

The next section describes JSON objects which are required for requests or returned in the response.

Notice: The JSON string can include special characters and so must also be Base64 encoded. Transfer problems may otherwise occur.

CustomerHistory

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description	Beschreibung
CanceledOrderAmount	n..10	O	Total amount in cents of orders cancelled in the last 2 years	Gesamtbetrag in Cent der in den letzten 2 Jahren stornierten Bestellungen
CanceledOrderCount	n..3	O	Number of orders placed and cancelled by the customer in the last 2 years	Anzahl der vom Kunden in den letzten 2 Jahren aufgegebenen und stornierten Bestellungen
FirstOrderDate	ans..10	O	Date of first customer order in format DD/MM/YYYY	Datum der ersten Kundenbestellung im Format TT/MM/JJJJ
FraudAlertCount	n..3	O	Number of fraud alerts regarding customer orders in the last 2 years	Anzahl der Betrugsmeldungen bezüglich Kundenbestellungen in den letzten 2 Jahren
LastOrderDate	ans..10	O	Date of last customer order in format DD/MM/YYYY	Datum der letzten Kundenbestellung im Format TT/MM/JJJJ
PaymentIncidentCount	n..3	O	Number of payment incidents involving customer orders in the last 2 years	Anzahl der Zahlungsvorfälle im Zusammenhang mit Kundenbestellungen in den letzten 2 Jahren
RefusedManyTimesOrderCount	n..3	O	Number of orders whose payment in instalments has been refused in the last 2 years	Anzahl der Bestellungen, deren Ratenzahlung in den letzten 2 Jahren abgelehnt wurde
UnvalidatedOrderCount	n..3	O	Number of orders refused in the validation phase in the last 2 years	Anzahl der in der Validierungsphase abgelehnten Bestellungen in den letzten 2 Jahren
ValidatedOneTimeOrderCount	n..3	O	Number of orders paid in 1 installment in the last 2 years	Anzahl der Bestellungen, die in den letzten 2 Jahren in 1 Rate bezahlt wurden
ValidatedOrderCount	n..3	O	Number of orders validated in the last 2 years	Anzahl der in den letzten 2 Jahren validierten Bestellungen
ClientIpAddressRecurrence	n..3	O	Customer IP address recurrence in the last 2 years	Wiederholung der Kunden-IP-Adresse in den letzten 2 Jahren
OngoingLitigationOrderAmount	n..10	O	Current amounts in dispute not settled	Laufende noch nicht beigelegte Streitwerte
PaidLitigationOrderAmount24Month	n..10	O	Amount of litigation settled in the last 2 years	Betrag der in den letzten 2 Jahren beigelegten Rechtsstreitigkeiten
ScoreSimulationCount7Days	n..3	O	Number of simulated scores in the last 7 days	Anzahl der simulierten Scores in den letzten 7 Tagen

Schema of CustomerHistory

{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"$id": "https://www.computop-paygate.com/schemas/merchantCustomerHistory.json",
	"title": "Merchant Customer History",
	"description": "Merchant Customer History Data",
	"type": "object",
	"properties": {
		"firstOrderDate": {
			"type": ["string", "null"],
			"minLength": 10,
			"maxLength": 10
		},
		"lastOrderDate": {
			"type": ["string", "null"],
			"minLength": 10,
			"maxLength": 10
		},
		"canceledOrderAmount": {
			"type": ["integer", "null"]
		},
		"canceledOrderCount": {
			"type": ["integer", "null"]
		},
		"fraudAlertCount": {
			"type": ["integer", "null"]
		},
		"paymentIncidentCount": {
			"type": ["integer", "null"]
		},
		"refusedManyTimesOrderCount": {
			"type": ["integer", "null"]
		},
		"unvalidatedOrderCount": {
			"type": ["integer", "null"]
		},
		"validatedOneTimeOrderCount": {
			"type": ["integer", "null"]
		},
		"validatedOrderCount": {
			"type": ["integer", "null"]
		},
		"clientIpAddressRecurrence": {
			"type": ["integer", "null"]
		},
		"ongoingLitigationOrderAmount": {
			"type": ["integer", "null"]
		},
		"paidLitigationOrderAmount24Month": {
			"type": ["integer", "null"]
		},
		"scoreSimulationCount7Days": {
			"type": ["integer", "null"]
		}
	},
	"additionalProperties": false
}

TravelDetails

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description	Beschreibung
Insurance	ans..30	O	Type of supplementary insurance chosen by the customer. Depends on the merchant.	Vom Kunden gewählte Art der Zusatzversicherung. Hängt vom Händler ab.
Traveltype	ans..30	O	Type of flights: - Unknown: Unknown - OneWay: One way - TwoWay: Round trip - Multiple: Multi-destination	Art der Flüge: - Unknown: unbekannt - OneWay: Einweg - TwoWay: Hin- und Rückflug - Multiple: mehrere Ziele
DepartureDate	ans..16	C	Mandatory for tour operators, Optional for all others: Start date in format: DD/MM/YYYY HH:MM	Pflicht für Reiseveranstalter, optional für alle anderen: Startdatum im Format: TT/MM/JJJJ HH:MM
ReturnDate	ans..30	C	Mandatory for tour operators, Optional for all others: Return date in format: DD/MM/YYYY HH:MM	Pflicht für Reiseveranstalter, optional für alle anderen: Rückreisedatum im Format: TT/MM/JJJJ HH:MM
DestinationCountry	ans..2	C	Mandatory for tour operators, Optional for all others: Alpha-2 ISO code of the destination country	Pflicht für Reiseveranstalter, optional für alle anderen: Alpha-2 ISO-Code des Ziellandes
TicketCount	n..3	O	Number of tickets	Anzahl der Tickets
TravellerCount	n..3	C	Mandatory for tour operators, Optional for all others: Number of passengers	Pflicht für Reiseveranstalter, optional für alle anderen: Anzahl der Passagiere
travelClass	ans..16	O	Type of class chosen: - Unknown - Economy - PremiumEconomy - Business - First - Others	Art der gewählten Klasse: - unbekannt - Economy - PremiumEconomy - Business - First - andere
OwnTicket	n1	O	Indicator to identify whether the holder of the credit card used to fund the trip is participating: 1 = true 0 = false	Indikator zur Erkennung, ob der Inhaber der zur Finanzierung der Reise verwendeten Kreditkarte teilnimmt: 1 = wahr 0 = falsch
MainDepartureCompany	ans..3	O	Airline Company One Way Flight	One-Way-Flug der Fluggesellschaft
TravellerPassportList	Array	O	Information concerning the passport(s) of the traveler(s) Array of TravellerPassport (see JSON object: TravellerPassport)	Informationen zu den Reisepässen des/der Reisenden Array of TravellerPassport (siehe JSON-Objekt: TravellerPassport)
DepartureAirport	ans..3	O	IATA code of the airport of departure	IATA-Code des Abflughafens
ArrivalAirport	ans..3	O	IATA code of the arrival airport	IATA-Code des Ankunftsflughafens
DiscountCode	ans..30	O	Discount code	Rabattcode
LuggageSupplement	ans..30	O	Luggage supplement	Gepäckzuschlag
ModificationCancellation	n1	O	Modification-cancellation. 1 = true 0 = false	Änderungsstornierung. 1 = wahr 0 = falsch

TravellerPassport

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description	Beschreibung
ExpirationDate	ans..10	O	Passport expiration date in format DD/MM/YYYY	Ablaufdatum des Reisepasses im Format TT/MM/JJJJ
IssuanceCountry	ans..2	O	Alpha-2 ISO code of the country of issue of the passport	Alpha-2-ISO-Code des Ausstellungslandes des Reisepasses

Schema of TravelDetails

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://www.computop-paygate.com/schemas/travelDetails.json",
    "title": "Travel Details",
    "description": "Travel Details Data",
    "type": "object",
    "properties": {
        "insurance": {
            "type": ["string", "null"],
            "maxLength": 30
        },
		"travelType": {
            "type": ["string", "null"],
            "maxLength": 30
        },
		"departureDate": {
            "type": ["string", "null"],
			"minLength": 16,
            "maxLength": 16
        },
		"returnDate": {
            "type": ["string", "null"],
			"minLength": 16,
            "maxLength": 16
        },
		"destinationCountry": {
            "type": ["string", "null"],
			"minLength": 2,
            "maxLength": 2
        },
		"ticketCount": {
            "type": ["integer", "null"]
        },
		"travellerCount": {
            "type": ["integer", "null"]
        },
		"travelClass": {
            "type": ["string", "null"],
			"enum": ["Unknown", "Economy", "PremiumEconomy", "Business", "First", "Others"],
            "maxLength": 16
        },
		"ownTicket": {
            "type": ["integer", "null"],
			"enum": [1, 0]
        },
		"mainDepartureCompany": {
            "type": ["string", "null"],
            "maxLength": 3
        },
		"travellerPassportList": {
            "type": "array",
			"items": {
				"type": ["object", "null"],
				"properties": {
					"expirationDate": {
						"type": ["string", "null"],
						"minLength": 10,
						"maxLength": 10
					},
					"issuanceCountry": {
						"type": ["string", "null"],
						"minLength": 2,
						"maxLength": 2
					}
				}
			}
        },
		"departureAirport": {
            "type": ["string", "null"],
			"minLength": 3,
            "maxLength": 3
        },
		"arrivalAirport": {
            "type": ["string", "null"],
			"minLength": 3,
            "maxLength": 3
        },
		"discountCode": {
            "type": ["string", "null"],
            "maxLength": 30
        },
		"luggageSupplement": {
            "type": ["string", "null"],
            "maxLength": 30
        },
		"modificationCancellation": {
            "type": ["integer", "null"],
			"enum": [1, 0]
        }
    },
    "additionalProperties": false
}

StayDetails

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description	Beschreibung
Company	ans..50	O	Shipowner/Operator/Hotel chain	Reeder/Betreiber/Hotelkette
Destination	ans..50	O	Destination city	Zielstadt
NightNumber	n..3	O	Number of overnight stays	Anzahl der Übernachtungen
RoomRange	n..3	O	Room range	Zimmerbereich

Schema of StayDetails

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://www.computop-paygate.com/schemas/stayDetails.json",
    "title": "Stay Details",
    "description": "Stay Details Data",
    "type": "object",
    "properties": {
        "company": {
            "type": ["string", "null"],
            "maxLength": 50
        },
		"destination": {
            "type": ["string", "null"],
			"maxLength": 50
        },
		"nightNumber": {
            "type": ["integer", "null"]
        },
		"roomRange": {
            "type": ["integer", "null"]
        }
    },
    "additionalProperties": false
}

ProductDetails

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key	Format	CND	Description	Beschreibung
Category1	ans..30	O	Product category number 1	Produktkategorienummer 1
Category2	ans..30	O	Product category number 2	Produktkategorienummer 2
Category3	ans..30	O	Product category number 3	Produktkategorienummer 3

Schema of ProductDetails

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://www.computop-paygate.com/schemas/productDetails.json",
    "title": "Product Details",
    "description": "Product Details Data",
    "type": "object",
    "properties": {
        "category1": {
            "type": ["string", "null"],
            "maxLength": 30
        },
		"category2": {
            "type": ["string", "null"],
            "maxLength": 30
        },
		"category3": {
            "type": ["string", "null"],
            "maxLength": 30
        }
    },
    "additionalProperties": false
}

AdditionalField

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

Key

Format

CND

Description

Beschreibung

Index

integer

M

Field Index

Value

ans..10

M

Field Value

ValueType

ans..1

M

Type of the field

Possible values "N" (numeric), "T" (text)

Type of the field

Possible values "N" (numeric), "T" (text)

Schema of AdditionalFields

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://www.computop-paygate.com/schemas/additionalFields.json",
    "title": "Product Details",
    "description": "Additional Fields Data",
    "type": "array",
    "maxItems": 20,
    "items": [{
        "index": {
            "type": ["integer", "null"]
        },
		"value": {
            "type": ["string", "null"],
            "maxLength": 10
        },
		"fieldType": {
            "type": ["string", "null"],
            "maxLength": 1
        }
    }],
    "additionalProperties": false
}

Request example

Raw request

merchantid=BNP_DEMO_AXEPTA&RefNr=xyz512&Date=17/04/2023&ActivationDelay=2&MerchantIDExt=38&PayType=7377&Currency=EUR&Language=fr-FR&CustomerID=340&LastName=Doe&FirstName=John&Salutation=Mr&MaidenName=Johns&DateOfBirth=1991-10-22&PlaceOfBirth=96050&MobileNr=0123456789&Email=test@it.floa.fr&AddrStreet=Rosental 1&AddrStreet2=Alexander Platz&AddrZIP=75008&AddrCity=Paris&AddrCountryCode=FR&PersonID=40919740A&Channel=DESKTOP&DeliveryChannel=STD&NumberArticles=3&Amount=55000&Fee=550&Discount=300&shAmount=400&sdStreet=Heiligstrasse 9&sdStreet2=Willy Brandt Platz&sdCity=Paris&sdZip=75008&sdCountryCode=FR&CustomerHistory=eyJmaXJzdE9yZGVyRGF0ZSI6IjExLzEwLzIwMjAiLCJsYXN0T3JkZXJEYXRlIjoiMTUvMDcvMjAyMSIsImNhbmNlbGVkT3JkZXJBbW91bnQiOjAsImNhbmNlbGVkT3JkZXJDb3VudCI6MCwiZnJhdWRBbGVydENvdW50IjowLCJwYXltZW50SW5jaWRlbnRDb3VudCI6NSwicmVmdXNlZE1hbnlUaW1lc09yZGVyQ291bnQiOjAsInVudmFsaWRhdGVkT3JkZXJDb3VudCI6MCwidmFsaWRhdGVkT25lVGltZU9yZGVyQ291bnQiOjAsInZhbGlkYXRlZE9yZGVyQ291bnQiOjEsImNsaWVudElwQWRkcmVzc1JlY3VycmVuY2UiOjMsIm9uZ29pbmdMaXRpZ2F0aW9uT3JkZXJBbW91bnQiOjAsInBhaWRMaXRpZ2F0aW9uT3JkZXJBbW91bnQyNE1vbnRoIjowLCJzY29yZVNpbXVsYXRpb25Db3VudDdEYXlzIjowfQ==&TravelDetails=eyJkZXBhcnR1cmVEYXRlIjpudWxsLCJyZXR1cm5EYXRlIjpudWxsLCJkZXN0aW5hdGlvbkNvdW50cnkiOiJTUCIsInRpY2tldENvdW50IjoyLCJ0cmF2ZWxsZXJDb3VudCI6MiwidHJhdmVsQ2xhc3MiOiJFY29ub215Iiwib3duVGlja2V0IjoxLCJtYWluRGVwYXJ0dXJlQ29tcGFueSI6IkVSRyIsImRlcGFydHVyZUFpcnBvcnQiOiJGUkEiLCJhcnJpdmFsQWlycG9ydCI6IkJBUiIsImRpc2NvdW50Q29kZSI6IjEyMzQ1NiIsImx1Z2dhZ2VTdXBwbGVtZW50Ijoibm9pZGVhIix0cmF2ZWxsZXJQYXNzcG9ydExpc3Q6W3siZXhwaXJhdGlvbkRhdGUiOiIxMi8wNS8yMDI5IiwiaXNzdWFuY2VDb3VudHJ5IjoiRlIifSx7ImV4cGlyYXRpb25EYXRlIjoiMTUvMDgvMjAyOSIsImlzc3VhbmNlQ291bnRyeSI6IkRFIn1dfQ==&StayDetails=eyJjb21wYW55IjoiQk5CIiwiZGVzdGluYXRpb24iOiJCYXJjZWxvbmEiLCJuaWdodE51bWJlciI6MTAsInJvb21SYW5nZSI6MX0=&ProductDetails=eyJjYXRlZ29yaWUxIjoicHJlbWl1bSIsImNhdGVnb3JpZTIiOiJwcmVtaXVtIiwiY2F0ZWdvcmllMyI6InByZW1pdW0ifQ==&AdditionalFields=eyJhZGRpdGlvbmFsRmllbGRzIjpbeyJpbmRleCI6IjEiLCJ2YWx1ZSI6IjgiLCJmaWVsZFR5cGUiOiJOIn0seyJpbmRleCI6IjIiLCJ2YWx1ZSI6IjciLCJmaWVsZFR5cGUiOiJOIn0seyJpbmRleCI6IjMiLCJ2YWx1ZSI6IjYiLCJmaWVsZFR5cGUiOiJOIn0seyJpbmRleCI6IjEiLCJ2YWx1ZSI6IjIwMjItMDgtMTEiLCJmaWVsZFR5cGUiOiJUIn0seyJpbmRleCI6IjIiLCJ2YWx1ZSI6InByaXZhdGUgdmVoaWNsZSIsImZpZWxkVHlwZSI6IlQifSx7ImluZGV4IjoiMyIsInZhbHVlIjoiTWVyY2VkZXMiLCJmaWVsZFR5cGUiOiJUIn1dfQ==&Homepage=https://computop.com/uk/&URLBack=https://computop.com/de/&URLSuccess=https://floapay.readme.io/reference/pr%C3%A9sentation&URLFailure=https://floapay.readme.io/reference/v1stored-payment-methodspost

CustomerHistory decoded from base64

{"firstOrderDate":"11/10/2020","lastOrderDate":"15/07/2021","canceledOrderAmount":0,"canceledOrderCount":0,"fraudAlertCount":0,"paymentIncidentCount":5,"refusedManyTimesOrderCount":0,"unvalidatedOrderCount":0,"validatedOneTimeOrderCount":0,"validatedOrderCount":1,"clientIpAddressRecurrence":3,"ongoingLitigationOrderAmount":0,"paidLitigationOrderAmount24Month":0,"scoreSimulationCount7Days":0}

TravelDetails decoded from base64

{"departureDate":null,"returnDate":null,"destinationCountry":"SP","ticketCount":2,"travellerCount":2,"travelClass":"Economy","ownTicket":1,"mainDepartureCompany":"ERG","departureAirport":"FRA","arrivalAirport":"BAR","discountCode":"123456","luggageSupplement":"noidea",travellerPassportList:[{"expirationDate":"12/05/2029","issuanceCountry":"FR"},{"expirationDate":"15/08/2029","issuanceCountry":"DE"}]}

StayDetails decoded from base64

{"company":"BNB","destination":"Barcelona","nightNumber":10,"roomRange":1}

ProductDetails decoded from base64

{"categorie1":"premium","categorie2":"premium","categorie3":"premium"}

AdditionalFields decoded from base64

{"additionalFields":[{"index":"1","value":"8","fieldType":"N"},{"index":"2","value":"7","fieldType":"N"},{"index":"3","value":"6","fieldType":"N"},{"index":"1","value":"2022-08-11","fieldType":"T"},{"index":"2","value":"private vehicle","fieldType":"T"},{"index":"3","value":"Mercedes","fieldType":"T"}]}

Page tree

About FLOA Pay

General information about FLOA Pay

Process flow chart

interface

Authorization

Capture

Credit with reference

Reverse

JSON Objects

CustomerHistory

Schema of CustomerHistory

TravelDetails

TravellerPassport

Schema of TravelDetails

StayDetails

Schema of StayDetails

ProductDetails

Schema of ProductDetails

AdditionalField

Schema of AdditionalFields

Request example

Raw request

CustomerHistory decoded from base64

TravelDetails decoded from base64

StayDetails decoded from base64

ProductDetails decoded from base64

AdditionalFields decoded from base64

Help

Intranet Tools

Page tree

FLOA - Integration

About FLOA Pay

General information about FLOA Pay

Process flow chart

interface

Authorization

Capture

Credit with reference

Reverse

JSON Objects

CustomerHistory

Schema of CustomerHistory

TravelDetails

TravellerPassport

Schema of TravelDetails

StayDetails

Schema of StayDetails

ProductDetails

Schema of ProductDetails

AdditionalField

Schema of AdditionalFields

Request example

Raw request

CustomerHistory decoded from base64

TravelDetails decoded from base64

StayDetails decoded from base64

ProductDetails decoded from base64

AdditionalFields decoded from base64