Collecting customer card payments

• Search for Offers

• Select Offer

• Create PaymentIntent

• Collect Payment

• Confirm PaymentIntent

• Create Order

• Inspect Collected Payments and Markups

Request

Shell
curl
curl -X POST --compressed "https://api.duffel.com/payments/payment_intents"
  -H "Accept-Encoding: gzip"
  -H "Accept: application/json"
  -H "Content-Type: application/json"
  -H "Duffel-Version: v2"
  -H "Authorization: Bearer $YOUR_ACCESS_TOKEN"
  -d '{
  "data": {
    "amount": "106.00",
    "currency": "GBP"
  }
}

• Offer and services total amount: this is the total cost of the flight plus any extra services without Duffel fees. We always present the offer and service(s) total_amount in your Balance currency.

• Markup: this is the amount on top of the flight cost that you might charge your customer to cover operational costs and any profits you want to make on the sale of the flight.

• Foreign exchange rate: this should only be applied if you are charging your customer in a currency different to the currency of your Balance, the currency of the offers returned by the API. You should use the mid-market exchange rate of the day from your Balance currency to the currency you want to charge your customer in. You should use an external source to get this rate (for example, https://fixer.io/), and add a 2% markup on top of the rate in order to cover the Duffel Payments foreign exchange fee of 2% (fx rate x 1.02). We recommend that you add slightly more than 2% to account for the fact the FX you use might be slightly different from the one used by Duffel.

• Duffel Payments fee: is determined based on the card country, it varies if the card is considered domestic or international, an example would be 2.9% or 0.029.

Diagram illustrating flow of funds all the way through from the customer, to the balance, to Duffel and to the airline

Response

JSON
{
  "data": {
    "id": "pit_00009hthhsUZ8W4LxQgkjo",
    "live_mode": true,
    "status": "requires_payment_method",
    "amount": "106.00",
    "currency": "GBP",
    "net_amount": null,
    "net_currency": null,
    "fees_amount": null,
    "fees_currency": null,
    "client_token": "c2hramgzaGVsbG8gd29ybGQgIyMgZ2lyYWY=",
    "card_network": null,
    "card_last_four_digits": null,
    "confirmed_at": null,
    "created_at": "2020-04-11T15:48:11.642Z",
    "updated_at": "2020-04-11T15:48:11.642Z"
  }
}

• Instructions to install the package

• List of available versions

• Example loading HTML custom element with script tag

• Example loading html custom element with npm

• Example loading React component with npm and React

• 4242 4242 4242 4242 as the card number

• any 3 digits as the CVC

• any future date as the expiry date

• and any ZIP code.

• If the payment is successful, the successfulPaymentHandler will be called without any arguments. Along with displaying a page confirming a successful transaction, this handler should call an endpoint in your back-end server to confirm the PaymentIntent - please see the next section.

• If the payment is unsuccessful, the errorPaymentHandler will be called with the error as an argument. You'd want to indicate to your user that the transaction hasn't gone through. This error will come directly from Stripe, our underlying payment provider. A full list of errors can be found here.

Request

Shell
curl
curl -X POST --compressed "https://api.duffel.com/payments/payment_intents/pit_00009hthhsUZ8W4LxQgkjo/actions/confirm"
  -H "Accept-Encoding: gzip"
  -H "Accept: application/json"
  -H "Duffel-Version: v2"
  -H "Authorization: Bearer $YOUR_ACCESS_TOKEN"

Response

JSON
{
  "data": {
    "id": "pit_00009hthhsUZ8W4LxQgkjo",
    "live_mode": true,
    "status": "succeeded",
    "amount": "106.00",
    "currency": "GBP",
    "net_amount": "121.03",
    "net_currency": "EUR",
    "fees_amount": "3.62",
    "fees_currency": "EUR",
    "client_token": "c2hramgzaGVsbG8gd29ybGQgIyMgZ2lyYWY=",
    "card_network": "visa",
    "card_last_four_digits": "4242",
    "confirmed_at": "2020-04-11T15:52:32.686Z",
    "created_at": "2020-04-11T15:48:11.642Z",
    "updated_at": "2020-04-11T15:48:11.642Z"
  }
}

Request

Shell
curl
curl -X POST --compressed "https://api.duffel.com/air/orders"
  -H "Accept-Encoding: gzip"
  -H "Accept: application/json"
  -H "Content-Type: application/json"
  -H "Duffel-Version: v2"
  -H "Authorization: Bearer $YOUR_ACCESS_TOKEN"
  -d '{
  "data": {
    "type": "instant",
    "selected_offers": [
      "off_00009htYpSCXrwaB9DnUm0"
    ],
    "payments": [
      {
        "type": "balance",
        "amount": "120.00",
        "currency": "EUR"
      }
    ],
    "metadata": {
      "payment_intent_id": "pit_00009hthhsUZ8W4LxQgkjo"
    }
    "passengers": [...]
  }
}

Response

JSON
{
  "data": {
    "id": "ord_00009htYpSCXrwaB9DnUm1",
    // ...
    "metadata": {
      "payment_intent_id": "pit_00009hthhsUZ8W4LxQgkjo"
    }
  }
}