# BlinkPay Documentation

> Developer documentation for BlinkPay, New Zealand open banking: Blink Payments for one-off and recurring payments, and Blink Data for account data. Append .md to any documentation URL for its markdown source. To start a new integration, load the full documentation for your product first.

## Full documentation

- [all pages](https://merchants.blinkpay.co.nz/docs/llms-full.txt): every page in one markdown file
- [Blink Payments pages and the shared pages](https://merchants.blinkpay.co.nz/docs/debit/llms-full.txt): every page in one markdown file
- [Blink Data pages and the shared pages](https://merchants.blinkpay.co.nz/docs/data/llms-full.txt): every page in one markdown file

## OpenAPI specifications

- [Blink Payments (Payment APIs)](https://merchants.blinkpay.co.nz/docs/debit/openapi.yaml): every request and response schema, in YAML
- [Blink Data (Data APIs)](https://merchants.blinkpay.co.nz/docs/data/openapi.yaml): every request and response schema, in YAML

## Blink Payments (Payment APIs)

- [Blink Payments Essentials](https://merchants.blinkpay.co.nz/docs/debit/essentials.md): The facts every Blink Payments integration needs, on one page - base URLs, token endpoint, credentials, sandbox test values, return parameters, the success rule, polling, idempotency and limits - each linked to its detail.
- [Getting Started with BlinkPay](https://merchants.blinkpay.co.nz/docs/debit.md): BlinkPay is New Zealand's purpose-built open banking payment gateway, enabling secure account-to-account payments and data access.
- [BlinkPay Overview](https://merchants.blinkpay.co.nz/docs/debit/overview.md): Understanding BlinkPay's open banking platform, products, and capabilities
- [Quick Start Guide](https://merchants.blinkpay.co.nz/docs/debit/quick-start.md): Get up and running with BlinkPay payments using Gateway Flow with Quick Payments
- [Consent Types](https://merchants.blinkpay.co.nz/docs/debit/concepts/consent-types.md): Understanding Single, Quick Payment, Enduring, and Data consents
- [Consent Lifecycle](https://merchants.blinkpay.co.nz/docs/debit/concepts/consent-lifecycle.md): Understanding consent statuses and state transitions
- [Payment Lifecycle](https://merchants.blinkpay.co.nz/docs/debit/concepts/payment-lifecycle.md): Understanding payment statuses, settlement, and state transitions
- [Single Payments](https://merchants.blinkpay.co.nz/docs/debit/guides/single-payments.md): Implement one-off payment initiation with Quick Payments and Single Consents
- [Recurring Payments](https://merchants.blinkpay.co.nz/docs/debit/guides/recurring-payments.md): Implement subscription billing and instalment plans with Enduring Consents
- [Fixed Recurring Payments](https://merchants.blinkpay.co.nz/docs/debit/guides/fixed-recurring-payments.md): Automate scheduled payments with Fixed Recurring Payment schedules
- [Gateway Integration](https://merchants.blinkpay.co.nz/docs/debit/guides/gateway-integration.md): Integrate BlinkPay's hosted payment gateway for simplified bank selection and authentication
- [Card Payments](https://merchants.blinkpay.co.nz/docs/debit/guides/card-payments.md): Accept credit and debit card payments through the BlinkPay Gateway
- [Refunds](https://merchants.blinkpay.co.nz/docs/debit/guides/refunds.md): Refund bank and card payments with the Refunds API, check refund status, and retry safely
- [Surcharging (Fee Forwarding)](https://merchants.blinkpay.co.nz/docs/debit/guides/surcharging.md): Pass BlinkPay's transaction fee on to your customers for one-off bank and card payments, and read the surcharge in API responses
- [WooCommerce](https://merchants.blinkpay.co.nz/docs/debit/guides/woocommerce.md): Accept Blink PayNow payments in a WooCommerce store with the BlinkPay NZ for WooCommerce plugin
- [Testing Guide](https://merchants.blinkpay.co.nz/docs/debit/testing.md): Sandbox testing and test scenarios for BlinkPay integration
- [SDKs & Client Libraries](https://merchants.blinkpay.co.nz/docs/debit/sdks/overview.md): Production-ready SDKs for Java, Node.js, .NET and PHP
- [Error Codes Reference](https://merchants.blinkpay.co.nz/docs/debit/error-codes.md): Common Payment API error codes and their meanings

## Blink Data (Data APIs)

- [Blink Data Essentials](https://merchants.blinkpay.co.nz/docs/data/essentials.md): The facts every Blink Data integration needs, on one page - base URLs, token endpoint, credentials, the consent request, sandbox test values, return parameters, polling, reading and refreshing data, and idempotency - each linked to its detail.
- [Getting Started with Blink Data](https://merchants.blinkpay.co.nz/docs/data.md): Blink Data gives your application customer-authorised access to account, balance, transaction and statement data from New Zealand banks.
- [Blink Data Overview](https://merchants.blinkpay.co.nz/docs/data/overview.md): Secure account information access through open banking
- [Quick Start](https://merchants.blinkpay.co.nz/docs/data/quick-start.md): Get started with Blink Data API
- [Permissions](https://merchants.blinkpay.co.nz/docs/data/concepts/permissions.md): Understanding data access permissions
- [Consent Lifecycle](https://merchants.blinkpay.co.nz/docs/data/concepts/consent-lifecycle.md): Understanding data consent states and management
- [Data Retrieval](https://merchants.blinkpay.co.nz/docs/data/guides/data-retrieval.md): Guide to retrieving account information through Blink Data APIs
- [Testing Guide](https://merchants.blinkpay.co.nz/docs/data/testing.md): Sandbox testing and test scenarios for Blink Data integration
- [Error Codes Reference](https://merchants.blinkpay.co.nz/docs/data/error-codes.md): Blink Data (BDT) error codes, with the cause of each and how to fix it

## Shared

- [Authentication](https://merchants.blinkpay.co.nz/docs/shared/authentication.md): Learn how to authenticate with the BlinkPay API using OAuth 2.0
- [Gateway Flow](https://merchants.blinkpay.co.nz/docs/shared/flows/gateway-flow.md): Strongly recommended authentication flow using BlinkPay's hosted gateway
- [Redirect Flow](https://merchants.blinkpay.co.nz/docs/shared/flows/redirect-flow.md): Learn about direct bank redirect integration with BlinkPay
- [Decoupled Flow](https://merchants.blinkpay.co.nz/docs/shared/flows/decoupled-flow.md): Learn about mobile authorisation with BlinkPay's Decoupled Flow
- [Mobile Integration](https://merchants.blinkpay.co.nz/docs/shared/flows/mobile-integration.md): Guide to integrating BlinkPay in mobile applications
- [App-to-App Flow](https://merchants.blinkpay.co.nz/docs/shared/flows/app-to-app.md): Return customers straight from their banking app to your mobile app with redirect_to_app
- [Security & Compliance](https://merchants.blinkpay.co.nz/docs/shared/security.md): Learn about BlinkPay's security measures, certifications, and data protection practices
- [Bank Coverage](https://merchants.blinkpay.co.nz/docs/shared/bank-coverage.md): Detailed coverage of supported banks, authentication flows, and bank-specific features
- [API Policies](https://merchants.blinkpay.co.nz/docs/shared/reference/api-policies.md): Acceptable use, security testing, and API change policies
- [Metadata Endpoint](https://merchants.blinkpay.co.nz/docs/shared/reference/metadata.md): Query bank features, limits, and capabilities
- [Glossary](https://merchants.blinkpay.co.nz/docs/shared/reference/glossary.md): Definitions of key BlinkPay and open banking terms
- [Postman Collection](https://merchants.blinkpay.co.nz/docs/shared/reference/postman.md): Test BlinkPay APIs using our Postman workspaces
- [AI Coding Tools (MCP)](https://merchants.blinkpay.co.nz/docs/shared/reference/ai-tools.md): Connect Claude Code, Cursor or any MCP client to the BlinkPay documentation and API specifications
- [Credential and Integration Security](https://merchants.blinkpay.co.nz/docs/shared/standards/credential-security.md): How to hold BlinkPay API credentials, tokens and redirect URLs safely, and how to confirm outcomes you can trust
- [Consent Experience for Direct Flows](https://merchants.blinkpay.co.nz/docs/shared/standards/consent-experience.md): What your application must show customers when it uses the redirect or decoupled flow directly instead of the BlinkPay gateway
- [Troubleshooting](https://merchants.blinkpay.co.nz/docs/shared/help/troubleshooting.md): Common issues, solutions, and debugging techniques
- [Going Live](https://merchants.blinkpay.co.nz/docs/shared/help/going-live.md): Production readiness checklist for BlinkPay integration
- [Demo Applications](https://merchants.blinkpay.co.nz/docs/shared/help/demos.md): Live examples and reference implementations
- [Support & Help](https://merchants.blinkpay.co.nz/docs/shared/help/support.md): Get help with your BlinkPay integration