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

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

Comment

CND

condition

M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

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.

Common notes:

• We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate

• 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.

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.

Common notes:

• We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate

• 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.

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 UserDataparameter instead.

Common notes:

• Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.

• 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.

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 or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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

MerchantIDExt

n..10

O

MerchantID provided by FLOA Pay

PayType

n..10

O

MerchantSiteID provided by FLOA Pay

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.

FirstName

ans..64

C

First name of the buyer.

Mandatory in case parameter EventToken is not sent.

LastName

ans..64

C

Last name of the buyer.

Mandatory in case parameter EventToken is not sent.

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.

• 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"

MobileNr

ans..15

C

Home or cell phone number.

Mandatory in case parameter EventToken is not sent.

Email

ans..60

C

Email address of the buyer.

Mandatory in case parameter EventToken is not sent.

AddrStreet

ans..32

O

The main address

AddrStreet2

ans..32

O

Additional address 1 (building, apartment, door code)

AddrZIP

ans..10

O

Zip code

AddrCity

ans..50

O

City

AddrCountryCode

ans..2

C

Country code 2 digits according to ISO 3166-2.

Mandatory in case parameter EventToken is not sent.

PersonID

ans..8

C

Tax identification number, mandatory for customer in Spain and Italy.

Mandatory if Country="ES" or Country="IT"

Date

ans..10

C

Date of purchase of the order.

Format: DD/MM/YYYY

Mandatory in case parameter EventToken is not sent.

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.

DeliveryChannel

ans..3

C

Merchant delivery method. "STD" is default value.

Mandatory in case parameter EventToken is not sent.

NumberArticles

ans..3

C

Number of articles in the order.

Mandatory in case parameter EventToken is not sent.

ActivationDelay

n..3

C

Only for 1XD: Number of days of deferral

Homepage

ans..256

C

URL of the homepage of the merchant site.

Mandatory in case parameter EventToken is not sent.

URLBack

ans..256

C

URL back to the previous page of the merchant site.

Mandatory in case parameter EventToken is not sent.

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)

shAmount

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..10

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

AdditionalFields

ans..1024

O

Array of AdditionalFields JSON object as string in Base64 format.

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 as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

AUTHORIZE_REQUEST (URLSuccess) or FAILED (URLFailure)

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!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

CodeExt

n..10

O

Error code from FLOA Pay, if agreed with Computop Helpdesk

ErrorText

ans..256

O

Error text from FLOA Pay, if agreed with Computop Helpdesk

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.

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 captured

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

refnr

ans..30

O

Merchant’s unique reference number

ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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 as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

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!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

CodeExt

n..10

O

Error code from FLOA Pay, if agreed with Computop Helpdesk

ErrorText

ans..256

O

Error text from FLOA Pay, if agreed with Computop Helpdesk

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 credited

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

refnr

ans..30

O

Merchant’s unique reference number

ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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 as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

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!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

CodeExt

n..10

O

Error code from FLOA Pay, if agreed with Computop Helpdesk

ErrorText

ans..256

O

Error text from FLOA Pay, if agreed with Computop Helpdesk

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

TransactionID provided by you which should be unique for each payment

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

refnr

ans..30

O

Merchant’s unique reference number

ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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 as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

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!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

CodeExt

n..10

O

Error code from FLOA Pay, if agreed with Computop Helpdesk

ErrorText

ans..256

O

Error text from FLOA Pay, if agreed with Computop Helpdesk

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

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

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 in format: DD/MM/YYYY HH:MM

ReturnDate

ans..30

C

Mandatory for tour operators, Optional for all others: Return date in 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

- Economy

- PremiumEconomy

- Business

- First

- Others

OwnTicket

n1

O

Indicator to identify whether the holder of the credit card used to fund the trip is participating:

1 = true

0 = false

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

n1

O

Modification-cancellation.

1 = true

0 = false

ExpirationDate

ans..10

O

Passport expiration date in format DD/MM/YYYY

IssuanceCountry

ans..2

O

Alpha-2 ISO code of the country of issue of the passport

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

Category1

ans..30

O

Product category number 1

Category2

ans..30

O

Product category number 2

Category3

ans..30

O

Product category number 3

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)