JavaScript is required to view this page
Postman Collection

Postman Collection

Test and explore BlinkPay APIs using our Postman collections.

Workspaces

APIPostman Workspace
Payment API (Blink Payments)blinkpay-merchant-workspace
Data API (Blink Data)blinkpay-organisation-workspace

Getting Started

1. Download Collection and Environment

Visit the appropriate workspace above and download both the collection and sample environment files to your local Postman.

2. Configure Environment Variables

Get your credentials from the Client Portal under Settings > API Settings: open the environment's row, copy the API Client ID and select Rotate Secret to obtain the client secret (it is shown only once). See Getting API Credentials. Then update the environment variables:

VariableValue
base_urlSee environment URLs below
client_idYour OAuth client ID
client_secretYour OAuth client secret

Environment URLs:

APISandboxProduction
Payment APIhttps://sandbox.debit.blinkpay.co.nzhttps://debit.blinkpay.co.nz
Data APIhttps://sandbox.data.blinkpay.co.nzhttps://data.blinkpay.co.nz

3. Generate Access Token

  1. Run the Authentication > Generate access token request
  2. The access_token variable is automatically set
  3. Token is valid for 1 hour

Sandbox Testing

Use the mock bank "PNZ" for testing:

FlowCredentials
RedirectUsername: user01, Password: password
DecoupledPhone: +64-259531933 (auto-approves)

Any other mobile number is accepted but never authorises: the consent stays AwaitingAuthorisation until the bank's window ends, then becomes Rejected. To produce a decline, choose Cancel on the PNZ login page before logging in. To test revocation, authorise with the auto-approve number, then call the DELETE endpoint for the consent.