Floa

Floa is a Buy Now Pay Later (BNPL) payment solution: customers can split the payment for their purchases into multiple installments.

FLOA is only available in France, Portugal, Italy, Spain, Belgium, and Germany.

How it works

Floa is a synchronous payment method — no redirect occurs. The customer fills in the required fields and submits the payment. Paybyrd processes the request and returns a success or failure response directly, without redirecting to an external page. If shopper information is provided in the order, the payment form fields are pre-filled, though the customer must still confirm and submit. We provide the following Floa payment methods:

Method	Code	Description
Payment in 3 times	`FLOA3X`	The customer pays in 3 installments, each 30 days apart.
Payment in 4 times	`FLOA4X`	The customer pays in 4 installments, each 30 days apart.
Deferred cash payment	`FLOA1XD`	The customer pays in a single deferred payment. In France, deferral can be between 1 and 30 days. In all other supported countries, deferral must be either 14 or 30 days.

Create order

The following example shows how to create an order and the response it generates:

Generic shopping cart

curl --request POST \
 --url https://gateway.paybyrd.com/api/v2/orders \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --header 'x-api-key: {your_api_key}' \
 --data '
{
 "marketId": "PT",
 "isoAmount": 5000,
 "orderRef": "New Order",
 "currency": "EUR",
 "orderOptions": {
   "culture": "en-US"
 },
 "shopper": {
   "email": "peter@parker.com",
   "firstName": "Peter",
   "lastName": "Parker",
   "phoneCountryCode": 351,
   "phoneNumber": "999999999",
   "homeAddress": "Rua Rodrigo da Fonseca, 15 - 3H",
   "homePostalCode": "1250189",
   "homeCity": "Lisbon",
   "homeCountry": "PRT",
   "ipAddress": "192.168.0.1",
   "firstPurchaseDate": "2023-12-19T19:30:00Z",
   "lastPurchaseDate": "2023-12-19T19:30:00Z",
   "shippingAddress": "Av. Guerra Junqueiro 2A",
   "shippingPostalCode": "1000167",
   "shippingCity": "Lisbon",
   "shippingState": "LB",
   "shippingCountry": "PRT",
   "customReference": "spiderman"
 },
 "shoppingCart": {
   "items": [
     {
       "description": "Web launcher",
       "amount": 5000,
       "categories": [
         "Category 2",
         "Category 1"
       ],
       "shipping": {
         "shippingMethod": "STD"
       },
       "type": "Product"
     }
   ]
 },
 "paymentOptions": {
   "allowedPaymentMethods": [
     "FLOA3X",
     "FLOA4X",
     "FLOA1XD"
   ]
 }
}'

{
    "orderDate": "2024-05-06T18:03:45Z",
    "status": "created",
    "checkoutUrl": "https://link-s.paybyrd.com/chk_KydBswaR5",
    "tags": 0,
    "index": 1,
    "transactions": [],
    "orderId": "4d438d44-5609-4aic-ac5d-a948c7e39455",
    "amount": "5000",
    "currency": "EUR",
    "orderRef": "New Order",
    "shopper": {
        "customReference": "spiderman",
        "shopperId": "ecbd5431-af46-4c3e-9e0c-0117671fd907",
        "email": "peter.parker@spidermail.com",
        "firstName": "Peter",
        "lastName": "Parker",
        "phoneCountryCode": 351,
        "phoneNumber": "999999999",
        "shippingAddress": "Av. Guerra Junqueiro 2A",
        "shippingPostalCode": "1000167",
        "shippingCity": "Lisbon",
        "shippingState": "LB",
        "shippingCountry": "PRT",
        "homeAddress": "Rua Rodrigo da Fonseca, 15 - 3H",
        "homePostalCode": "1250189",
        "homeCity": "Lisbon",
        "homeCountry": "PRT",
        "shippingType": "Undefined",
        "firstPurchaseDate": "2023-12-19T19:30:00+00:00",
        "lastPurchaseDate": "2023-12-19T19:30:00+00:00"
    },
    "orderOptions": {
        "redirectUrl": "https://paybyrd.com/",
        "culture": "en-US",
        "sendBy": []
    },
    "paymentOptions": {
        "useSimulated": true,
        "cardOptions": {
            "isPreAuth": false,
            "isDccEnabled": false
        },
        "tokenOptions": {
            "tokenizationMethod": "none"
        },
        "allowedPaymentMethods": [
            "FLOA3X",
            "FLOA4X",
            "FLOA1XD"
        ]
    },
    "terminalOptions": {
        "notifyChanges": false
    },
    "shoppingCart": {
        "items": [
            {
                "amount": 5000,
                "categories": [
                    "Category 2",
                    "Category 1"
                ],
                "description": "Web launcher",
                "shipping": {
                    "shippingMethod": "STD"
                },
                "type": "Product"
            }
        ]
    },
    "marketId": "PT",
    "code": "BYRD200",
    "description": "Operation successfully completed",
    "checkoutKey": "eyJPcmRlcklkIjoiNGQ0MzhkNDQtNTYwOS00YWRjLWFjNWQtYTk0OGM3ZTM5NDU1IiwiT3JkZXJSZWYiOiJOZXcgT3JkZXIiLCJQZXJzb25JZCI6MzMwOCwiTGl2ZSI6ZmFsc2UsIkVudGl0eUlkIjoiNGQ0MzhkNDQtNTYwOS00YWRjLWFjNWQtYTk0OGM3ZTM5NDU1IiwiQW1vdW50IjoiMjUwMC4wMCIsIkN1cnJlbmN5IjoiRVVSIn0="
}

Airline shopping cart

For an airline shopping cart, you must set the item type to Travel and the category to AIRLINE TICKET.

curl --request POST \
  --url https://gateway.paybyrd.com/api/v2/orders \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: {your_api_key}' \
  --data '
{
    "marketId": "PT",
    "isoAmount": 100000,
    "orderRef": "New Order",
    "currency": "EUR",
    "orderOptions": {
        "culture": "en-US"
    },
    "shopper": {
        "email": "peter.parker@spidermail.com",
        "firstName": "Peter",
        "lastName": "Parker",
        "phoneCountryCode": 351,
        "phoneNumber": "999999999",
        "homeAddress": "Rua Rodrigo da Fonseca, 15 - 3H",
        "homePostalCode": "1250189",
        "homeCity": "Lisbon",
        "homeCountry": "PRT",
        "ipAddress": "192.168.0.1",
        "firstPurchaseDate": "2023-12-19T19:30:00Z",
        "lastPurchaseDate": "2023-12-19T19:30:00Z",
        "shippingAddress": "Av. Guerra Junqueiro 2A",
        "shippingPostalCode": "1000167",
        "shippingCity": "Lisbon",
        "shippingState": "LB",
        "shippingCountry": "PRT",
        "customReference": "spiderman"
    },
    "shoppingCart": {
        "items": [
            {
                "description": "Travel",
                "amount": 100000,
                "categories": [
                    "AIRLINE TICKET"
                ],
                "shipping": {
                    "shippingMethod": "VIR"
                },
                "type": "Travel",
                "hasInsurance": false,
                "travelType": "TwoWay",
                "departureDate": "2024-12-19T19:30:00Z",
                "returnDate": "2024-12-31T15:30:00Z",
                "departure": "GIG",
                "destination": "LIS",
                "destinationCountryCode": "PRT",
                "travelersCount": 1,
                "mainDepartureCompany": "LP"
            }
        ]
    },
    "paymentOptions": {
        "allowedPaymentMethods": [
            "FLOA3X",
            "FLOA4X",
            "FLOA1XD"
        ]
    }
}'

{
    "orderDate": "2024-05-06T18:03:45Z",
    "status": "created",
    "checkoutUrl": "https://link-s.paybyrd.com/chk_KydBswaR5",
    "tags": 0,
    "index": 1,
    "transactions": [],
    "orderId": "4d438d44-5609-4aic-ac5d-a948c7e39455",
    "amount": "100000",
    "currency": "EUR",
    "orderRef": "New Order",
    "shopper": {
        "customReference": "spiderman",
        "shopperId": "ecbd5431-af46-4c3e-9e0c-0117671fd907",
        "email": "peter.parker@spidermail.com",
        "firstName": "Peter",
        "lastName": "Parker",
        "phoneCountryCode": 351,
        "phoneNumber": "999999999",
        "shippingAddress": "Av. Guerra Junqueiro 2A",
        "shippingPostalCode": "1000167",
        "shippingCity": "Lisbon",
        "shippingState": "LB",
        "shippingCountry": "PRT",
        "homeAddress": "Rua Rodrigo da Fonseca, 15 - 3H",
        "homePostalCode": "1250189",
        "homeCity": "Lisbon",
        "homeCountry": "PRT",
        "shippingType": "Undefined",
        "firstPurchaseDate": "2023-12-19T19:30:00+00:00",
        "lastPurchaseDate": "2023-12-19T19:30:00+00:00"
    },
    "orderOptions": {
        "redirectUrl": "https://paybyrd.com/",
        "culture": "en-US",
        "sendBy": []
    },
    "paymentOptions": {
        "useSimulated": true,
        "cardOptions": {
            "isPreAuth": false,
            "isDccEnabled": false
        },
        "tokenOptions": {
            "tokenizationMethod": "none"
        },
        "allowedPaymentMethods": [
            "FLOA3X",
            "FLOA4X",
            "FLOA1XD"
        ]
    },
    "terminalOptions": {
        "notifyChanges": false
    },
    "shoppingCart": {
        "items": [
            {
                "description": "Travel",
                "amount": 100000,
                "categories": [
                    "AIRLINE TICKET"
                ],
                "shipping": {
                    "shippingMethod": "VIR"
                },
                "type": "Travel",
                "hasInsurance": false,
                "travelType": "TwoWay",
                "departureDate": "2024-12-19T19:30:00Z",
                "returnDate": "2024-12-31T15:30:00Z",
                "departure": "GIG",
                "destination": "LIS",
                "destinationCountryCode": "PRT",
                "travelersCount": 1,
                "mainDepartureCompany": "LP"
            }
        ]
    },
    "marketId": "PT",
    "code": "BYRD200",
    "description": "Operation successfully completed",
    "checkoutKey": "eyJPcmRlcklkIjoiNGQ0MzhkNDQtNTYwOS00YWRjLWFjNWQtYTk0OGM3ZTM5NDU1IiwiT3JkZXJSZWYiOiJOZXcgT3JkZXIiLCJQZXJzb25JZCI6MzMwOCwiTGl2ZSI6ZmFsc2UsIkVudGl0eUlkIjoiNGQ0MzhkNDQtNTYwOS00YWRjLWFjNWQtYTk0OGM3ZTM5NDU1IiwiQW1vdW50IjoiMjUwMC4wMCIsIkN1cnJlbmN5IjoiRVVSIn0="
}

Hotel shopping cart

For a hotel or stay shopping cart, you must set the item type to TravelWithStay and the category to HOTEL or STAY.

curl --request POST \
  --url https://gateway.paybyrd.com/api/v2/orders \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: {your_api_key}' \
  --data '
{
    "marketId": "PT",
    "isoAmount": 80000,
    "orderRef": "New Order",
    "currency": "EUR",
    "orderOptions": {
        "culture": "en-US"
    },
    "shopper": {
        "email": "peter.parker@spidermail.com",
        "firstName": "Peter",
        "lastName": "Parker",
        "phoneCountryCode": 351,
        "phoneNumber": "999999999",
        "homeAddress": "Rua Rodrigo da Fonseca, 15 - 3H",
        "homePostalCode": "1250189",
        "homeCity": "Lisbon",
        "homeCountry": "PRT",
        "ipAddress": "192.168.0.1",
        "firstPurchaseDate": "2023-12-19T19:30:00Z",
        "lastPurchaseDate": "2023-12-19T19:30:00Z",
        "shippingAddress": "Av. Guerra Junqueiro 2A",
        "shippingPostalCode": "1000167",
        "shippingCity": "Lisbon",
        "shippingState": "LB",
        "shippingCountry": "PRT",
        "customReference": "spiderman"
    },
    "shoppingCart": {
        "items": [
            {
                "description": "Stay",
                "amount": 80000,
                "categories": [
                    "HOTEL"
                ],
                "shipping": {
                    "shippingMethod": "VIR"
                },
                "CheckInDate": "2024-12-01",
                "CheckOutDate": "2024-12-07",
                "destinationCountryCode": "PRT",
                "guestsCount": 2,
                "type": "TravelWithStay",
                "roomRange": 4
            }
        ]
    },
    "paymentOptions": {
        "allowedPaymentMethods": [
            "FLOA3X",
            "FLOA4X",
            "FLOA1XD"
        ]
    }
}'

{
    "orderDate": "2024-05-06T18:03:45Z",
    "status": "created",
    "checkoutUrl": "https://link-s.paybyrd.com/chk_KydBswaR5",
    "tags": 0,
    "index": 1,
    "transactions": [],
    "orderId": "4d438d44-5609-4aic-ac5d-a948c7e39455",
    "amount": "80000",
    "currency": "EUR",
    "orderRef": "New Order",
    "shopper": {
        "customReference": "spiderman",
        "shopperId": "ecbd5431-af46-4c3e-9e0c-0117671fd907",
        "email": "peter.parker@spidermail.com",
        "firstName": "Peter",
        "lastName": "Parker",
        "phoneCountryCode": 351,
        "phoneNumber": "999999999",
        "shippingAddress": "Av. Guerra Junqueiro 2A",
        "shippingPostalCode": "1000167",
        "shippingCity": "Lisbon",
        "shippingState": "LB",
        "shippingCountry": "PRT",
        "homeAddress": "Rua Rodrigo da Fonseca, 15 - 3H",
        "homePostalCode": "1250189",
        "homeCity": "Lisbon",
        "homeCountry": "PRT",
        "shippingType": "Undefined",
        "firstPurchaseDate": "2023-12-19T19:30:00+00:00",
        "lastPurchaseDate": "2023-12-19T19:30:00+00:00"
    },
    "orderOptions": {
        "redirectUrl": "https://paybyrd.com/",
        "culture": "en-US",
        "sendBy": []
    },
    "paymentOptions": {
        "useSimulated": true,
        "cardOptions": {
            "isPreAuth": false,
            "isDccEnabled": false
        },
        "tokenOptions": {
            "tokenizationMethod": "none"
        },
        "allowedPaymentMethods": [
            "FLOA3X",
            "FLOA4X",
            "FLOA1XD"
        ]
    },
    "terminalOptions": {
        "notifyChanges": false
    },
    "shoppingCart": {
        "items": [
            {
                "roomRange": 4,
                "checkInDate": "2024-12-01T00:00:00-03:00",
                "checkOutDate": "2024-12-07T00:00:00-03:00",
                "destinationCountryCode": "PRT",
                "guestsCount": 2,
                "amount": 80000,
                "categories": [
                    "HOTEL"
                ],
                "description": "Stay",
                "shipping": {
                    "shippingMethod": "VIR"
                },
                "type": "TravelWithStay"
            }
        ]
    },
    "marketId": "PT",
    "code": "BYRD200",
    "description": "Operation successfully completed",
    "checkoutKey": "eyJPcmRlcklkIjoiNGQ0MzhkNDQtNTYwOS00YWRjLWFjNWQtYTk0OGM3ZTM5NDU1IiwiT3JkZXJSZWYiOiJOZXcgT3JkZXIiLCJQZXJzb25JZCI6MzMwOCwiTGl2ZSI6ZmFsc2UsIkVudGl0eUlkIjoiNGQ0MzhkNDQtNTYwOS00YWRjLWFjNWQtYTk0OGM3ZTM5NDU1IiwiQW1vdW50IjoiMjUwMC4wMCIsIkN1cnJlbmN5IjoiRVVSIn0="
}

Create payment from order

You can create a Floa payment by passing the checkoutKey from the order response:

curl --request POST \
  --url 'https://gateway.paybyrd.com/api/v2/payment?checkoutKey=eyJPcmRlcklkIjoiNGQ0MzhkNDQtNTYwOS00YWRjLWFjNWQtYTk0OGM3ZTM5NDU1IiwiT3JkZXJSZWYiOiJOZXcgT3JkZXIiLCJQZXJzb25JZCI6MzMwOCwiTGl2ZSI6ZmFsc2UsIkVudGl0eUlkIjoiNGQ0MzhkNDQtNTYwOS00YWRjLWFjNWQtYTk0OGM3ZTM5NDU1IiwiQW1vdW50IjoiMjUwMC4wMCIsIkN1cnJlbmN5IjoiRVVSIn0%3D' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: {your_api_key}' \
  --data '
{
    "type": "BNPL",
    "amount": "50.00",
    "currency": "EUR",
    "culture": "en-US",
    "brand": "FLOA3X",
    "salesChannel": "Desktop",
    "orderRef": "New Order",
    "shopper": {
        "phoneCountryCode": 351,
        "phoneNumber": "11953259340",
        "email": "peter.parker@spidermail.com",
        "firstName": "Peter",
        "lastName": "Parker",
        "homeAddress": "Rua Rodrigo da Fonseca, 15 - 3H",
        "homeCountry": "PRT",
        "homePostalCode": "1250-189",
        "homeCity": "Lisbon",
        "civility": "Mr",
        "birthName": "Peter",
        "birthDate": "1962-08-01",
        "documentNumber": "123456789",
        "birthPostalCode": "99"
    }
}'

{
    "culture": "en-US",
    "salesChannel": "Desktop",
    "type": "Bnpl",
    "currency": "EUR",
    "orderRef": "New Order",
    "brand": "FLOA3X",
    "paymentMethod": "floa",
    "redirectUrl": "https://paybyrd.com/",
    "action": {
        "type": "redirect",
        "url": "https://webapp-redirect-api-stg.azurewebsites.net/api/v1/Redirect/8cc2ee46-0380-4687-b56b-0079f4c53850"
    },
    "shopper": {
        "customReference": "spiderman",
        "email": "peter.parker@spidermail.com",
        "firstName": "Peter",
        "lastName": "Parker",
        "birthName": "Peter",
        "birthDate": "1962-08-01T00:00:00",
        "birthPostalCode": "99",
        "civility": "Mr",
        "phoneCountryCode": 351,
        "phoneNumber": "11953259340",
        "ipAddress": "189.113.67.75",
        "shippingAddress": "Av. Guerra Junqueiro 2A",
        "shippingPostalCode": "1000167",
        "shippingCity": "Lisbon",
        "shippingCountry": "PRT",
        "homeAddress": "Rua Rodrigo da Fonseca, 15 - 3H",
        "homePostalCode": "1250-189",
        "homeCity": "Lisbon",
        "homeCountry": "PRT",
        "documentNumber": "123456789",
        "firstPurchaseDate": "2023-12-19T19:30:00+00:00",
        "lastPurchaseDate": "2023-12-19T19:30:00+00:00"
    },
    "code": "BYRD207",
    "description": "Pending redirect",
    "status": "Processing",
    "requestId": "4fc10ecd-46b1-4e0e-8702-40f62e3d2e24",
    "ipAddress": "139.113.64.75",
    "externalTransactionIdentifier": "0c3b24c9-97b6-4b3f-8f0d-556ea38fabb2",
    "marketId": "PT",
    "transactionId": "8cc2ee46-0380-4687-b56b-0079f4c53850",
    "amount": "50.00",
    "isoAmount": 5000
}

To check whether the transaction was accepted, look at the code field. A successful response returns BYRD207. See the Create Payment API reference for the full list of request parameters, and the API code reference for all possible codes.

Accept Payments

Manage Payments

How it works

Create order

Generic shopping cart

Airline shopping cart

Hotel shopping cart

Create payment from order

​How it works

​Create order

​Generic shopping cart

​Airline shopping cart

​Hotel shopping cart

​Create payment from order

How it works

Create order

Generic shopping cart

Airline shopping cart

Hotel shopping cart

Create payment from order