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.

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


Paygate interface

Definitions

Data formats

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)


Abbreviations

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


Notice: Please note that the names of parameters can be returned in upper or lower case.


Authorization

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

https://www.computop-paygate.com/floapay.aspx


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

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

(info) 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. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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

(info) 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.

KeyFormatCNDDescription
Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

KeyFormatCNDDescription
URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.

(info) 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.

KeyFormatCNDDescription
UserData

ans..1024

O

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

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

Key

Format

CND

Description

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

The unique identifier of the customer inside the information system of the merchant.

Mandatory in case parameter EventToken is not sent.

FirstNameans..64C

First name of the buyer.

Mandatory in case parameter EventToken is not sent.

LastNameans..64C

Last name of the buyer.

Mandatory in case parameter EventToken is not sent.

MaidenNameans..64OBirth name
Salutationans..3OSalutation
DateOfBirthdttmO

Date of birth of the buyer.

Format: YYYY-MM-DD

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

Home or cell phone number.

Mandatory in case parameter EventToken is not sent.

Emailans..60C

Email address of the buyer.

Mandatory in case parameter EventToken is not sent.

AddrStreetans..32O

The main address

AddrStreet2ans..32OAdditional address 1 (building, apartment, door code)
AddrZIPans..10O

Zip code

AddrCityans..50O

City

AddrCountryCodeans..2C

Country code 2 digits according to ISO 3166-2.

Mandatory in case parameter EventToken is not sent.

PersonIDans..8C

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

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

Dateans..10C

Date of purchase of the order.

Format: DD/MM/YYYY

Mandatory in case parameter EventToken is not sent.

Channelans..18C

Sales channel.

Possible values:

  • DESKTOP
  • TABLET
  • TABLET_IPAD
  • SMARTPHONE
  • SMARTPHONE_ANDROID
  • SMARTPHONE_IPHONE

Mandatory in case parameter EventToken is not sent.

DeliveryChannelans..3C

Merchant delivery method. "STD" is default value.

Mandatory in case parameter EventToken is not sent.

NumberArticles ans..3C

Number of articles in the order.

Mandatory in case parameter EventToken is not sent.

ActivationDelayn..3COnly for 1XD: Number of days of deferral
Homepageans..256C

URL of the homepage of the merchant site.

Mandatory in case parameter EventToken is not sent.

URLBackans..256C

URL back to the previous page of the merchant site.

Mandatory in case parameter EventToken is not sent.

Fee n..10OTotal amount of fees associated with the order (in cents)
Discountn..10OTotal amount of discounts associated with the order (in cents)
shAmountn..10OTotal amount of delivery costs for the order (in cents)
sdStreet ans..32OShipping address line 1
sdStreet2ans..32OShipping address line 2
sdZIPans..10OShipping postal code
sdCity
ans..50OShipping city
sdCountryCodeans..2OAlpha-2 ISO country code (e.g. FR)
CustomerHistoryans..1024O

Customer history information as JSON string in Base64 format. See JSON object: CustomerHistory

TravelDetailsans..1024O

Travel details information (including passport data) as JSON string in Base64 format. See JSON object: TravelDetails

StayDetailsans..1024O

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

ProductDetailsans..1024O

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

AdditionalFieldsans..1024OArray of AdditionalFields JSON object as string in Base64 format.

Parameter for installments with FLOA Pay


The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive


KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

Key

Format

CND

Description

Statusa..50M

AUTHORIZE_REQUEST (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

CodeExtn..10O

Error code from FLOA Pay, if agreed with Computop Helpdesk

ErrorTextans..256O

Error text from FLOA Pay, if agreed with Computop Helpdesk

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:

https://www.computop-paygate.com/capture.aspx


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be captured

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

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

Parameters for captures with FLOA Pay


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

CodeExtn..10O

Error code from FLOA Pay, if agreed with Computop Helpdesk

ErrorTextans..256O

Error text from FLOA Pay, if agreed with Computop Helpdesk

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:

https://www.computop-paygate.com/credit.aspx

 

Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be credited

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

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

Parameters for credits of payments with FLOA Pay


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

CodeExtn..10O

Error code from FLOA Pay, if agreed with Computop Helpdesk

ErrorTextans..256O

Error text from FLOA Pay, if agreed with Computop Helpdesk

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:

https://www.computop-paygate.com/reverse.aspx

 

Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be reversed

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

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

Parameters for reversals of payments with FLOA Pay


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

CodeExtn..10O

Error code from FLOA Pay, if agreed with Computop Helpdesk

ErrorTextans..256O

Error text from FLOA Pay, if agreed with Computop Helpdesk

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

Key

Format

CND

Description

CanceledOrderAmountn..10OTotal amount in cents of orders cancelled in the last 2 years
CanceledOrderCountn..3ONumber of orders placed and cancelled by the customer in the last 2 years
FirstOrderDateans..10ODate of first customer order in format DD/MM/YYYY
FraudAlertCountn..3ONumber of fraud alerts regarding customer orders in the last 2 years
LastOrderDateans..10ODate of last customer order in format DD/MM/YYYY
PaymentIncidentCountn..3ONumber of payment incidents involving customer orders in the last 2 years
RefusedManyTimesOrderCountn..3ONumber of orders whose payment in instalments has been refused in the last 2 years
UnvalidatedOrderCountn..3ONumber of orders refused in the validation phase in the last 2 years
ValidatedOneTimeOrderCountn..3ONumber of orders paid in 1 installment in the last 2 years
ValidatedOrderCountn..3ONumber of orders validated in the last 2 years
ClientIpAddressRecurrencen..3OCustomer IP address recurrence in the last 2 years
OngoingLitigationOrderAmountn..10OCurrent amounts in dispute not settled
PaidLitigationOrderAmount24Monthn..10OAmount of litigation settled in the last 2 years
ScoreSimulationCount7Daysn..3ONumber of simulated scores in the last 7 days

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

Key

Format

CND

Description

Insuranceans..30O

Type of supplementary insurance chosen by the customer.

Depends on the merchant.

Traveltypeans..30O

Type of flights:

- Unknown: Unknown
- OneWay: One way
- TwoWay: Round trip
- Multiple: Multi-destination
DepartureDateans..16CMandatory for tour operators, Optional for all others: Start date in format: DD/MM/YYYY HH:MM
ReturnDateans..30CMandatory for tour operators, Optional for all others: Return date in format: DD/MM/YYYY HH:MM
DestinationCountryans..2CMandatory for tour operators, Optional for all others: Alpha-2 ISO code of the destination country
TicketCountn..3ONumber of tickets
TravellerCountn..3CMandatory for tour operators, Optional for all others: Number of passengers
travelClassans..16O

Type of class chosen:

- Unknown
- Economy
- PremiumEconomy
- Business
- First

- Others
OwnTicketn1O

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

0 = false
MainDepartureCompanyans..3OAirline Company One Way Flight
TravellerPassportListArrayO

Information concerning the passport(s) of the traveler(s)

Array of TravellerPassport (see JSON object: TravellerPassport)

DepartureAirportans..3OIATA code of the airport of departure
ArrivalAirportans..3OIATA code of the arrival airport
DiscountCodeans..30ODiscount code
LuggageSupplementans..30OLuggage supplement
ModificationCancellationn1O

Modification-cancellation.
1 = true

0 = false

TravellerPassport

Key

Format

CND

Description

ExpirationDateans..10OPassport expiration date in format DD/MM/YYYY
IssuanceCountryans..2OAlpha-2 ISO code of the country of issue of the passport

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

Key

Format

CND

Description

Companyans..50OShipowner/Operator/Hotel chain
Destinationans..50ODestination city
NightNumbern..3ONumber of overnight stays
RoomRangen..3ORoom range

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

Key

Format

CND

Description

Category1ans..30OProduct category number 1
Category2ans..30OProduct category number 2
Category3ans..30OProduct category number 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
}


AdditionalFields

Key

Format

CND

Description

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

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"}]}