diff --git a/src/components/CodeGroup.astro b/src/components/CodeGroup.astro
deleted file mode 100644
index d16fb0883..000000000
--- a/src/components/CodeGroup.astro
+++ /dev/null
@@ -1,3 +0,0 @@
-
-
-
diff --git a/src/content/api/account-memberships.mdx b/src/content/api/account-memberships.mdx
index 9ca5382da..925826859 100644
--- a/src/content/api/account-memberships.mdx
+++ b/src/content/api/account-memberships.mdx
@@ -9,7 +9,6 @@ nav:
import Properties from '../../components/Properties.astro';
import Property from '../../components/Property.astro';
import Endpoint from '../../components/Endpoint.astro';
-import CodeGroup from '../../components/CodeGroup.astro';
import Badge from '../../components/Badge.astro';
import CodePanel from '../../components/CodePanel.astro';
@@ -102,34 +101,32 @@ A Member contains extended information about a user's access to an account.
-
-
- ```bash
- curl -X POST https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/members \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "userId": "da75ad90-9a5b-4df0-8374-f48b3a8fbfcc",
- "role": "account-owner"
- }'
- ```
-
-
-
- ```json
- {
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "accountType": "org",
+
+ ```bash
+ curl -X POST https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/members \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
"userId": "da75ad90-9a5b-4df0-8374-f48b3a8fbfcc",
- "role": "account-owner",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "createdAt": "2020-06-12T01:17:46.499Z",
- "modifiedAt": "2020-06-12T01:17:46.499Z",
- "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
- }
- ```
-
-
+ "role": "account-owner"
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "accountType": "org",
+ "userId": "da75ad90-9a5b-4df0-8374-f48b3a8fbfcc",
+ "role": "account-owner",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "modifiedAt": "2020-06-12T01:17:46.499Z",
+ "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
+ }
+ ```
+
---
@@ -145,43 +142,41 @@ A Member contains extended information about a user's access to an account.
### Attributes
No attributes.
-
-
- ```bash
- curl https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/members \
- -H "X-Api-Key: $api_key"
- ```
-
+
+ ```bash
+ curl https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/members \
+ -H "X-Api-Key: $api_key"
+ ```
+
-
- ```json
- [
- {
- "accountName": "Centrapay Cafe",
- "accountType": "org",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "userId": "b657195e-dc2f-11ea-8566-e7710d592c99",
- "createdAt": "2020-06-01T21:57:25.888Z",
- "role": "account-owner",
- "firstName": "John",
- "lastName": "Doe",
- "email": "john.doe@centrapay.com"
- },
- {
- "accountName": "Centrapay Tea Warehouse",
- "accountType": "org",
- "accountId": "0f9nvqdcn5eaaDLefkg1Xt",
- "userId": "9f4b3bae-dc30-11ea-ab70-2743d9be3dd5",
- "createdAt": "2020-06-02T10:l4:33.021Z",
- "role": "account-owner",
- "firstName": "Jane",
- "lastName": "Doe",
- "email": "jane.doe@centrapay.com"
- }
- ]
- ```
-
-
+
+ ```json
+ [
+ {
+ "accountName": "Centrapay Cafe",
+ "accountType": "org",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "userId": "b657195e-dc2f-11ea-8566-e7710d592c99",
+ "createdAt": "2020-06-01T21:57:25.888Z",
+ "role": "account-owner",
+ "firstName": "John",
+ "lastName": "Doe",
+ "email": "john.doe@centrapay.com"
+ },
+ {
+ "accountName": "Centrapay Tea Warehouse",
+ "accountType": "org",
+ "accountId": "0f9nvqdcn5eaaDLefkg1Xt",
+ "userId": "9f4b3bae-dc30-11ea-ab70-2743d9be3dd5",
+ "createdAt": "2020-06-02T10:l4:33.021Z",
+ "role": "account-owner",
+ "firstName": "Jane",
+ "lastName": "Doe",
+ "email": "jane.doe@centrapay.com"
+ }
+ ]
+ ```
+
---
@@ -202,14 +197,12 @@ A Member contains extended information about a user's access to an account.
| :----- | :----------------------- | :------------------------------------------------------------- |
| 403 | LAST_OWNER_NOT_REVOKABLE | The last remaining membership to an account cannot be revoked. |
-
-
- ```bash
- curl -X DELETE https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/members/45dwes-rf4h55-tyf45s-6st4gd \
- -H "X-Api-Key: $api_key"
- ```
-
-
+
+ ```bash
+ curl -X DELETE https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/members/45dwes-rf4h55-tyf45s-6st4gd \
+ -H "X-Api-Key: $api_key"
+ ```
+
---
@@ -225,27 +218,25 @@ A Member contains extended information about a user's access to an account.
### Attributes
No attributes.
-
-
- ```bash
- curl https://service.centrapay.com/api/account-memberships \
- -H "X-Api-Key: $api_key"
- ```
-
+
+ ```bash
+ curl https://service.centrapay.com/api/account-memberships \
+ -H "X-Api-Key: $api_key"
+ ```
+
-
- ```json
- [
- {
- "accountName": "Centrapay Tea Warehouse",
- "accountId": "5uooxSens6ykJaim1Cu1Q5",
- "accountType": "org",
- "role": "account-owner"
- }
- ]
- ```
-
-
+
+ ```json
+ [
+ {
+ "accountName": "Centrapay Tea Warehouse",
+ "accountId": "5uooxSens6ykJaim1Cu1Q5",
+ "accountType": "org",
+ "role": "account-owner"
+ }
+ ]
+ ```
+
---
@@ -261,31 +252,29 @@ A Member contains extended information about a user's access to an account.
### Attributes
No attributes.
-
-
- ```bash
- curl https://service.centrapay.com/api/users/1234/account-memberships \
- -H "X-Api-Key: $api_key"
- ```
-
+
+ ```bash
+ curl https://service.centrapay.com/api/users/1234/account-memberships \
+ -H "X-Api-Key: $api_key"
+ ```
+
-
- ```json
- [
- {
- "accountName": "Centrapay Cafe",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "accountType": "org",
- "role": "account-owner"
- },
- {
- "accountName": "Centrapay Tea Warehouse",
- "accountId": "5uooxSens6ykJaim1Cu1Q5",
- "accountType": "org",
- "role": "account-owner"
- }
- ]
- ```
-
-
+
+ ```json
+ [
+ {
+ "accountName": "Centrapay Cafe",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "accountType": "org",
+ "role": "account-owner"
+ },
+ {
+ "accountName": "Centrapay Tea Warehouse",
+ "accountId": "5uooxSens6ykJaim1Cu1Q5",
+ "accountType": "org",
+ "role": "account-owner"
+ }
+ ]
+ ```
+
diff --git a/src/content/api/accounts.mdx b/src/content/api/accounts.mdx
index 714136ddc..1267f8e42 100644
--- a/src/content/api/accounts.mdx
+++ b/src/content/api/accounts.mdx
@@ -9,7 +9,6 @@ nav:
import Properties from '../../components/Properties.astro';
import Property from '../../components/Property.astro';
import Endpoint from '../../components/Endpoint.astro';
-import CodeGroup from '../../components/CodeGroup.astro';
import CodePanel from '../../components/CodePanel.astro';
An Account represents a permission boundary around Centrapay resources.
@@ -108,36 +107,34 @@ individual account.
-
-
- ```bash
- curl -X POST https://service.centrapay.com/api/accounts \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "name": "Centrapay Cafe",
- "type": "org"
- }'
- ```
-
-
-
- ```json
- {
- "id": "Jaim1Cu1Q55uooxSens6yk",
+
+ ```bash
+ curl -X POST https://service.centrapay.com/api/accounts \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
"name": "Centrapay Cafe",
- "type": "org",
- "region": "NZ",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "createdAt": "2020-06-12T01:17:46.499Z",
- "modifiedAt": "2020-06-12T01:17:46.499Z",
- "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "version": "1",
- "subscriptions": [],
- }
- ```
-
-
+ "type": "org"
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "id": "Jaim1Cu1Q55uooxSens6yk",
+ "name": "Centrapay Cafe",
+ "type": "org",
+ "region": "NZ",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "modifiedAt": "2020-06-12T01:17:46.499Z",
+ "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "version": "1",
+ "subscriptions": [],
+ }
+ ```
+
@@ -154,31 +151,29 @@ individual account.
### Attributes
No attributes.
-
-
- ```bash
- curl https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk \
- -H "X-Api-Key: $api_key"
- ```
-
-
-
- ```json
- {
- "id": "Jaim1Cu1Q55uooxSens6yk",
- "name": "Centrapay Cafe",
- "type": "org",
- "region": "NZ",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "createdAt": "2020-06-12T01:17:46.499Z",
- "modifiedAt": "2020-06-12T01:17:46.499Z",
- "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "version": "1",
- "subscriptions": [],
- }
- ```
-
-
+
+ ```bash
+ curl https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk \
+ -H "X-Api-Key: $api_key"
+ ```
+
+
+
+ ```json
+ {
+ "id": "Jaim1Cu1Q55uooxSens6yk",
+ "name": "Centrapay Cafe",
+ "type": "org",
+ "region": "NZ",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "modifiedAt": "2020-06-12T01:17:46.499Z",
+ "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "version": "1",
+ "subscriptions": [],
+ }
+ ```
+
@@ -199,35 +194,33 @@ individual account.
-
-
- ```bash
- curl -X PUT https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "name": "Shortland St Cafe"
- }'
- ```
-
-
-
- ```json
- {
- "id": "Jaim1Cu1Q55uooxSens6yk",
- "name": "Shortland St Cafe",
- "type": "org",
- "region": "NZ",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "createdAt": "2020-06-12T01:17:46.499Z",
- "modifiedAt": "2020-06-12T02:35:12.112Z",
- "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "version": "2",
- "subscriptions": [],
- }
- ```
-
-
+
+ ```bash
+ curl -X PUT https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
+ "name": "Shortland St Cafe"
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "id": "Jaim1Cu1Q55uooxSens6yk",
+ "name": "Shortland St Cafe",
+ "type": "org",
+ "region": "NZ",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "modifiedAt": "2020-06-12T02:35:12.112Z",
+ "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "version": "2",
+ "subscriptions": [],
+ }
+ ```
+
@@ -248,28 +241,26 @@ individual account.
-
-
- ```bash
- curl -X PUT https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/subscriptions \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "subscriptions": [
- "quartz"
- ]
- }'
- ```
-
-
-
- ```json
- {
- "subscriptions": [ "quartz" ]
- }
- ```
-
-
+
+ ```bash
+ curl -X PUT https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/subscriptions \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
+ "subscriptions": [
+ "quartz"
+ ]
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "subscriptions": [ "quartz" ]
+ }
+ ```
+
### Errors
| Status | Code | Description |
diff --git a/src/content/api/api-keys.mdx b/src/content/api/api-keys.mdx
index 7946b1860..af92bf1e9 100644
--- a/src/content/api/api-keys.mdx
+++ b/src/content/api/api-keys.mdx
@@ -9,7 +9,6 @@ nav:
import Properties from '../../components/Properties.astro';
import Property from '../../components/Property.astro';
import Endpoint from '../../components/Endpoint.astro';
-import CodeGroup from '../../components/CodeGroup.astro';
import CodePanel from '../../components/CodePanel.astro';
API keys provide enduring access to a single Centrapay [Account](https://docs.centrapay.com/api/accounts).
@@ -78,36 +77,34 @@ API keys provide enduring access to a single Centrapay [Account](https://docs.ce
-
-
- ```bash
- curl -X POST https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "name": "MyAPIkey",
- "role": "merchant-terminal"
- }'
- ```
-
-
-
- ```bash
- {
+
+ ```bash
+ curl -X POST https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
"name": "MyAPIkey",
- "createdAt": "2020-06-01T22:32:56.631Z",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
- "modifiedAt": "2020-06-01T22:32:56.631Z",
- "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
- "enabled": true,
- "role": "merchant-terminal",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "version": "1",
- "secret": "EoaEL7skkedBBy9MzrBSyxG95vUAKjYkiFvWEfiAx"
- }
- ```
-
-
+ "role": "merchant-terminal"
+ }'
+ ```
+
+
+
+ ```bash
+ {
+ "name": "MyAPIkey",
+ "createdAt": "2020-06-01T22:32:56.631Z",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
+ "modifiedAt": "2020-06-01T22:32:56.631Z",
+ "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
+ "enabled": true,
+ "role": "merchant-terminal",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "version": "1",
+ "secret": "EoaEL7skkedBBy9MzrBSyxG95vUAKjYkiFvWEfiAx"
+ }
+ ```
+
---
@@ -124,43 +121,41 @@ API keys provide enduring access to a single Centrapay [Account](https://docs.ce
### Attributes
No attributes.
-
-
- ```bash
- curl -X GET https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \
- -H "X-Api-Key: $api_key"
- ```
-
-
-
- ```bash
- [
- {
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "name": "MyOtherAPIkey",
- "createdAt": "2020-06-01T21:57:25.888Z",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
- "modifiedAt": "2020-06-01T21:57:25.888Z",
- "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
- "enabled": false,
- "version": "1",
- "role": "merchant-terminal"
- },
- {
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "name": "MyAPIkey",
- "createdAt": "2020-06-01T22:34:31.308Z",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
- "modifiedAt": "2020-06-01T22:34:31.308Z",
- "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
- "enabled": true,
- "version": "1",
- "role": "merchant-terminal"
- }
- ]
- ```
-
-
+
+ ```bash
+ curl -X GET https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \
+ -H "X-Api-Key: $api_key"
+ ```
+
+
+
+ ```bash
+ [
+ {
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "name": "MyOtherAPIkey",
+ "createdAt": "2020-06-01T21:57:25.888Z",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
+ "modifiedAt": "2020-06-01T21:57:25.888Z",
+ "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
+ "enabled": false,
+ "version": "1",
+ "role": "merchant-terminal"
+ },
+ {
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "name": "MyAPIkey",
+ "createdAt": "2020-06-01T22:34:31.308Z",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
+ "modifiedAt": "2020-06-01T22:34:31.308Z",
+ "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
+ "enabled": true,
+ "version": "1",
+ "role": "merchant-terminal"
+ }
+ ]
+ ```
+
---
@@ -181,32 +176,30 @@ API keys provide enduring access to a single Centrapay [Account](https://docs.ce
-
-
- ```bash [Request]
- curl -X PUT https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys/MyAPIkey \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "enabled": false
- }'
+
+ ```bash [Request]
+ curl -X PUT https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys/MyAPIkey \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
+ "enabled": false
+ }'
+ ```
+
+
+
+ ```bash
+ {
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "name": "MyAPIkey",
+ "createdAt": "2020-06-01T22:34:31.308Z",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
+ "modifiedAt": "2020-07-02T22:34:31.308Z",
+ "modifiedBy": "crn:Jaim1Cu1Q55uooxSens6yk:api-key:MyAPIkey",
+ "enabled": false,
+ "version": "2",
+ "role": "merchant-terminal"
+ }
```
-
-
-
- ```bash
- {
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "name": "MyAPIkey",
- "createdAt": "2020-06-01T22:34:31.308Z",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:AdminKey",
- "modifiedAt": "2020-07-02T22:34:31.308Z",
- "modifiedBy": "crn:Jaim1Cu1Q55uooxSens6yk:api-key:MyAPIkey",
- "enabled": false,
- "version": "2",
- "role": "merchant-terminal"
- }
- ```
-
-
+
diff --git a/src/content/api/bank-account-connection-intents.mdx b/src/content/api/bank-account-connection-intents.mdx
index 43c5caa8a..fc64a3c58 100644
--- a/src/content/api/bank-account-connection-intents.mdx
+++ b/src/content/api/bank-account-connection-intents.mdx
@@ -4,19 +4,20 @@ description: Bank Account Connection Intent model and related endpoints
draft: true
nav:
path: API
- order: 17
+ order: 18
---
import Properties from '../../components/Properties.astro';
import Property from '../../components/Property.astro';
import Endpoint from '../../components/Endpoint.astro';
-import CodeGroup from '../../components/CodeGroup.astro';
+import CodePanel from '../../components/CodePanel.astro';
import Badge from '../../components/Badge.astro';
A Bank Account Connection Intent facilitates user authorization of access to Bank Accounts, for example, using Open Banking flows. Typically the authorization will follow an OAuth flow where the user is redirected to a third-party system to authenticate and select one or more bank accounts.
-## Bank Account Connection Intent Model
+---
+
+## Model
-### Attributes
The Bank Account Connection Intent's unique identifier.
@@ -102,7 +103,7 @@ A Bank Account Connection Intent facilitates user authorization of access to Ban
-
+
```bash
curl -X POST https://service.centrapay.com/api/bank-account-connection-intents \
-H "X-Api-Key: $api_key" \
@@ -113,7 +114,9 @@ A Bank Account Connection Intent facilitates user authorization of access to Ban
"test": true
}'
```
+
+
```json
{
"id": "3KVjuKW2CZCJeJVqPxwkX7",
@@ -128,7 +131,7 @@ A Bank Account Connection Intent facilitates user authorization of access to Ban
"test": true
}
```
-
+
---
@@ -148,7 +151,7 @@ A Bank Account Connection Intent facilitates user authorization of access to Ban
-
+
```bash
curl -X POST https://service.centrapay.com/api/bank-account-connection-intents/3KVjuKW2CZCJeJVqPxwkX7/authorize \
-H "X-Api-Key: $api_key" \
@@ -157,9 +160,11 @@ A Bank Account Connection Intent facilitates user authorization of access to Ban
"code": "hKpKupTM391pE10xfQiorMxXarRKAHRhTfH_x"
}'
```
+
+
```json
{}
```
-
+
diff --git a/src/content/api/bank-accounts.mdx b/src/content/api/bank-accounts.mdx
index a6d7a06a1..6011641ac 100644
--- a/src/content/api/bank-accounts.mdx
+++ b/src/content/api/bank-accounts.mdx
@@ -9,7 +9,6 @@ nav:
import Properties from '../../components/Properties.astro';
import Property from '../../components/Property.astro';
import Endpoint from '../../components/Endpoint.astro';
-import CodeGroup from '../../components/CodeGroup.astro';
import Badge from '../../components/Badge.astro';
import CodePanel from '../../components/CodePanel.astro';
@@ -203,45 +202,43 @@ The Bank Account balance, retrieved using Open Banking flows. The supported Bank
| 403 | BANK_ACCOUNT_HOLDER_LIMIT_EXCEEDED | The global maximum Bank Accounts for the provided Bank Account number has been reached. |
| 403 | DUPLICATE_BANK_ACCOUNT | The Centrapay account already holds this Bank Account. |
-
-
- ```bash
- curl -X POST https://service.centrapay.com/api/bank-accounts \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "bankAccountNumber": "12-1234-1234567-123",
- "bankAccountName": "John Doe",
- "directDebitAuthority": {
- "phoneNumber": "+64212345678",
- "fullName": "John Doe",
- "emailAddress": "john.doe@gmail.com"
- }
- }'
- ```
-
-
-
- ```json
- {
- "id": "WRhAxxWpTKb5U7pXyxQjjY",
+
+ ```bash
+ curl -X POST https://service.centrapay.com/api/bank-accounts \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
"accountId": "Jaim1Cu1Q55uooxSens6yk",
"bankAccountNumber": "12-1234-1234567-123",
"bankAccountName": "John Doe",
- "directDebitAuthorized": true,
- "status": "created",
- "verified": false,
- "type": "centrapay",
- "createdAt": "2020-06-12T01:17:46.499Z",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "modifiedAt": "2020-06-12T01:17:46.499Z",
- "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "approvals": []
- }
- ```
-
-
+ "directDebitAuthority": {
+ "phoneNumber": "+64212345678",
+ "fullName": "John Doe",
+ "emailAddress": "john.doe@gmail.com"
+ }
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "id": "WRhAxxWpTKb5U7pXyxQjjY",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "bankAccountNumber": "12-1234-1234567-123",
+ "bankAccountName": "John Doe",
+ "directDebitAuthorized": true,
+ "status": "created",
+ "verified": false,
+ "type": "centrapay",
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "modifiedAt": "2020-06-12T01:17:46.499Z",
+ "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "approvals": []
+ }
+ ```
+
@@ -276,40 +273,38 @@ The Bank Account balance, retrieved using Open Banking flows. The supported Bank
| 403 | DIRECT_DEBIT_ALREADY_AUTHORIZED | This bank authority cannot be changed as all fields have been set. |
| 403 | DIRECT_DEBIT_LIMIT_EXCEEDED | The Centrapay account already has the max amount of directDebitAuthorized enabled Bank Accounts. |
-
-
- ```bash
- curl -X POST https://service.centrapay.com/api/bank-accounts/WRhAxxWpTKb5U7pXyxQjjY/direct-debit-authorities \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "phoneNumber": "+64212345678",
- "fullName": "John Doe",
- "emailAddress": "john@doe.org"
- }'
- ```
-
-
-
- ```json
- {
- "id": "WRhAxxWpTKb5U7pXyxQjjY",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "bankAccountNumber": "12-1234-1234567-123",
- "bankAccountName": "John Doe",
- "directDebitAuthorized": true,
- "status": "created",
- "verified": false,
- "type": "centrapay",
- "createdAt": "2020-06-12T01:17:46.499Z",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "modifiedAt": "2020-06-12T01:17:46.499Z",
- "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "approvals": []
- }
- ```
-
-
+
+ ```bash
+ curl -X POST https://service.centrapay.com/api/bank-accounts/WRhAxxWpTKb5U7pXyxQjjY/direct-debit-authorities \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
+ "phoneNumber": "+64212345678",
+ "fullName": "John Doe",
+ "emailAddress": "john@doe.org"
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "id": "WRhAxxWpTKb5U7pXyxQjjY",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "bankAccountNumber": "12-1234-1234567-123",
+ "bankAccountName": "John Doe",
+ "directDebitAuthorized": true,
+ "status": "created",
+ "verified": false,
+ "type": "centrapay",
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "modifiedAt": "2020-06-12T01:17:46.499Z",
+ "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "approvals": []
+ }
+ ```
+
@@ -326,42 +321,40 @@ The Bank Account balance, retrieved using Open Banking flows. The supported Bank
### Attributes
No attributes.
-
-
- ```bash
- curl https://service.centrapay.com/api/bank-accounts/d4a7cbd6818a87c51b97 \
- -H "X-Api-Key: $api_key"
- ```
-
-
-
- ```json
- {
- "id": "d4a7cbd6818a87c51b97",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "status": "created",
- "bankAccountNumber": "12-1234-1234567-123",
- "bankAccountName": "John Doe",
- "directDebitAuthorized": false,
- "bankRegion": "nz",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "createdAt": "2022-07-18T02:26:39.477Z",
- "verified": false,
- "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "modifiedAt": "2022-07-18T02:26:39.477Z",
- "approvals": [
- {
- "type": "account-consent",
- "status": "approved",
- "updatedAt": "2021-11-08T21:52:39.915Z"
- }
- ],
- "type": "quartz",
- "test": true,
- }
- ```
-
-
+
+ ```bash
+ curl https://service.centrapay.com/api/bank-accounts/d4a7cbd6818a87c51b97 \
+ -H "X-Api-Key: $api_key"
+ ```
+
+
+
+ ```json
+ {
+ "id": "d4a7cbd6818a87c51b97",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "status": "created",
+ "bankAccountNumber": "12-1234-1234567-123",
+ "bankAccountName": "John Doe",
+ "directDebitAuthorized": false,
+ "bankRegion": "nz",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "createdAt": "2022-07-18T02:26:39.477Z",
+ "verified": false,
+ "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "modifiedAt": "2022-07-18T02:26:39.477Z",
+ "approvals": [
+ {
+ "type": "account-consent",
+ "status": "approved",
+ "updatedAt": "2021-11-08T21:52:39.915Z"
+ }
+ ],
+ "type": "quartz",
+ "test": true,
+ }
+ ```
+
@@ -384,24 +377,22 @@ The Bank Account balance, retrieved using Open Banking flows. The supported Bank
| 403 | BANK_BALANCE_NOT_SUPPORTED | The [Bank Account Type][] does not support retrieval of a balance using Open Banking flows. |
| 403 | BANK_AUTHORIZATION_INVALID | The access token to retrieve the [Bank Account Balance][] is no longer valid. |
-
-
- ```bash
- curl https://service.centrapay.com/api/bank-accounts/d4a7cbd6818a87c51b97/balance \
- -H "X-Api-Key: $api_key"
- ```
-
-
-
- ```json
- {
- "bankAccountId": "d4a7cbd6818a87c51b97",
- "balance": 1000,
- "currency": "NZD"
- }
- ```
-
-
+
+ ```bash
+ curl https://service.centrapay.com/api/bank-accounts/d4a7cbd6818a87c51b97/balance \
+ -H "X-Api-Key: $api_key"
+ ```
+
+
+
+ ```json
+ {
+ "bankAccountId": "d4a7cbd6818a87c51b97",
+ "balance": 1000,
+ "currency": "NZD"
+ }
+ ```
+
@@ -430,26 +421,24 @@ The Bank Account balance, retrieved using Open Banking flows. The supported Bank
| 403 | BANK_ACCOUNT_VERIFICATION_ATTEMPTS_EXCEEDED | The bank account's maximum failed verification attempts has been reached. |
| 403 | ACCOUNT_MISMATCH | The top up / withdrawal and the bank account do not belong to the same account. |
-
-
- ```bash
- curl -X POST https://service.centrapay.com/api/bank-accounts/WRhAxxWpTKb5U7pXyxQjjY/verify \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "verificationCode": "1111"
- }'
- ```
-
-
-
- ```json
- {
+
+ ```bash
+ curl -X POST https://service.centrapay.com/api/bank-accounts/WRhAxxWpTKb5U7pXyxQjjY/verify \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
"verificationCode": "1111"
- }
- ```
-
-
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "verificationCode": "1111"
+ }
+ ```
+
@@ -478,26 +467,24 @@ The Bank Account balance, retrieved using Open Banking flows. The supported Bank
| 403 | BANK_ACCOUNT_VERIFICATION_ATTEMPTS_EXCEEDED | The bank account's maximum failed verification attempts has been reached. |
| 403 | ACCOUNT_MISMATCH | The top up / withdrawal and the bank account do not belong to the same account. |
-
-
- ```bash
- curl -X POST https://service.centrapay.com/api/bank-authorities/WRhAxxWpTKb5U7pXyxQjjY/verify \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "verificationCode": "1111"
- }'
- ```
-
-
-
- ```json
- {
+
+ ```bash
+ curl -X POST https://service.centrapay.com/api/bank-authorities/WRhAxxWpTKb5U7pXyxQjjY/verify \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
"verificationCode": "1111"
- }
- ```
-
-
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "verificationCode": "1111"
+ }
+ ```
+
@@ -514,62 +501,60 @@ The Bank Account balance, retrieved using Open Banking flows. The supported Bank
### Attributes
No attributes.
-
-
- ```bash
- curl https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/bank-accounts \
- -H "X-Api-Key: $api_key"
- ```
-
-
-
- ```json
- [
- {
- "id": "XZbPLViMzekVBbF7QMqgaY",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "status": "created",
- "bankAccountNumber": "02-0500-0568903-097",
- "bankAccountName": "Pocket Money",
- "directDebitAuthorized": false,
- "bankRegion": "nz",
- "createdBy": "crn::user:57142ecc-e5e4-456a-8312-1fad4fdef3c7",
- "createdAt": "2022-04-19T05:43:40.425Z",
- "verified": false,
- "modifiedBy": "crn::user:57142ecc-e5e4-456a-8312-1fad4fdef3c7",
- "modifiedAt": "2022-04-19T05:43:40.425Z",
- "approvals": [
-
- ],
- "type": "quartz",
- "test": true
- },
- {
- "id": "3Kfdm8cuW1W6f8AoWJREs4",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "status": "created",
- "bankAccountNumber": "00-1213-1231299-999",
- "bankAccountName": "Jean",
- "directDebitAuthorized": false,
- "bankRegion": "nz",
- "createdBy": "crn::user:57142ecc-e5e4-456a-8312-1fad4fdef3c7",
- "createdAt": "2022-02-22T03:27:57.138Z",
- "verified": false,
- "modifiedBy": "crn::user:57142ecc-e5e4-456a-8312-1fad4fdef3c7",
- "modifiedAt": "2022-02-22T03:27:57.138Z",
- "approvals": [
- {
- "type": "settlement",
- "status": "pending",
- "updatedAt": "2021-11-08T21:52:39.915Z"
- }
- ],
- "type": "centrapay"
- }
- ]
- ```
-
-
+
+ ```bash
+ curl https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/bank-accounts \
+ -H "X-Api-Key: $api_key"
+ ```
+
+
+
+ ```json
+ [
+ {
+ "id": "XZbPLViMzekVBbF7QMqgaY",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "status": "created",
+ "bankAccountNumber": "02-0500-0568903-097",
+ "bankAccountName": "Pocket Money",
+ "directDebitAuthorized": false,
+ "bankRegion": "nz",
+ "createdBy": "crn::user:57142ecc-e5e4-456a-8312-1fad4fdef3c7",
+ "createdAt": "2022-04-19T05:43:40.425Z",
+ "verified": false,
+ "modifiedBy": "crn::user:57142ecc-e5e4-456a-8312-1fad4fdef3c7",
+ "modifiedAt": "2022-04-19T05:43:40.425Z",
+ "approvals": [
+
+ ],
+ "type": "quartz",
+ "test": true
+ },
+ {
+ "id": "3Kfdm8cuW1W6f8AoWJREs4",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "status": "created",
+ "bankAccountNumber": "00-1213-1231299-999",
+ "bankAccountName": "Jean",
+ "directDebitAuthorized": false,
+ "bankRegion": "nz",
+ "createdBy": "crn::user:57142ecc-e5e4-456a-8312-1fad4fdef3c7",
+ "createdAt": "2022-02-22T03:27:57.138Z",
+ "verified": false,
+ "modifiedBy": "crn::user:57142ecc-e5e4-456a-8312-1fad4fdef3c7",
+ "modifiedAt": "2022-02-22T03:27:57.138Z",
+ "approvals": [
+ {
+ "type": "settlement",
+ "status": "pending",
+ "updatedAt": "2021-11-08T21:52:39.915Z"
+ }
+ ],
+ "type": "centrapay"
+ }
+ ]
+ ```
+
@@ -586,51 +571,49 @@ The Bank Account balance, retrieved using Open Banking flows. The supported Bank
### Attributes
No attributes.
-
-
- ```bash
- curl https://service.centrapay.com/api/bank-authorities \
- -H "X-Api-Key: $api_key"
- ```
-
-
-
- ```json
- [
- {
- "id": "WRhAxxWpTKb5U7pXyxQjjY",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "bankAccountNumber": "12-1234-1234567-123",
- "bankAccountName": "John Doe",
- "status": "created",
- "verified": false,
- "directDebitAuthorized": true,
- "createdAt": "2020-06-12T01:17:46.499Z",
- "approvals": [
-
- ]
- },
- {
- "id": "b5URhAxxWpTKyxQjjY7pXW",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "bankAccountNumber": "12-1234-1234567-123",
- "bankAccountName": "Jane Doe",
- "status": "active",
- "verified": true,
- "directDebitAuthorized": true,
- "createdAt": "2020-06-12T01:17:46.499Z",
- "approvals": [
- {
- "type": "settlement",
- "status": "pending",
- "updatedAt": "2021-11-08T21:52:39.915Z"
- }
- ]
- }
- ]
- ```
-
-
+
+ ```bash
+ curl https://service.centrapay.com/api/bank-authorities \
+ -H "X-Api-Key: $api_key"
+ ```
+
+
+
+ ```json
+ [
+ {
+ "id": "WRhAxxWpTKb5U7pXyxQjjY",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "bankAccountNumber": "12-1234-1234567-123",
+ "bankAccountName": "John Doe",
+ "status": "created",
+ "verified": false,
+ "directDebitAuthorized": true,
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "approvals": [
+
+ ]
+ },
+ {
+ "id": "b5URhAxxWpTKyxQjjY7pXW",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "bankAccountNumber": "12-1234-1234567-123",
+ "bankAccountName": "Jane Doe",
+ "status": "active",
+ "verified": true,
+ "directDebitAuthorized": true,
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "approvals": [
+ {
+ "type": "settlement",
+ "status": "pending",
+ "updatedAt": "2021-11-08T21:52:39.915Z"
+ }
+ ]
+ }
+ ]
+ ```
+
@@ -679,42 +662,40 @@ The Bank Account balance, retrieved using Open Banking flows. The supported Bank
| 403 | BANK_AUTHORITY_LIMIT_EXCEEDED | The account already has the max amount of bank accounts. |
| 403 | BANK_AUTHORITIES_FOR_BANK_ACCOUNT_EXCEEDED | There are already two bank accounts for the provided bank account number, which is the maximum allowed. |
-
-
- ```bash
- curl -X POST https://service.centrapay.com/api/bank-authorities \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "fullName": "John Doe",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "phoneNumber": "+64212345",
- "emailAddress": "John.doe@email.com",
- "bankAccountNumber": "12-1234-1234567-123",
- "bankAccountName": "John Doe"
- }'
- ```
-
-
-
- ```json
- {
- "id": "WRhAxxWpTKb5U7pXyxQjjY",
+
+ ```bash
+ curl -X POST https://service.centrapay.com/api/bank-authorities \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
+ "fullName": "John Doe",
"accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "phoneNumber": "+64212345",
+ "emailAddress": "John.doe@email.com",
"bankAccountNumber": "12-1234-1234567-123",
- "bankAccountName": "John Doe",
- "status": "created",
- "verified": false,
- "directDebitAuthorized": true,
- "createdAt": "2020-06-12T01:17:46.499Z",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "modifiedAt": "2020-06-12T01:17:46.499Z",
- "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "approvals": []
- }
- ```
-
-
+ "bankAccountName": "John Doe"
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "id": "WRhAxxWpTKb5U7pXyxQjjY",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "bankAccountNumber": "12-1234-1234567-123",
+ "bankAccountName": "John Doe",
+ "status": "created",
+ "verified": false,
+ "directDebitAuthorized": true,
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "modifiedAt": "2020-06-12T01:17:46.499Z",
+ "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "approvals": []
+ }
+ ```
+
@@ -737,32 +718,30 @@ The Bank Account balance, retrieved using Open Banking flows. The supported Bank
| 403 | BANK_AUTHORITY_LIMIT_EXCEEDED | The account already has the max amount of bank accounts. |
| 403 | BANK_AUTHORITIES_FOR_BANK_ACCOUNT_EXCEEDED | There are already two bank accounts for the provided bank account number, which is the maximum allowed. |
-
-
- ```bash
- curl https://service.centrapay.com/api/bank-authorities/WRhAxxWpTKb5U7pXyxQjjY \
- -H "X-Api-Key: $api_key"
- ```
-
-
-
- ```json
- {
- "id": "WRhAxxWpTKb5U7pXyxQjjY",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "bankAccountNumber": "12-1234-1234567-123",
- "bankAccountName": "John Doe",
- "status": "created",
- "directDebitAuthorized": true,
- "verified": false,
- "createdAt": "2020-06-12T01:17:46.499Z",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "modifiedAt": "2020-06-12T01:17:46.499Z",
- "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "approvals": []
- }
- ```
-
-
+
+ ```bash
+ curl https://service.centrapay.com/api/bank-authorities/WRhAxxWpTKb5U7pXyxQjjY \
+ -H "X-Api-Key: $api_key"
+ ```
+
+
+
+ ```json
+ {
+ "id": "WRhAxxWpTKb5U7pXyxQjjY",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "bankAccountNumber": "12-1234-1234567-123",
+ "bankAccountName": "John Doe",
+ "status": "created",
+ "directDebitAuthorized": true,
+ "verified": false,
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "modifiedAt": "2020-06-12T01:17:46.499Z",
+ "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "approvals": []
+ }
+ ```
+
diff --git a/src/content/api/businesses.mdx b/src/content/api/businesses.mdx
index 2f2b1105d..e9af1de55 100644
--- a/src/content/api/businesses.mdx
+++ b/src/content/api/businesses.mdx
@@ -9,7 +9,6 @@ nav:
import Properties from '../../components/Properties.astro';
import Property from '../../components/Property.astro';
import Endpoint from '../../components/Endpoint.astro';
-import CodeGroup from '../../components/CodeGroup.astro';
import Badge from '../../components/Badge.astro';
import CodePanel from '../../components/CodePanel.astro';
@@ -149,45 +148,43 @@ A Business represents a company registered with the New Zealand Companies Office
| 403 | INVALID_ACCOUNT | Account does not exist, is not authorized, is of the wrong type, or is not in the NZ region. |
| 403 | INVALID_NZBN | The NZBN provided does not match any NZ business. |
-
-
- ```bash
- curl -X POST https://service.centrapay.com/api/businesses \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "nzbn": "9429046246448",
- "taxNumber": {
- "value": "123-456-789",
- "type": "nz-gst"
- }
- }'
- ```
-
-
-
- ```json
- {
- "id": "DKTs3U38hdhfEqwF1JKoT2",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "accountName": "Centrapay",
+
+ ```bash
+ curl -X POST https://service.centrapay.com/api/businesses \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
"nzbn": "9429046246448",
- "name": "CENTRAPAY LIMITED",
- "tradingName": "CentraPay",
- "companyNumber": "6340244",
- "createdAt": "2020-06-12T01:17:46.499Z",
- "updatedAt": "2020-06-12T01:17:46.499Z",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
"taxNumber": {
"value": "123-456-789",
- "type": "nz-gst",
- },
- "onboardingStatus": "applied"
- }
- ```
-
-
+ "type": "nz-gst"
+ }
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "id": "DKTs3U38hdhfEqwF1JKoT2",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "accountName": "Centrapay",
+ "nzbn": "9429046246448",
+ "name": "CENTRAPAY LIMITED",
+ "tradingName": "CentraPay",
+ "companyNumber": "6340244",
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "updatedAt": "2020-06-12T01:17:46.499Z",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "taxNumber": {
+ "value": "123-456-789",
+ "type": "nz-gst",
+ },
+ "onboardingStatus": "applied"
+ }
+ ```
+
@@ -218,46 +215,44 @@ A Business represents a company registered with the New Zealand Companies Office
| 403 | INVALID_ACCOUNT | Account does not exist, is not authorized, is of the wrong type, or is not in the NZ region. |
| 403 | INVALID_NZBN | The NZBN provided does not match any NZ business. |
-
-
- ```bash
- curl -X PUT https://service.centrapay.com/api/businesses/DKTs3U38hdhfEqwF1JKoT2 \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "taxNumber": {
- "value": "123-456-789",
- "type": "nz-gst"
- },
- "farmlandsBusinessNumber": "12345678"
- }'
- ```
-
-
-
- ```json
- {
- "id": "DKTs3U38hdhfEqwF1JKoT2",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "accountName": "Centrapay",
- "nzbn": "9429046246448",
- "name": "CENTRAPAY LIMITED",
- "tradingName": "CentraPay",
- "companyNumber": "6340244",
- "createdAt": "2020-06-12T01:17:46.499Z",
- "updatedAt": "2020-06-12T01:17:46.499Z",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+
+ ```bash
+ curl -X PUT https://service.centrapay.com/api/businesses/DKTs3U38hdhfEqwF1JKoT2 \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
"taxNumber": {
"value": "123-456-789",
- "type": "nz-gst",
+ "type": "nz-gst"
},
- "farmlandsBusinessNumber": "12345678",
- "onboardingStatus": "applied"
- }
- ```
-
-
+ "farmlandsBusinessNumber": "12345678"
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "id": "DKTs3U38hdhfEqwF1JKoT2",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "accountName": "Centrapay",
+ "nzbn": "9429046246448",
+ "name": "CENTRAPAY LIMITED",
+ "tradingName": "CentraPay",
+ "companyNumber": "6340244",
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "updatedAt": "2020-06-12T01:17:46.499Z",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "taxNumber": {
+ "value": "123-456-789",
+ "type": "nz-gst",
+ },
+ "farmlandsBusinessNumber": "12345678",
+ "onboardingStatus": "applied"
+ }
+ ```
+
---
@@ -273,32 +268,30 @@ A Business represents a company registered with the New Zealand Companies Office
### Attributes
No attributes.
-
-
- ```bash
- curl https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/business \
- -H "X-Api-Key: $api_key"
- ```
-
-
-
- ```json
- {
- "id": "DKTs3U38hdhfEqwF1JKoT2",
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "accountName": "Centrapay",
- "nzbn": "9429046246448",
- "name": "CENTRAPAY LIMITED",
- "tradingName": "CentraPay",
- "companyNumber": "6340244",
- "createdAt": "2020-06-12T01:17:46.499Z",
- "updatedAt": "2020-06-12T01:17:46.499Z",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- }
- ```
-
-
+
+ ```bash
+ curl https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/business \
+ -H "X-Api-Key: $api_key"
+ ```
+
+
+
+ ```json
+ {
+ "id": "DKTs3U38hdhfEqwF1JKoT2",
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "accountName": "Centrapay",
+ "nzbn": "9429046246448",
+ "name": "CENTRAPAY LIMITED",
+ "tradingName": "CentraPay",
+ "companyNumber": "6340244",
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "updatedAt": "2020-06-12T01:17:46.499Z",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ }
+ ```
+
---
@@ -314,29 +307,27 @@ A Business represents a company registered with the New Zealand Companies Office
### Attributes
No attributes.
-
-
- ```bash
- curl -G https://service.centrapay.com/api/nzbn-search \
- -H "X-Api-Key: $api_key" \
- -d q=centrapay
- ```
-
-
-
- ```json
- {
- "items": [
- {
- "nzbn": "9429046246448",
- "companyName": "CENTRAPAY LIMITED",
- "companyNumber": "6340244"
- }
- ]
- }
- ```
-
-
+
+ ```bash
+ curl -G https://service.centrapay.com/api/nzbn-search \
+ -H "X-Api-Key: $api_key" \
+ -d q=centrapay
+ ```
+
+
+
+ ```json
+ {
+ "items": [
+ {
+ "nzbn": "9429046246448",
+ "companyName": "CENTRAPAY LIMITED",
+ "companyNumber": "6340244"
+ }
+ ]
+ }
+ ```
+
---
@@ -352,45 +343,43 @@ A Business represents a company registered with the New Zealand Companies Office
### Attributes
No attributes.
-
-
- ```bash
- curl https://service.centrapay.com/api/nzbn/9429046246448 \
- -H "X-Api-Key: $api_key"
- ```
-
-
-
- ```json
- {
- "nzbn": "9429046246448",
- "companyName": "CENTRAPAY LIMITED",
- "tradingName": "CentraPay",
- "companyNumber": "6340244",
- "directors": [
- {
- "firstName": "John",
- "lastName": "DOE",
- "addressLines": [
- "7 Tara Street",
- "Downmore",
- "Auckland"
- ]
- },
- {
- "firstName": "Jane",
- "lastName": "DOE",
- "addressLines": [
- "82 Greatwood Road",
- "Northclover",
- "Auckland"
- ]
- }
- ]
- }
- ```
-
-
+
+ ```bash
+ curl https://service.centrapay.com/api/nzbn/9429046246448 \
+ -H "X-Api-Key: $api_key"
+ ```
+
+
+
+ ```json
+ {
+ "nzbn": "9429046246448",
+ "companyName": "CENTRAPAY LIMITED",
+ "tradingName": "CentraPay",
+ "companyNumber": "6340244",
+ "directors": [
+ {
+ "firstName": "John",
+ "lastName": "DOE",
+ "addressLines": [
+ "7 Tara Street",
+ "Downmore",
+ "Auckland"
+ ]
+ },
+ {
+ "firstName": "Jane",
+ "lastName": "DOE",
+ "addressLines": [
+ "82 Greatwood Road",
+ "Northclover",
+ "Auckland"
+ ]
+ }
+ ]
+ }
+ ```
+
---
@@ -414,31 +403,29 @@ A Business represents a company registered with the New Zealand Companies Office
-
-
- ```bash
- curl -X POST https://service.centrapay.com/api/businesses/DKTs3U38hdhfEqwF1JKoT2/set-onboarding-status \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "onboardingStatus": "deactivated",
- "onboardingStatusReason": "change-of-ownership"
- }'
- ```
-
-
-
- ```json
- {
- "type": "set-onboarding-status",
+
+ ```bash
+ curl -X POST https://service.centrapay.com/api/businesses/DKTs3U38hdhfEqwF1JKoT2/set-onboarding-status \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
"onboardingStatus": "deactivated",
- "onboardingStatusReason": "change-of-ownership",
- "businessId": "DKTs3U38hdhfEqwF1JKoT2",
- "createdAt": "2020-06-12T01:17:46.499Z",
- "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
- "activityNumber": 2
- }
- ```
-
-
+ "onboardingStatusReason": "change-of-ownership"
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "type": "set-onboarding-status",
+ "onboardingStatus": "deactivated",
+ "onboardingStatusReason": "change-of-ownership",
+ "businessId": "DKTs3U38hdhfEqwF1JKoT2",
+ "createdAt": "2020-06-12T01:17:46.499Z",
+ "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
+ "activityNumber": 2
+ }
+ ```
+
diff --git a/src/content/api/media-uploads.mdx b/src/content/api/media-uploads.mdx
index 639c6da74..099aa96c8 100644
--- a/src/content/api/media-uploads.mdx
+++ b/src/content/api/media-uploads.mdx
@@ -9,7 +9,6 @@ nav:
import Properties from '../../components/Properties.astro';
import Property from '../../components/Property.astro';
import Endpoint from '../../components/Endpoint.astro';
-import CodeGroup from '../../components/CodeGroup.astro';
import Badge from '../../components/Badge.astro';
import CodePanel from '../../components/CodePanel.astro';
@@ -80,29 +79,27 @@ import CodePanel from '../../components/CodePanel.astro';
-
-
- ```bash
- curl -X POST https://service.centrapay.com/api/media-uploads \
- -H "X-Api-Key: $api_key" \
- -H "Content-Type: application/json" \
- -d '{
- "accountId": "Jaim1Cu1Q55uooxSens6yk",
- "mimeType": "image/png",
- "fileName": "image.png"
- }'
- ```
-
-
-
- ```json
- {
- "id": "DKTs3U38hdhfEqwF1JKoT2",
- "uploadUrl": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743"
- }
- ```
-
-
+
+ ```bash
+ curl -X POST https://service.centrapay.com/api/media-uploads \
+ -H "X-Api-Key: $api_key" \
+ -H "Content-Type: application/json" \
+ -d '{
+ "accountId": "Jaim1Cu1Q55uooxSens6yk",
+ "mimeType": "image/png",
+ "fileName": "image.png"
+ }'
+ ```
+
+
+
+ ```json
+ {
+ "id": "DKTs3U38hdhfEqwF1JKoT2",
+ "uploadUrl": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743"
+ }
+ ```
+
@@ -119,20 +116,18 @@ import CodePanel from '../../components/CodePanel.astro';
### Attributes
No attributes.
-
-
- ```bash
- curl https://service.centrapay.com/api/media-uploads/DKTs3U38hdhfEqwF1JKoT2/location \
- -H "X-Api-Key: $api_key"
- ```
-
-
-
- ```json
- {
- "url": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743"
- }
- ```
-
-
+
+ ```bash
+ curl https://service.centrapay.com/api/media-uploads/DKTs3U38hdhfEqwF1JKoT2/location \
+ -H "X-Api-Key: $api_key"
+ ```
+
+
+
+ ```json
+ {
+ "url": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743"
+ }
+ ```
+