Results (24)
Authorize Transaction
v1-api
English
Post /v1/transactions Using the order_id from the checkout flow, an authorization is the first step using the Transaction API.  Once an authorization is submitted against an Order, a new Transaction is created. In most use cases, you will
Get Offers
v1-api
English
Example 1000.13 supplierCode string Supplier code. Example SC-12345678-9 campaignAttributes Array of object (CampaignAttribute) List of targeted campaign attributes. object Optional targeted campaign attribute. name string Required Campaign attribute name. Example merchant_field_1 value string Required
Create Order
v1-api
English
loyaltyRewards string Amount of Points/Miles remaining in the member’s loyalty account after the transaction. The member may not be one of the travelers. Example 10 pointsEarned string Amount of Points/Miles accrued with the current transaction, if
Samples
v1-api
English
{ "body": "We look at a number of factors, including your credit information, purchase details, and more.", "index": "0", "title": "How are my loan term offers determined?" }, { "body": "Yes, you can make additional payments to pay down your balance or
Recommended Workflow
v1-api
English
"cbaf4ada-e78c-40f3-b6e3-0953b442cfd1", "original_amount": 1000.00, "remaining_amount": 500.00, "captured_amount": 300.00, "refunded_amount": 0.00, "authorization_expiration": "2025-04-21T20:33:15.200317Z", "order_id": "d2e50ab8-2839-4865-bf38-b20ca4cdf7b7", "created": "2025-04
Read Order
v1-api
English
Get /v1/orders/{orderId} Retrieves an order.  Used to read data in the Flex Pay order.  It can be used when there is a doubt if the previous endpoint functioned correctly. Security HTTP Type bearer Path parameters orderId string Required
Authorization
v1-api
English
All requests to the Flex Pay’s APIs (both marketing and checkout REST APIs) require an access_token sent in the request headers. You can retrieve your access_token by making a request to our login service & providing your Upgrade
Recommended Workflow
v1-api
English
Recommended Workflow 1. Get Pricing for Payment Selector (Marketing API) Using the Marketing API on the Checkout Page will allow an order to be qualified so as to not show the pricing and or payment option if the order isn
Overview
v1-api
English
Flex Pay Transaction API The Flex Pay Transactions API enables you to manage the transaction lifecycle of your orders after your customers have completed the Flex Pay checkout journey. To do so, you will first authorize a transaction using the
Overview
v1-api
English
Marketing Offers API 1.0.0 This API enables the promotion of Flex Pay Buy Now, Pay Later options anywhere in the shopping journey. Offers can be embedded next to merchant pricing to let users know monthly pricing is available
Confirm Order
v1-api
English
Put /v1/orders/{orderId}/confirmation Used to confirm the order to Flex Pay, including their confirmation number. The order is confirmed in their system and they provide us with their confirmation number.  Security HTTP Type bearer Path parameters orderId string
Overview
v1-api
English
Streamline your customer's journey with the Flex Pay Checkout API. This API enables a smooth transition from your merchant site to our Buy Now, Pay Later application and approval process. The API facilitates the purchase, returns Virtual Credit Card
Read Card
v1-api
English
Get /v1/orders/{orderId}/payment Security HTTP Type bearer Path parameters orderId string Required Order ID Responses 200 Successful payment response application/json Expand All object Payment details. card object (Card) Card details for merchant payout id string | null Do
User Interface Examples
v1-api
English
Here are some examples of how the Marketing Offers API can be utilized during the shopping journey. These can be used at any time when pricing is being presented. Note: certain disclaimers and disclosures that we include in the API
Get Transaction
v1-api
English
Get /v1/transactions/{transactionId} Security HTTP Type bearer Path parameters transactionId string (uuid) Required Responses 200 Successful response application/json Expand All object id string (uuid) The unique transaction_id generated when an authorization is submitted for an order. original
Orders
v1-api
English
Capture Transaction
v1-api
English
Post /v1/transactions/{transactionId}/capture When you’re ready to request payments for your customer’s order, you can submit a POST request to the capture endpoint. Flex Pay provides the flexibility to either fully or partially capture the transaction
Introduction
v1-api
English
Welcome to the Flex Pay REST API integration documentation. Here you will find all you need to integrate with our easy to use REST API so that you can offer Flex Pay as a payment method. Flex Pay enables our
Refund Transaction
v1-api
English
Post /v1/transactions/{transactionId}/refund To refund a previous captured transaction, you can submit a POST request to the refund endpoint. Similar to capture requests, you have the flexibility to fully or partially refund a transaction by specifying an amount
Void Transaction
v1-api
English
Post /v1/transactions/{transactionId}/void In the event you need to void an already authorized transaction, such as when the customer is cancelling an item before it is fulfilled, or you are certain that an item is out of stock