Create a payment request using objects available on a nominated Merchant account.

Refer to the integration guide to confirm specific field format requirements (e.g. dates, currency, etc).

All payment requests expire after 90 days.

If a customer follows a URL to an expired payment request, they will receive an error page directing them to speak to their merchant. Merchants can "resend" an expired payment request using this service, which re-activates the payment request as it was initially configured, and using the same URL.

All payment requests are created and exist in a "pending" status until they expire, are cancelled, or are accepted/activated.

Merchants can cancel payment requests while they are in the "pending" status.

Cancelled payment requests cannot be resent using 'resendPR'. If a Customer follows a URL to a cancelled payment request, they will receive an error page directing them to speak to their Merchant.

Retrieve all the available details contained within a payment request.

Some products allow updates to "product fields" while a payment plan is active. Refer to product integration guide within your Introducer/Merchant account for specific product requirements.

Files can be uploaded and attached to PR in three scenarios:

1. A maximum of three PDF files can be simply attached to the payment request without context.
2. Within a Merchant's custom field - a single PDF file can be uploaded into a "file-upload" type custom field (e.g. to pre-populate a specific field, rather than attaching without context).
3. Within a product field - a single PDF file can be uploaded into a "file-upload" type product field. Use this service to update a product field of "file-upload" type, if the product field allows for updates while the payment request is active.

• Only PDF file types accepted, with a maximum file size of 5MB.
• Either productFieldId or customFieldId can be populated in a single request, but not both.
• If no productFieldId or customFieldId is provided, the file will be attached to the PR without context.

Retrieve the details of any files attached to a payment request.

Files can be deleted from a payment request only while the payment request is in "pending" status.

Upload a logo image to the merchant logo library.

Retrieve the listings of images in the logo library of a merchant.

Delete a logo image from the logo library.

Replace an existing logo image on the merchant logo library with a new one, retaining the same logoId.

Generate a quote for a given amount and product (as available on the Merchant account).

Retrieve a list of bank accounts configured on a merchant's account.

Retrieve a list of products enabled on a Merchant account.

Send a request to link a Merchant account to an Introducer account (Merchant to respond via logged in user on the FlipPay web portal)

Note:
Notifications sent to the notificationUrl provided will have the following structure:

{
  "merchantId": "M-1234-5678",
  "linkedStatus": "linked|unlinked"
}

Create a unique/secure onboarding form for a new merchant to apply for a FlipPay merchant account

Note:
Notifications sent to the notificationUrl provided will have the following structure:

Approved

{
  "onboardingId": "OB-1234-5678",
  "merchantId": "M-1234-5678",
  "applicationStatus": "approved"
}

Cancelled

{
  "onboardingId": "OB-1234-5678",
  "applicationStatus": "cancelled"
}