Skip to content

Developer documentation

Take bank transfers and card payments in New Zealand and Australia with one integration. Create a checkout, send your customer to it, get paid.

How a Flik payment works

Every payment follows the same three steps, whichever rail the money moves on.

  1. Create a checkout

    Your server calls the Flik API with an amount and a reference. Flik returns a URL.

  2. Send your customer to it

    Flik hosts the payment page. Your customer picks their bank or enters card details there, so card numbers and bank credentials never touch your servers.

  3. Read back whether it is paid

    Flik returns your customer with the ids on the URL. You read the payment back over the API and fulfil the order on what it says. A signed webhook is there for the payers who never make it back.

Two payment rails

Flik moves money two ways. A single checkout can offer one or both — you choose per payment with checkoutMethod.

Rail checkoutMethod What the customer sees
Open banking open_banking Picks their bank and approves the payment in their banking app. New Zealand, NZD only.
Card card Enters card details on the Flik checkout.
Both both Chooses between bank and card on the checkout page.

Which resource do I need?

Flik has two ways to collect a payment. The difference is whether the URL is meant for one customer or many.

Checkout session

For a customer who is paying now. An unguessable URL that expires after 24 hours and stops taking payment once it is paid.

  • An order at online checkout
  • A customer you are redirecting this minute
  • Anywhere a URL should not outlive the checkout

Checkout sessions →

Payment link

For a customer who will pay later. One amount, on a URL that stays live until it is paid, however long that takes.

  • An invoice you email or post
  • A printed reminder or a QR code
  • Anywhere the payer may take days

Payment links →

Start here

Authentication

API keys, test versus live, and exchanging credentials for an access token.

API reference

Every endpoint, every parameter, every field Flik returns.

Webhooks

Know the moment a payment completes, and verify the signature.

Testing

Test keys and the sandbox flow, so you can build without moving money.

Errors

Every error code Flik returns and what to do about each one.

Prefer not to write code?

Plenty of Flik merchants never touch the API. You can create payment links, payment squares and till transactions from the Flik portal, or install a plugin:

Next Authentication →