JavaScript is required to view this page
Going Live

Going Live

This guide covers the process of taking your BlinkPay integration from sandbox to production.

Production Readiness Checklist

Integration

  • Consent creation and authorisation working
  • Blink Payments: payment initiation and status polling working
  • Blink Data: consents created and their status checked with GET /v1/consents/{consent_id}, account data retrieved with the consent_id, and revocation with DELETE /v1/consents/{consent_id} working
  • Each flow you use (Gateway/Redirect/Decoupled) tested for every outcome the sandbox can produce: approval, decline, timeout and revocation
  • Where required, handling in place for outcomes the sandbox cannot produce (bank errors, revocation at the bank, and for Blink Payments a payment rejected by the bank after authorisation), built from the documented statuses and error codes
  • Return URL handling correct, with every outcome confirmed by a server-side GET
  • Error handling implemented (401 token refresh, 5xx retry with backoff, timeouts)
  • Tested with mock bank (PNZ) in sandbox
  • Blink Payments: AcceptedSettlementCompleted is the only status treated as success (it means the payer's bank has confirmed sending the funds), never the return redirect or the consent status alone
  • Blink Payments: your own payment confirmation or receipt sent to the customer. BlinkPay does not send receipts to your customers.
  • Card payment onboarding completed (acquirer merchant ID, MCC, acquirer bank provided to BlinkPay)
  • Card payment feature confirmed enabled via metadata endpoint
  • Card payment flow tested in sandbox with test card numbers

Security

  • API credentials stored securely (environment variables or secret manager)
  • No credentials in source control
  • All API calls use HTTPS
  • Bearer tokens implemented correctly
  • No tokens exposed in client-side code
  • Credential and Integration Security guidance followed

User Experience

  • Clear instructions displayed: what the customer is paying, or what account data they are sharing and for how long
  • Loading states implemented
  • User-friendly error messages
  • Success confirmation displayed
  • Mobile responsive design
  • Customers can view active consents
  • Customers can revoke consents through same channel used for creation
  • Consent expiry handling implemented
  • Expired/revoked consent detection in place

Monitoring

  • Signed up for service status updates: blinkpay.co.nz/service-status
  • Consent and payment IDs logged for troubleshooting, and for Blink Payments the request-id of each call
  • Error rates monitored
  • Blink Payments: payments still Pending are followed up. Most payments move within seconds; if one is still Pending after 6 hours, contact support with the consent ID and payment ID

Compliance (Direct Flows Only)

If using Redirect/Decoupled flows directly (not Gateway):

  • Payments NZ Customer Experience Guidelines compliance verified (see Consent Experience for Direct Flows)
  • x-customer-ip and x-customer-user-agent headers implemented
  • Blink Data: privacy policy updated to cover account data access

Requesting Production Access

Production access is requested from the same portal you use for sandbox, at merchants.blinkpay.co.nz.

Step 1: Select "Upgrade to Production"

Log in and select Upgrade to Production, in the top navigation bar or on Settings > API Settings. Anyone in your organisation can see the button, but only an Administrator can submit the application.

Step 2: Submit the Application

The application asks for your business details, the services you need, banking and billing details and a security questionnaire, then for you to review it and accept the Client Service Agreement.

Step 3: Production Upgrade Approval

BlinkPay reviews your business and integration needs. Production upgrade approval usually takes 1-3 business days.

Step 4: Get Your Production Credentials

Once approved, open Settings > API Settings and open the Production row. Copy the API Client ID, then select Rotate Secret to obtain the client secret. The portal shows the secret only once, so store it in your secret manager straight away.

Base URLs:

  • Blink Payments: https://debit.blinkpay.co.nz
  • Blink Data: https://data.blinkpay.co.nz

Step 5: Configure and Check Production

Production is configured separately from sandbox. Before you launch:

  1. Register your production redirect URLs. The production whitelist is separate from the sandbox one: add them under Settings > API Settings, Production row, Whitelisted Redirect URLs. Production rejects http:// and localhost URLs. Blink Payments: if you use Fixed Recurring Payment webhooks, create the subscription again in production; its callback URL must also be on the production whitelist.
  2. Confirm which banks are enabled for your account by calling the metadata endpoint with your production credentials (Blink Payments: GET /payments/v1/meta; Blink Data: GET /v1/meta). See Metadata.
  3. Make a low-value live payment (or, for Blink Data, a live consent) as a final smoke test, and check it reaches its expected final status.

Production Configuration

Configure your application to use production endpoints and credentials:

  • Base URL for Blink Payments: https://debit.blinkpay.co.nz
  • Base URL for Blink Data: https://data.blinkpay.co.nz
  • Store Client ID and Client Secret in environment variables

Use Environment Variables

Never hard-code production credentials. Always use environment variables or a secure secret management system.

Key Metrics to Monitor

Track these metrics to understand your integration performance:

  • Payment success rate (Blink Payments)
  • API error rate
  • Consent authorisation rate
  • Average time to completion