Link Search Menu Expand Document



Authenticating API Calls

API calls can be authenticated by either providing an API key in the “X-Api-Key” header or by providing a user access token in the “Authorization” header.

Authenticate with API key

curl \
  -H "X-Api-Key: $api_key"

Authenticate with user access token

curl \
  -H "Authorization: $jwt"

API Keys

API Keys provide enduring access to a single Centrapay account.

The Centrapay test merchant API key is available to test creating payment requests: f32c5497297084e5354b47c40d5ccacb109ce483.

User Access Tokens

User access tokens provide time-limited access to all Centrapay accounts for which the user is a member. Access tokens are issued using OIDC code flow via the Centrapay OAuth authorization server and login page at

After successfully negotiating the OIDC code flow your application will have access to three tokens:

Id Token JWT containing user attributes such as id, phone and email.
Access Token JWT granting access to Centrapay APIs. Expires after 1 hour.
Refresh Token Token for OIDC token exchange. Expires after 60 days or when revoked.

A good starting point for learning more about OIDC is Okta’s OAuth OIDC Illustrated Guide.

When initiating a login request, a valid redirect URI must be provided. To obtain a dedicated OAuth client id with your application’s redirect URI(s) whitelisted please contact Centrapay support. Your callback URI can be for a website (such as “”) or mobile app (such as “com.example.yourapp://oidc-callback”).

Your application can use any OIDC client to negotiate the authentication flow but it must support OIDC authorization code flow with PKCE. See the Example OIDC Consumer guide for a working example using the “oidc-client” JavaScript library. The Centrapay authorization server configuration can be interrogated via

When handling the OIDC callback, browser based applications should slurp the callback parameters by performing a location.replace() so they are not available in the browser’s location bar or browsing history. If your application needs to talk directly to from a browser then it will also need to be whitelisted for cross-origin requests.


The following table lists the claims which may be be included in a user id token. At minimum, the “sub” claim and one of “phone_number” or “email” will be present.

Name Description
sub Centrapay user id
email email address
phone_number phone number
given_name given name(s)
family_name surname
preferred_username Centrapay user handle
phone_number_verified phone number has been verified (can be used for account recovery)
email_verified email has been verified (can be used for account recovery)

Roles and Permissions

Users and API keys are assigned a role for their associated Centrapay account(s). The permissions granted to the roles are shown in the table below.

Most permissions apply only to resources owned by the associated account. Some permissions, such as payment-requests:pay, apply globally to all resources regardless of the account the resource belongs to. The global permissions are indicated below with a star (✸).

Account Flags

Some permissions require an additional flag associated to their individual account or the targeted account that owns the resource (they may be the same account). For each permission, if there is a flag associated to it then at least one of them must be met.

Symbol Description
👤 A trusted user flag on the individual account, obtained by verifying a NZ phone number.
🧀 An external-asset-issuer subscription on the targeted Account, obtained by contacting centrapay.
🗄 The targeted account must be of type org.


Permission Account Owner Anon Consumer Merchant Terminal External Asset Provider
accounts:create    ✅      
accounts:read    ✅    
accounts:update    ✅      
business:create    ✅      
business:read    ✅      
quotas:read    ✅      
api-keys:create    ✅      
api-keys:update    ✅      
api-keys:list    ✅      
merchants:create 🗄    ✅      
merchants:read 🗄    ✅      
merchants:update 🗄    ✅      
merchants:list 🗄    ✅      
payment-requests:create 🗄         ✅  
payment-requests:read ✸ ✅ ✸ ✅ ✸ ✅  
payment-requests:pay 🗄 ✸ ✅ ✸ ✅     ✅  
payment-requests:cancel 🗄         ✅  
payment-requests:refund 🗄         ✅  
payment-requests:void 🗄         ✅  
payment-activities:read    ✅      
assets:read    ✅    
assets:spend 👤    ✅      
wallets:transfer 👤    ✅      
wallets:withdraw    ✅      
wallets:deposit    ✅      
wallets:create    ✅      
wallets:read    ✅      
asset-transfers:create 👤 🧀    ✅    
asset-transfers:read    ✅    
asset-transfers:claim    ✅    
bank-accounts:create    ✅      
bank-accounts:read    ✅      
bank-account-approvals:create    ✅      
media-uploads:create    ✅      
quotas:read    ✅      
patron-codes:create    ✅      
patron-codes:read    ✅       ✅  
integration-requests:read 🗄    ✅      
integration-requests:create 🗄    ✅      
external-assets:create 👤 🧀    ✅    
external-assets:update    ✅    
topups:create 👤    ✅      
topups:read    ✅