For Developers

Developer Resources for Open Banking Payment Integration in NZ

Integrate secure, real-time bank payments directly into your checkout or app with BlinkPay’s API. With clear docs, a sandbox environment, and NZ-based support, developers can go from sandbox to production quickly and confidently.

BlinkPay developer resources and API documentation
Developer joining the BlinkPay team, working on integrations
API Features

Why Developers Choose BlinkPay’s Payment API

  • RESTful API — Simple JSON-based requests with clear error handling
  • Sandbox Environment — Simulate payments before going live
  • Webhooks — Events for Fixed Recurring Payments. Other payments report their status through the API
  • Secure by Design — Open banking compliant, ISO 27001 certified, no screen scraping
  • NZ Bank Integration — Works with ANZ, ASB, BNZ, Kiwibank and Westpac

Integration Process Flow

1

Account Setup

Create your developer account and verify your business

2

API Keys

Generate your API keys for development and production

3

Dev Setup

Install SDK and configure development environment

4

Testing

Test integration using sandbox environment

5

Launch 🎉

Go live with your integration

Developer Resources for Open Banking Payment Integration in NZ

Build bank payments with BlinkPay’s API. Our developer resources make it easy to integrate secure, real-time payments into your app or checkout — with clear docs, a sandbox and NZ-based support to help you launch fast.

Example API Request

POST https://debit.blinkpay.co.nz/payments/v1/payments
Authorization: Bearer ACCESS_TOKEN

  {
    "consent_id": "035d4ea4-4037-4110-9861-183eae1408b4",
    "pcr": {
      "particulars": "INV123",
      "code": "PAYMENT",
      "reference": "CUST456"
    },
    "amount": {
      "total": "100.00",
      "currency": "NZD"
    }
  }

Fast Setup

Get started in minutes with our RESTful API and SDKs.

Bank-Grade Security

ISO 27001 certified. Built on open banking standards — no screen scraping.

Built for Developers

Clear docs. Simple JSON APIs. Support when you need it.

High Uptime, Low Latency

99.9% uptime and resilient infrastructure to keep payments moving.

Integration Guides, Examples, and SDKs

Whether you’re building in Node.js, Python, Java, or C#, our guides help you get started quickly. Example use cases include: - Integrating BlinkPay into an eCommerce checkout - Setting up recurring payments via enduring consent - Automating payment status monitoring via webhooks

Developers working

Getting Started Guide

Quick start guide and basic concepts for building with BlinkPay.

SDK Libraries

Official SDKs for major platforms to speed up your integration.

Plugins & SDKs

Choose how you connect to BlinkPay.

Install the plugin for a WooCommerce checkout, or build a custom integration with our SDKs.

ONE-OFF CHECKOUT

BlinkPay NZ for WooCommerce

Running your shop on WooCommerce? Install the free BlinkPay plugin, add your keys, and your customers can pay straight from their bank at checkout. Switch on card payments as well, and they can pay by card through the same checkout.

  • Free and open source. Find it in the WordPress plugin directory, with the source code on GitHub.

  • Orders update themselves. The plugin checks every payment with BlinkPay before it marks an order as paid.

  • Refunds from the order screen. Card payments are refunded automatically. For bank payments, the plugin shows the account your customer paid from, so you can refund them from your own bank.

  • Fits the checkout you have. Works with both the classic and block-based WooCommerce checkout.

Get the plugin on WordPress.org (opens in a new tab)Read the setup guide (opens in a new tab)

How it works

  1. In WordPress, go to Plugins > Add New and install "BlinkPay NZ for WooCommerce".

  2. Add your BlinkPay client ID and secret.

  3. Add the plugin's callback URL to your allowed redirect URLs in the Client Portal.

  4. Test in sandbox, then switch to your production keys.

Need a merchant account?

Building a custom integration?

Connect your website, app or backend with a BlinkPay SDK.

WooCommerce and its associated designs are trademarks of Automattic Inc. WordPress is a registered trademark of the WordPress Foundation.

Explore BlinkPay's API

Our API docs cover everything developers need to integrate bank payments into your platform.

One-off Payments

Take one-off bank-to-bank payments with our PayNow API.

Recurring Payments

Set up automated recurring payments with enduring consent. Perfect for subscriptions and regular billing.

Payment Tracking

Real-time payment status tracking and automated reconciliation. Stay informed at every step.

Recurring Payment Events

Webhooks tell you when a fixed recurring payment completes, fails or its schedule is cancelled. Other payments report their status through the API.

Ready to start building?

Developer FAQs

Find answers to common questions about integrating with BlinkPay API.

General Questions

Get Support From Our Developer Success Team

  • NZ-based technical support
  • Fast responses for sandbox setup, API keys or production readiness
  • Guidance on API integration, authentication or webhook handling
Contact Developer Support