---
title: "Floa - Payment"
method: POST
path: "/v1.02/floa/create"
---

# Floa - Payment

`POST /v1.02/floa/create`

Creates a request to allow the customer to pay using Floa Pay service.

## Request body

- object
  - `payment` object, required — Informations regarding the payment
    - `identifier` string
    - `amount` object
      - `value` number, float, required — Payment amount
      - `currency` string, required
    - `lang` 'PT' | 'ES' | 'FR', required — Defines the Language of the form. "PT" for Portuguese, "ES" for Spanish or "FR" for French
    - `backUrl` string, required — The customer will be forwarded to this url if the user presses back.
    - `successUrl` string, required — The customer will be forwarded to this url if the payment process is successful.The payer will be forwarded to this url if the user presses back.
    - `failUrl` string, required — The customer will be forwarded to this url if the payment process fails (eg: no funds)
    - `reportDelayInDays` string — Only for Pay Later installmentCodes ( 'BC1XCD', 'BC1XFD','BC1XCDSP', 'BC1XFDSP', 'BC1XFDPT')
  - `installmentCode` 'BC3XFPT', required — The installment code defines the number of installments in which the customer will pay and whether there will be fees for it. It is limited by country and amount.
  - `items` object[], required — All items in the order. This param may include different objects (items).
    - `name` string, required
    - `price` number, float, required — Total price for this kind of product (the sum of all quantities)
    - `quantity` integer, required — Number of products of this kind
    - `category` string, required — Indicate the product category. For example Tech
    - `subCategory` string, required — Indicate the subcategory of the product. For example Headphones
  - `customer` object — Customer information that can be filled later on the Floa form if not sent on this request.
    - `civility` ''Mr'' | ''Ms'' | ''Mrs'' — The courtesy title "Mr" from Mister is used for men regardless of marital status. "Mrs" from Mistress and "Ms" from "Miss" are used for married and unmarried women, respectively.
    - `firstName` string — Customer first name
    - `lastName` string — Customer last name
    - `secondLastName` string — Mandatory for "Mrs" civility only. (Usually the husband last name when it's adopted by the wife).
    - `birthDate` string — Birth date of the customer. Please input on the format YYYY-MM-DD (example 2000-05-07)
    - `birthDepartment` string — The birth department field it's mandatory and applied for France only
    - `email` string — Customer email address
    - `phoneNumber` string — Customer phone number
    - `countryCodePhone` string — Country calling code for the client phone. For portuguese numbers for example, you must input "+351"
    - `vatNumber` string — VAT identification number
    - `billingAddress` object — Customer billing address information
      - `address` string — Street name
      - `zipCode` string — Postcode must be entered in the format of the country in question. For example, for Portugal enter 4150-124
      - `city` string
      - `countryCode` 'PT' | 'ES' | 'FR' — Defines the Language of the form. "PT" for Portugal, "ES" for Spain or "FR" for France
    - string
  - `shippingAddress` object — Address where the products will be shipped to the customer
    - `shippingMethod` 'STD' | 'EXP' | 'TRK' | 'REG' | 'COL' | 'CHR' | 'REL' | 'TNT' | 'UPS' | 'TRP' | 'MAG' | 'LCK' | 'VIR' | 'RIM' — STD -> Standard Delivery, EXP -> Express Delivery, TRK -> Tracked Delivery , REG -> Registed Delivery, COL -> Colissimo, CHR -> Chronopost, REL -> Point Relais, TNT , UPS , TRP -> Transporter , MAG -> Store Delivery, LCK -> Lockers, VIR -> Virtual, RIM ->Immediate pick-up store
    - `address` string — Street name
    - `zipCode` string — Postcode must be entered in the format of the country in question. For example, for Portugal enter 4150-124
    - `city` string
    - `countryCode` 'PT' | 'ES' | 'FR' — Defines the country to be shipped the items. "PT" for Portugal, "ES" for Spain or "FR" for France

## Response `201`

201

- object
  - `transactionStatus` string
  - `transactionID` string
  - `reference` string
  - `redirectUrl` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/eupago/apis/intro-and-oauth.md) · [All operations](https://skmtc.net/eupago/apis/intro-and-oauth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eupago/intro-and-oauth/versions/778475fa98e9/schema)
