Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation
Table of Contents


About FLOA Pay

General information about FLOA Pay


Page properties
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.

TypePayments by Invoice and Installments


Further information can be found on the webpage of FLOA Pay (https://www.floapay.com/).


Process flow chart

Multiexcerpt
MultiExcerptNameProcessFlow

draw.io Diagram
bordertrue
diagramNameFloapay_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

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.


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


Authorization

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
floapay.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666781777415_1407054310
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamefloapay_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666781777417_-1770395786
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNran..30O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency_EUR
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameURLSuccess
pageURLSuccess
typepage

Table Excerpt Include
statictrue
nameURLFailure
pageURLFailure
typepage

Table Excerpt Include
statictrue
nameResponse
pageResponse
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Key

Format

CND

Description

Beschreibung

EventTokenans..5O

In case the parameter is not sent, this is common authorization request

In case EventToken=SCHEDULE, the request returns estimated schedule based on Amount.


Languageans..5O

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
MerchantIDExtn..10OMerchantID provided by FLOA PayVon FLOA Pay bereitgestellte MerchantID
PayTypen..10OMerchantSiteID provided by FLOA PayVon FLOA Pay bereitgestellte MerchantSiteID
CustomerIDans..30C

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
FirstNameans..64C

First name of the buyer

Mandatory in case parameter EventToken is not sent.

Vorname des Käufers
LastNameans..64C

Last name of the buyer

Mandatory in case parameter EventToken is not sent.

Nachname des Käufers
MaidenNameans..64OBirth nameGeburtsname
Salutationans..3OSalutationAnrede
DateOfBirthdttmO

Date of birth of the buyer.

Format: YYYY-MM-DD

Geburtsdatum des Käufers.

Format: JJJJ-MM-TT

PlaceOfBirthans..6O

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"
MobileNrans..15C

Home or cell phone number

Mandatory in case parameter EventToken is not sent.

Privat- oder Handynummer
Emailans..60C

Email address of the buyer

Mandatory in case parameter EventToken is not sent.

E-Mail-Adresse des Käufers
AddrStreetans..32O

The main address

Die Hauptadresse
AddrStreet2ans..32OAdditional address 1 (building, apartment, door code)Zusatzadresse 1 (Gebäude, Wohnung, Türcode)
AddrZIPans..10O

Zip code

Postleitzahl
AddrCityans..50O

City

Ort
AddrCountryCodeans..2C

Country code 2 digits according to ISO 3166-2

Mandatory in case parameter EventToken is not sent.

Ländercode zweistellig gemäß ISO 3166-2
PersonIDans..8C

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"

Dateans..10C

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

Channelans..18C

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
DeliveryChannelans..3C

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..3C

Number of articles in the order

Mandatory in case parameter EventToken is not sent.

Anzahl der Artikel in der Bestellung
ActivationDelayn..3COnly for 1XD: Number of days of deferralNur für 1XD: Anzahl Tage der Zurückstellung
Homepageans..256C

URL of the homepage of the merchant site

Mandatory in case parameter EventToken is not sent.

URL der Homepage der Händlerseite
URLBackans..256C

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..10OTotal amount of fees associated with the order (in cents)Gesamtbetrag der mit der Bestellung verbundenen Gebühren (in Cent)
Discountn..10OTotal amount of discounts associated with the order (in cents)Gesamtbetrag der mit der Bestellung verbundenen Rabatte (in Cent)
shAmountn..10OTotal amount of delivery costs for the order (in cents)Gesamtbetrag der Versandkosten für die Bestellung (in Cent)
sdStreet ans..32OShipping address line 1Lieferadresse Zeile 1
sdStreet2ans..32OShipping address line 2
Lieferadresse Zeile 2
sdZIPans..10OShipping postal codePostleitzahl der Lieferadresse
sdCity
ans..50OShipping cityOrt der Lieferadresse
sdCountryCodeans..2OAlpha-2 ISO country code (e.g. FR)Alpha-2 ISO-Ländercode (z. B. FR)
CustomerHistoryans..1024O

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
TravelDetailsans..1024O

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
StayDetailsans..1024O

Stay details information as JSON string in Base64 format. See JSON object: StayDetails

Aufenthaltsdetails als JSON-String im Base64-Format. Siehe JSON-Objekt: StayDetails
ProductDetailsans..1024O

Product details information as JSON string in Base64 format. See JSON object: ProductDetails

Produktdetails als JSON-String im Base64-Format. Siehe JSON-Objekt: ProductDetails
AdditionalFieldsans..1024OArray 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


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_IntroURL
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666780758609_-316588793
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamefloapay_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666780758613_-1275318645
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Key

Format

CND

Description

Beschreibung

Statusa..50M

AUTHORIZE_REQUEST (URLSuccess) or FAILED (URLFailure)

AUTHORIZE_REQUEST (URLSuccess) oder FAILED (URLFailure)

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

CodeExtn..10O

Error code from FLOA Pay, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlercode von FLOA Pay, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

ErrorTextans..256O

Error text from FLOA Pay, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlertext von FLOA Pay, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

PaymentDetailsans..512O

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
capture.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666777345400_915448842
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecapture_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666777345402_1952342907
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID_Capture
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency_EUR
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Parameters for captures with FLOA Pay


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666777511762_946657676
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecapture_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666777511764_-1208372581
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

CodeExtn..10O

Error code from FLOA Pay, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlercode von FLOA Pay, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

ErrorTextans..256O

Error text from FLOA Pay, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlertext von FLOA Pay, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
credit.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666777903230_1407054310
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666777903233_-1770395786
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID_Credit
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency_EUR
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Parameters for credits of payments with FLOA Pay


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666778025531_-316588793
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666778025534_-1275318645
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

CodeExtn..10O

Error code from FLOA Pay, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlercode von FLOA Pay, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

ErrorTextans..256O

Error text from FLOA Pay, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlertext von FLOA Pay, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
reverse.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666778358032_826325130
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamereverse_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666778358035_-1300347052
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID_Reverse
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency_EUR
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Parameters for reversals of payments with FLOA Pay


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666780263213_-742316566
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamereverse_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666780263216_1668014632
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

CodeExtn..10O

Error code from FLOA Pay, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlercode von FLOA Pay, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

ErrorTextans..256O

Error text from FLOA Pay, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlertext von FLOA Pay, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
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:

 

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

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666775859953_1738222453
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameJSON_CustomerHistory
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666775859957_584535769
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

Format

CND

Description

Beschreibung
CanceledOrderAmountn..10OTotal amount in cents of orders cancelled in the last 2 yearsGesamtbetrag in Cent der in den letzten 2 Jahren stornierten Bestellungen
CanceledOrderCountn..3ONumber of orders placed and cancelled by the customer in the last 2 yearsAnzahl der vom Kunden in den letzten 2 Jahren aufgegebenen und stornierten Bestellungen
FirstOrderDateans..10ODate of first customer order in format DD/MM/YYYYDatum der ersten Kundenbestellung im Format TT/MM/JJJJ
FraudAlertCountn..3ONumber of fraud alerts regarding customer orders in the last 2 yearsAnzahl der Betrugsmeldungen bezüglich Kundenbestellungen in den letzten 2 Jahren
LastOrderDateans..10ODate of last customer order in format DD/MM/YYYYDatum der letzten Kundenbestellung im Format TT/MM/JJJJ
PaymentIncidentCountn..3ONumber of payment incidents involving customer orders in the last 2 yearsAnzahl der Zahlungsvorfälle im Zusammenhang mit Kundenbestellungen in den letzten 2 Jahren
RefusedManyTimesOrderCountn..3ONumber of orders whose payment in instalments has been refused in the last 2 yearsAnzahl der Bestellungen, deren Ratenzahlung in den letzten 2 Jahren abgelehnt wurde
UnvalidatedOrderCountn..3ONumber of orders refused in the validation phase in the last 2 yearsAnzahl der in der Validierungsphase abgelehnten Bestellungen in den letzten 2 Jahren
ValidatedOneTimeOrderCountn..3ONumber of orders paid in 1 installment in the last 2 yearsAnzahl der Bestellungen, die in den letzten 2 Jahren in 1 Rate bezahlt wurden
ValidatedOrderCountn..3ONumber of orders validated in the last 2 yearsAnzahl der in den letzten 2 Jahren validierten Bestellungen
ClientIpAddressRecurrencen..3OCustomer IP address recurrence in the last 2 yearsWiederholung der Kunden-IP-Adresse in den letzten 2 Jahren
OngoingLitigationOrderAmountn..10OCurrent amounts in dispute not settledLaufende noch nicht beigelegte Streitwerte
PaidLitigationOrderAmount24Monthn..10OAmount of litigation settled in the last 2 yearsBetrag der in den letzten 2 Jahren beigelegten Rechtsstreitigkeiten
ScoreSimulationCount7Daysn..3ONumber of simulated scores in the last 7 daysAnzahl der simulierten Scores in den letzten 7 Tagen

Schema of CustomerHistory

Multiexcerpt
MultiExcerptNameJSON_CustomerHistory_schema
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagejson
{
	"$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

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666774286711_1738222453
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameJSON_TravelDetails
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666774286714_584535769
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

Format

CND

Description

Beschreibung
Insuranceans..30O

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.

Traveltypeans..30O

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

DepartureDateans..16CMandatory 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

ReturnDateans..30CMandatory 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

DestinationCountryans..2CMandatory 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

TicketCountn..3ONumber of ticketsAnzahl der Tickets
TravellerCountn..3CMandatory for tour operators, Optional for all others: Number of passengers
Pflicht für Reiseveranstalter, optional für alle anderen: Anzahl der Passagiere
travelClassans..16O

Type of class chosen:

- Unknown
- Economy
- PremiumEconomy
- Business
- First

- Others

Art der gewählten Klasse:

- unbekannt
- Economy
- PremiumEconomy
- Business
- First
- andere

OwnTicketn1O

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

MainDepartureCompanyans..3OAirline Company One Way Flight

One-Way-Flug der Fluggesellschaft

TravellerPassportListArrayO

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)

DepartureAirportans..3OIATA code of the airport of departure

IATA-Code des Abflughafens

ArrivalAirportans..3OIATA code of the arrival airport

IATA-Code des Ankunftsflughafens

DiscountCodeans..30ODiscount code

Rabattcode

LuggageSupplementans..30OLuggage supplement

Gepäckzuschlag

ModificationCancellationn1O

Modification-cancellation.
1 = true

0 = false
Änderungsstornierung.
1 = wahr
0 = falsch

TravellerPassport

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666774141797_-1304172806
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameJSON_TravellerPassport
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666774141800_1498773639
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

Format

CND

Description

Beschreibung
ExpirationDateans..10OPassport expiration date in format DD/MM/YYYY

Ablaufdatum des Reisepasses im Format TT/MM/JJJJ

IssuanceCountryans..2OAlpha-2 ISO code of the country of issue of the passportAlpha-2-ISO-Code des Ausstellungslandes des Reisepasses

Schema of TravelDetails

Multiexcerpt
MultiExcerptNameJSON_TravelDetails_schema
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagejson
{
    "$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

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666773515033_-1401674625
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameJSON_StayDetails
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666773515036_-1090724471
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

Format

CND

Description

Beschreibung
Companyans..50OShipowner/Operator/Hotel chainReeder/Betreiber/Hotelkette
Destinationans..50ODestination cityZielstadt
NightNumbern..3ONumber of overnight staysAnzahl der Übernachtungen
RoomRangen..3ORoom rangeZimmerbereich

Schema of StayDetails

Multiexcerpt
MultiExcerptNameJSON_StayDetails_schema
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagejson
{
    "$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

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1666773252998_-326155484
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameJSON_ProductDetails
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1666773253001_28781958
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

Format

CND

Description

Beschreibung
Category1ans..30OProduct category number 1Produktkategorienummer 1
Category2ans..30OProduct category number 2
Produktkategorienummer 2
Category3ans..30OProduct category number 3
Produktkategorienummer 3

Schema of ProductDetails

Multiexcerpt
MultiExcerptNameJSON_ProductDetails_schema
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagejson
{
    "$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

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1684940211595_-396202053
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameJSON_AdditionalFields
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1684940211597_-701795826
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

Format

CND

Description

Beschreibung
IndexintegerMField Index
Field Index
Valueans..10MField Value
Field Value
ValueTypeans..1M

Type of the field

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

Type of the field

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

Schema of AdditionalFields

Multiexcerpt
MultiExcerptNameJSON_AdditionalFields_schema
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagejson
{
    "$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"}]}