Go to home page
Docs
Search
/
Open Main Menu
Reference
Learn about core features
Centrapay Experiences
Payment Flows
Merchant-presented
Patron-presented
Digital Assets
Creating Test Money
Via API
Via Centrapay App
Third-party Asset
Defining a Payment Method
Uplink API Requirements
Uplink API Spec
Implementation Checklist
Creating Digital Tokens
Token Collection
Redemption Conditions
Implementation
Loading and Sending Assets
Sending Assets
Loading Giftcards
Example: Bulk distribution of Giftcards
Merchant Integrations
Payment Terminal
API Keys
Merchant Configs
Example Flows
Terminal Interface Guidelines
Integration Architecture
Mitigating Network Issues
Point of Sale
Core Requirements
Contact Us
Requesting Payment
Connecting With Patrons
Polling for Payment Confirmation
Protocol Extensions
Handling Payment Errors
QR Code Flow for Merchants
Barcode Flow for Merchants
Barcode Flow
Quick Pay Flow
Checking Barcode Details
Merchant Integration Error Handling
Respect Payment Status
Configure POS Timeout
Retry Unknown Errors
Resolving Persistent Errors
Transaction Reporting
Initiating Refunds
Refund Idempotency
Obtaining a Payment Request Id
Refund Error Handling
Line Items
Restrictions
Determining Paid For Line Items
Partial Payment
Partial Payment Flow
Implementation
See also
Payment Conditions
Implementation
Additional Behaviors
Requesting Pre Auth
Restrictions
Pre Auth Flow
Patron Not Present
eCommerce
App Integrations
Example OIDC Consumer
OIDC User Manager Configuration
Minimal OIDC Client Usage
Trigger Token Refresh
Detect OIDC User Refresh
OIDC Client Logout
Paying a Payment Request
Overview
Authenticating API calls on behalf of users
Payment Flow Overview
Payment Flow Implementation
Payment Extensions
Testing
Connections
For our partners
Farmlands
Farmlands Connection
Solutions
Farmlands POS Integration Guide
Centrapay Integration Benefits
Payment Flow Overview
Payment Flow Implementation
Testing Your Integration
Certification Requirements
Next Steps
Farmlands Portal Guide
Getting Started
Farmlands Authorisations
Releasing Funds
Authorisation History
Setting a Default Merchant
Manage My Centrapay Business Account
FAQs
Support
Farmlands Card Partner Support Guide
Support for Portal Users
Support for POS Integrators
SLA Support Level
API
For developers
Introduction
Auth
Authenticating API Calls
API Keys
User Access Tokens
Roles and Permissions
HTTP Status Codes
200 Ok
400 Malformed Request
401 Unauthorized
403 Forbidden
404 Route Not Found
429 Too Many Requests
5xx Server Error
Data Types
Timestamp
BigNumber
Monetary
CRN
Location
PhoneNumber
Pagination
Pagination Model
API Keys
API Key Model
Create an API Key
List API Keys
Update an API Key
Accounts
Accounts
Account Model
Subscription Model
Create an Account
Get an Account
Update an Account
Update Subscriptions
Account Memberships
Account Membership Model
Add Member
List members
Revoke Member
List Account Memberships for Authenticated Subject
List Account Memberships for a User
Businesses
Business Model
Tax Number Model
Create Business
Update Business
Get Business by Account Id
Search NZ Company Register
Get Business Details from NZ Company Register
Set Business Onboarding Status
Assets
Assets
Asset Model
Money Model
Gift Card Model
Token Model
Get Asset
Get Asset Summary
List Assets for Account
Archive Asset
Asset Transfers
Asset Transfer Model
Asset Transfer lifecycle
Request an Asset Transfer
Accept an Asset Transfer Request
Create an Asset Transfer
Get an Asset Transfer
Get Asset Transfer Summary
Claim Asset Transfer
Resolve Claimable Assets
List Asset Transfers
Cancel an Asset Transfer
Asset Types
External Assets
Load an External Asset
Tokens
Token Collection Model
Token Expires After Model
Redemption Condition Model
Allowed Products Model
Token Model
Create Token Collection
List Token Collections
Create Redemption Condition
Create Token
Wallets
Settlement Wallets
Wallet Model
Wallet Transaction Model
Create a Wallet
List Wallets
List Wallet Transactions
Asset Activities
Asset Activity Model
Asset Transaction Activity Model
Token Refunded Activity Model
Token Redeemed Activity Model
Asset Created Activity Model
Asset Received Activity Model
Asset Sent Activity Model
List Asset Transactions
List Asset Activities
Bank Accounts
Bank Accounts
Bank Account Model
Direct Debit Authority Model
Bank Account Approval Type Summary Model
Bank Account Balance Model
Create Bank Account
Add Direct Debit Authority to a Bank Account
Get Bank Account
Get Bank Account Balance
Verify Bank Account
List Bank Accounts
Set Preferred Bank Account Name
Archive Bank Account
Verify Bank Authority
List Bank Authorities
Create Bank Authority
Get Bank Authority
Bank Account Approvals
Bank Account Approval Model
Bank Account Approval Activity Model
Request Bank Account Approval
Get Bank Account Approval
Accept Bank Account Approval
Decline Bank Account Approval
List Bank Account Approvals
Bank Account Connection Intents
Bank Account Connection Intent Model
Create Bank Account Connection Intent
Authorize Bank Account Connection Intent
Funds Transfers
Get Top Up
List Top Ups For Authorized Accounts
List Top Ups For an Account
Create Withdrawal
Get Withdrawal
List Withdrawals for an Account
Abort Funds Transfer
Batches
Batch Model
Create Batch
Get Batch
Events
Events
Create Event
Centrapay Event Types
Integrations
Integrations
Integration Requests
Integration Request Model
Create an Integration Request
Get an Integration Request
Search Integration Requests
Configure Integration Request
Get Integration Request Configuration
Activate Integration Request
Delete Integration Request
Managed Integrations
Managed Integration Model
Invitation Summary Model
Params
Create or Update Managed Integration
Get Managed Integration
Invitations
Invitation Model
Params Model
Create Invitation
Get Invitation By Code
List Invitations by Account Id
Accept Invitation
Revoke Invitation
Loyalty Programs
Loyalty Programs
Loyalty Program Model
Create Loyalty Program
List Loyalty Programs by Account Id
Promotions
Promotion Model
Promotion Target Model
Promotion Reward Model
Promotion Condition Model
Create Promotion
List Promotions by Account
Media Uploads
Media Upload Model
Create a presigned URL for Media Upload
Get Media Upload Location
Merchants
Merchants
Merchant Model
Settlement Config Model
Refund Config Model
Merchant Search Result Model
Accepted Asset Model
Product Model
Create Merchant
Get Merchant
List Merchants for Account
Update Merchant
Set Merchant Onboarding Status
Search Merchants
List Merchants
Merchant Configs
Merchant Config Model
Payment Option Config Model
Create Merchant Config
Get Merchant Config
List Merchant Configs
Update Merchant Config
Payment Requests
Payment Requests
Payment Request Model
Payment Option Model
Accepted Collections
Payment Condition Model
Line Item Model
Product Classification
Paid By Model
Asset Totals
Payment Activity Model
Cancellation Reasons
Create a Payment Request
Get a Payment Request
Get a Payment Request by Short Code
Get a Payment Request linked to a Patron Code
Get Payment Request Summary
Pay a Payment Request
Refund a Payment Request
Void a Payment Request
Release Pre Auth funds
Confirm Pre Auth Payment Request
List Payment Activities for a Merchant
List Payment Activities for a Payment Request
Accept a Payment Condition
Decline a Payment Condition
Legacy Payment Requests
Payment Request Model
Payment Options Model
Paid By Model
Ledger and Authorization Values
Create a Payment Request
Get a Payment Request
Pay a Payment Request
Cancel a Payment Request
Void a Payment Request
Refund a Transaction
Webhooks
Profiles
Profile Model
Update Profile
Get Profile
Quotas
Quota Model
Get Account Quotas
Scanned Codes
Scanned Codes
Scanned Code Model
Decode Scanned Code
Patron Codes
Patron Code Model
Create Patron Code
Get Patron Code
Get Patron Code By Barcode
Settlements
Settlement Model
List Settlements
404
Page not found
Sorry, we couldn’t find the page you’re looking for.
Go back home
Contact support
Open support widget