From 7ce39534e71c591bc74836566e4d739288a05f76 Mon Sep 17 00:00:00 2001 From: AndyClifford <70119888+AndyClifford@users.noreply.github.com> Date: Mon, 29 Jul 2024 22:33:14 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=2056c22?= =?UTF-8?q?16e1da768659d2e539ea73ee3408c4a34af=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api/account-memberships/index.html | 2 +- api/accounts/index.html | 2 +- api/api-keys/index.html | 2 +- api/asset-activities/index.html | 2 +- api/asset-transfers/index.html | 2 +- api/assets/index.html | 2 +- api/bank-account-approvals/index.html | 2 +- api/bank-account-connection-intents/index.html | 2 +- api/bank-accounts/index.html | 2 +- api/batch-types/farmlands-external-asset/index.html | 2 +- api/batch-types/ticketek-ticket/index.html | 2 +- api/batch-types/verifone-terminal-status/index.html | 2 +- api/batches/index.html | 2 +- api/businesses/index.html | 12 +++++++----- api/events/index.html | 2 +- api/funds-transfers/index.html | 2 +- api/integration-requests/index.html | 2 +- api/invitations/index.html | 2 +- api/legacy-payment-requests/index.html | 2 +- api/loyalty-program-memberships/index.html | 2 +- api/loyalty-programs/index.html | 2 +- api/managed-integrations/index.html | 2 +- api/media-uploads/index.html | 2 +- api/merchant-configs/index.html | 2 +- api/merchants/index.html | 2 +- api/pagination/index.html | 2 +- api/patron-codes/index.html | 2 +- api/payment-requests/index.html | 2 +- api/profiles/index.html | 2 +- api/promotion-memberships/index.html | 2 +- api/promotions/index.html | 2 +- api/quotas/index.html | 2 +- api/scanned-codes/index.html | 2 +- api/settlements/index.html | 2 +- api/tokens/index.html | 2 +- api/wallets/index.html | 2 +- 36 files changed, 42 insertions(+), 40 deletions(-) diff --git a/api/account-memberships/index.html b/api/account-memberships/index.html index 1a003008c..21f8711d8 100644 --- a/api/account-memberships/index.html +++ b/api/account-memberships/index.html @@ -19,7 +19,7 @@
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs

Businesses

A Business represents a company registered with the New Zealand Companies Office. It is associated with a single Account  API .

+

Businesses

A Business represents a company registered with the New Zealand Companies Office. It is associated with a single Account  API .

Business Model

Attributes

  • nzbn

    stringrequired

    The unique NZBN identifier.

  • accountId

    string

    The Centrapay accountId.

  • test

    string

    The created Centrapay org account will have the test flag.

  • taxNumber

    object

    The value-added tax configuration.

Errors

  • INVALID_ACCOUNT

    403

    Account does not exist, is not authorized, is of the wrong type, or is not in the NZ region.

  • INVALID_NZBN

    403

    The NZBN provided does not match any NZ business.

Request
POST/api/businesses
curl -X POST \
+

  • INVALID_ACCOUNT

    403

    Account does not exist, is not authorized, is of the wrong type, or is not in the NZ region.

  • INVALID_NZBN

    403

    The NZBN provided does not match any NZ business.

  • BUSINESS_ALREADY_EXISTS

    403

    The account already has a business or there is already a business with the provided NZBN.

Request
POST/api/businesses
curl -X POST \
  https://service.centrapay.com/api/businesses \
  -H 'content-type: application/json' \
  -H 'x-api-key: <TOKEN>' \
@@ -157,7 +157,7 @@
 Collapse all

  • taxNumber

    object

    The value-added tax configuration.

  • farmlandsBusinessNumber

    string

    The number associated with your Farmlands business.

Errors

  • INVALID_ACCOUNT

    403

    Account does not exist, is not authorized, is of the wrong type, or is not in the NZ region.

  • INVALID_NZBN

    403

    The NZBN provided does not match any NZ business.

  • BUSINESS_ALREADY_EXISTS

    403

    The account already has a business or there is already a business with the provided NZBN.

Request
PUT/api/businesses/DKTs3U38hdhfEqwF1JKoT2
curl -X PUT \
+

  • INVALID_ACCOUNT

    403

    Account does not exist, is not authorized, is of the wrong type, or is not in the NZ region.

  • INVALID_NZBN

    403

    The NZBN provided does not match any NZ business.

Request
PUT/api/businesses/DKTs3U38hdhfEqwF1JKoT2
curl -X PUT \
  https://service.centrapay.com/api/businesses/DKTs3U38hdhfEqwF1JKoT2 \
  -H 'content-type: application/json' \
  -H 'x-api-key: <TOKEN>' \
@@ -264,7 +264,9 @@
 

 
POST/api/businesses/{businessId}/set-onboarding-status
Set Business Onboarding Status
This endpoint returns allows you to set the onboarding status of a Business.
Attributes
Request
POST/api/businesses/DKTs3U38hdhfEqwF1JKoT2/set-onboarding-status
curl -X POST \
+
Errors
  • BUSINESS_ALREADY_EXISTS
    403
    The account already has a business or there is already a business with the provided NZBN.
Request
POST/api/businesses/DKTs3U38hdhfEqwF1JKoT2/set-onboarding-status
curl -X POST \
  https://service.centrapay.com/api/businesses/DKTs3U38hdhfEqwF1JKoT2/set-onboarding-status \
  -H 'content-type: application/json' \
  -H 'x-api-key: <TOKEN>' \
diff --git a/api/events/index.html b/api/events/index.html
index 57b3c5274..cce3d75ce 100644
--- a/api/events/index.html
+++ b/api/events/index.html
@@ -19,7 +19,7 @@
 
 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs