Products

"Products" are the unique configurations of agreements and payment services enabled for a Merchant, experienced by users as a simple “pay later” payment option.

For example:

  • “John’s Plan” might be a product configured for 4 fortnightly payments, with a min/max of $500/$2,500 and a fee of 6%
  • “Sally’s Plan” might be a product configured for 8 weekly payments, with a min/max of $500/$3,500 and a fee of 4.5%
  • “Harry’s Plan” might be a product configured for a single repayment in 90 days, with a max of $10,000 and a fee of 5%, with a possible extension of 30 days for an additional fee of 1.5%.

Products are offered under different "types", for example:

  • BNPL (buy now pay later) - request amount is repaid over a series of payments
  • BNPO (buy now pay once) - request amount is repaid in one payment

From an integration perspective, most product types behave similarly other than the different schedules, experienced in the response when creating or retrieving a payment request.

BNPL:

"payLaterProductEnabled":{

       "productId": "PL-1234-5678",

       "productType": "B2C-BNPL",

       "productName": "BNPL Example",

       "startDate": "15-01-2022",

       "requestAmount": "4000.00",

       "disbursementAmount": "3700.00",

       "totalCustomerPayable": "4000.00",

       "perInstalmentAmount": "1000.000",

       "paymentFrequency": "Fortnightly",

       "numberOfPayments": "4",

       "productText": "4 interest-free payments of $1,000.00, Payable fortnightly, First payment taken on DD-MM-YYYY"

   },

BNPO:

"payLaterProductEnabled":{

       "productId": "PL-1234-5678",

       "productType": "B2C-BNPO",

       "productName": "BNPO Example",

       "startDate": "15-01-2022",

       "requestAmount": "4000.00",

       "disbursementAmount": "4000.00",

       "totalCustomerPayable": "4300.00",

       "repaymentDate": "15-04-2022",

       "productText": "Full repayment due within 90 days"

   },

Product fields

Some products may require additional information (beyond the standard request model of amount, customer, product ID etc) to be provided by the Merchant and/or Customer on an individual payment request before the request can be approved by FlipPay - this is handled via “product fields”.

Product fields may have a number of controls applied to them by FlipPay, determining if the field is required before sending or before approving a payment plan, if the field can be updated after the plan is approved, and if the field can be edited/viewed by Merchant and/or Customer at various stages.

Merchants are able to view the product field requirements for products enabled on their account, via their Merchant account (Settings | Integrations) or by calling the “getProduct” service. Introducers are able to view the product field requirements for products enabled on link Merchants, via their Introducer account or by calling the “getProduct” service referencing a specific Merchant ID.

Product field types

The following field types may be configured as a product field, requiring integrated systems to ensure data provided into these fields are formatted as such:

Field type (FlipPay)

Field type (JSON)

Notes

text

string

Standard string format

number

number

Standard number format

currency

number

Number with 2 decimal places required

E.g. 

100.00 = ok

100 = not ok

100.0 = not ok

date

string

String, formatted as:

“DD-MM-YYYY”

address-block

Object, containing 5 string fields

Standard string format

option-list

string

Standard string format

file-upload

file

File

Product field access controls & requirements

Product fields can have specific access controls applied to them, depending on the product’s individual requirements.

When creating/sending a payment request

  • Editable by Merchant - field can be populated by the Merchant/Introducer when creating the payment request
  • Required to send - field must be populated by the Merchant/Introducer when creating the payment request

Considerations:

  • If the field is set to “required to send”, it must be validly populated when creating the payment request, otherwise the service request will return an error - calling systems should require authorised users to enter the required data, an ensure that data is formatted correctly for the nominated field type
  • The only exception is for a “file-upload” field type, as the file cannot be provided in the same service request
    • A payment request needing a file to be uploaded at creation will be created in a specific status “info-required”
    • While in this status, the payment request is not accessible by Merchants (via the FlipPay web interface) or Customers (via the URL returned on creation of the payment request)
    • The calling system can then upload the required file to the product field using the “uploadFile” service and nominating the product field ID
    • Upon a successful file upload, the payment request will move from “info-required” to “pending” and be accessible to Merchants and Customers

On the payment page

  • Viewable by Customer - field is displayed to the Customer on the payment page, when they view their payment request
  • Editable by Customer - field can be edited by the Customer on the payment page when they view their payment request
  • Required to submit - field must be populated when the Customer accepts a “pay-later” offer

Considerations

  • If a field is set to “editable by Merchant” at the time of creation, and also set to “editable by Customer” on the payment page, the last value entered will be recorded against the payment request (e.g. if the Merchant pre-populates a field, and the Customer then updates that field - the value entered by the Customer will be saved)

After a pay later request has been activated

  • Viewable by Merchant - field is displayed to the Merchant within the Merchant portal when viewing the payment request
  • Editable by Merchant - field is editable by the Merchant within the Merchant portal when viewing the payment request, after the request has been activated by a Customer accepting “pay-later” offer
  • Viewable by Customer - field is displayed to the Customer within their “payment plan management” interface
  • Editable by Customer - field is editable by the Customer within their “payment plan management” interface

Considerations

  • Customers are not required to access their “payment plan management” interface, but can do so at any time while their payment request is active
  • FlipPay will accept valid data from the Customer (via their “payment plan management” interface) and/or the Introduce/Merchant via API and/or the Merchant via the Merchant portal - the latest entry will be displayed
  • Fields are not editable once the payment request is complete