From a4a94fa79624599c45f38c1359010c10ec8852ed Mon Sep 17 00:00:00 2001 From: tom-blake <46909693+tom-blake@users.noreply.github.com> Date: Wed, 20 Nov 2024 23:42:14 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20912d5?= =?UTF-8?q?26dc75293b0a94cccca1d7ee3af2306b6af=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 2 +- api/account-memberships/index.html | 2 +- api/accounts/index.html | 6 ++--- api/api-keys/index.html | 6 ++--- api/asset-activities/index.html | 6 ++--- api/asset-transfers/index.html | 2 +- api/asset-types/index.html | 2 +- api/assets/index.html | 2 +- api/auth/index.html | 2 +- api/bank-account-approvals/index.html | 6 ++--- .../index.html | 6 ++--- api/bank-accounts/index.html | 2 +- .../farmlands-external-asset/index.html | 2 +- api/batch-types/ticketek-ticket/index.html | 2 +- .../verifone-terminal-status/index.html | 2 +- api/batches/index.html | 2 +- api/businesses/index.html | 2 +- api/centrapay-event-types/index.html | 2 +- api/data-types/index.html | 2 +- api/events/index.html | 2 +- api/funds-transfers/index.html | 2 +- api/http-status-codes/index.html | 2 +- api/integration-requests/index.html | 2 +- api/integrations/index.html | 2 +- api/introduction/index.html | 2 +- api/invitations/index.html | 6 ++--- api/legacy-payment-requests/index.html | 2 +- api/loyalty-program-memberships/index.html | 2 +- api/loyalty-programs/index.html | 6 ++--- api/managed-integrations/index.html | 2 +- api/media-uploads/index.html | 2 +- api/merchant-configs/index.html | 6 ++--- api/merchants/index.html | 6 ++--- api/object-ids/index.html | 2 +- api/pagination/index.html | 2 +- api/patron-codes/index.html | 2 +- api/payment-requests/index.html | 6 ++--- api/profiles/index.html | 6 ++--- 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 | 6 ++--- api/wallets/index.html | 6 ++--- connections/farmlands/index.html | 2 +- guides/compatible-devices/index.html | 2 +- guides/creating-digital-tokens/index.html | 2 +- guides/creating-test-money/index.html | 24 ++----------------- guides/ecommerce-website/index.html | 2 +- guides/example-oidc-consumer/index.html | 2 +- .../farmlands-card-partner-support/index.html | 2 +- guides/farmlands-portal/index.html | 2 +- guides/farmlands-pos-integration/index.html | 2 +- guides/initiating-refunds/index.html | 2 +- .../integrating-third-party-asset/index.html | 2 +- guides/line-items/index.html | 2 +- guides/loyalty-programs/index.html | 2 +- .../index.html | 2 +- .../index.html | 2 +- .../index.html | 2 +- guides/partial-payment-extension/index.html | 2 +- guides/patron-not-present/index.html | 2 +- guides/payment-conditions/index.html | 2 +- guides/payment-flows/index.html | 2 +- guides/payment-terminals/index.html | 2 +- guides/point-of-sale/index.html | 2 +- guides/requesting-payment/index.html | 2 +- guides/requesting-pre-auth/index.html | 2 +- .../index.html | 2 +- guides/transaction-reporting/index.html | 2 +- guides/transferring-assets/index.html | 2 +- index-data.json | 2 +- index.html | 2 +- 74 files changed, 101 insertions(+), 121 deletions(-) diff --git a/404.html b/404.html index c19a3cba9..ed72ffe32 100644 --- a/404.html +++ b/404.html @@ -19,7 +19,7 @@
Go to home page
Docs -
Go to home page
Docs -
Go to home page
Docs -
Request
curl -X POST \
 https://service.centrapay.com/api/accounts \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "name": "Centrapay Cafe",
 "type": "org"
}
'
Response
{
  "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": []
}
-
GET /api/accounts/{accountId}

Get an Account

This endpoint allows you to retrieve an Account.

Request
curl -X GET \
 https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk \
 -H 'x-api-key: <TOKEN>'
Response
{
  "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": []
}
+
GET /api/accounts/{accountId}

Get an Account

This endpoint allows you to retrieve an Account.

Request
curl -X GET \
 https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk \
 -H 'x-api-key: <TOKEN>'
Response
{
  "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": []
}
PUT /api/accounts/{accountId}

Update an Account

This endpoint allows you to update an account.

Attributes

Request
curl -X POST \
 https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "name": "MyAPIkey",
 "role": "merchant-terminal"
}
'
Response
{
  "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"
}
-
GET /api/accounts/{accountId}/api-keys

List API Keys

This endpoint allows you to list all API Keys for an Account.

Request
curl -X GET \
 https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \
 -H 'x-api-key: <TOKEN>'
Response
[
  {
    "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"
  }
]
+
GET /api/accounts/{accountId}/api-keys

List API Keys

This endpoint allows you to list all API Keys for an Account.

Request
curl -X GET \
 https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \
 -H 'x-api-key: <TOKEN>'
Response
[
  {
    "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"
  }
]
PUT /api/accounts/{accountId}/api-keys/{apiKeyName}

Update an API Key

This endpoint allows you to enable or disable an API key.

Attributes

Request
curl -X GET \
 https://service.centrapay.com/api/assets/WRhAxxWpTKb5U7pXyxQjjY/transactions \
 -H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "ref": "adRGJqMyMhmGfnDXasRZ",
      "type": "transfer",
      "kind": "refund",
      "refType": "payment-request",
      "assetId": "WRhAxxWpTKb5U7pXyxQjjY",
      "srcParty": "Coffee Ltd",
      "destParty": "crn::user:5a3b1ba7-d01k-409f-ld0a-jd81k0ald",
      "createdAt": "2022-03-31T20:36:08.562Z",
      "createdBy": "crn::service:payments-api",
      "srcAssetId": "Jd9a89ZESjjCuUD9DJD9Al",
      "destAssetId": "WRhAxxWpTKb5U7pXyxQjjY",
      "amount": "2000",
      "activityType": "value-in",
      "activityNumber": "3"
    },
    {
      "ref": "adRGJqMyMhmGfnDXasRZ",
      "type": "transfer",
      "kind": "payment",
      "refType": "payment-request",
      "assetId": "WRhAxxWpTKb5U7pXyxQjjY",
      "srcParty": "crn::user:5a3b1ba7-d01k-409f-ld0a-jd81k0ald",
      "destParty": "Coffee Ltd",
      "createdAt": "2022-03-31T20:35:54.717Z",
      "createdBy": "crn::service:payments-api",
      "srcAssetId": "WRhAxxWpTKb5U7pXyxQjjY",
      "destAssetId": "Jd9a89ZESjjCuUD9DJD9Al",
      "amount": "3000",
      "activityType": "value-out",
      "activityNumber": "2"
    },
    {
      "ref": "H4SZKwMcU9VCmnGEqDA7Mn",
      "type": "increment-balance",
      "kind": "topup",
      "refType": "topup",
      "assetId": "WRhAxxWpTKb5U7pXyxQjjY",
      "createdAt": "2022-03-31T02:37:47.207Z",
      "createdBy": "crn::application:rhea",
      "destAssetId": "WRhAxxWpTKb5U7pXyxQjjY",
      "amount": "7600",
      "activityType": "value-in",
      "activityNumber": "1"
    }
  ]
}
+
GET /api/assets/{assetId}/transactions

List Asset Transactions experimental

Returns a paginated list of Asset Transactions. This endpoint is currently only supported for quartz asset types.

Request
curl -X GET \
 https://service.centrapay.com/api/assets/WRhAxxWpTKb5U7pXyxQjjY/transactions \
 -H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "ref": "adRGJqMyMhmGfnDXasRZ",
      "type": "transfer",
      "kind": "refund",
      "refType": "payment-request",
      "assetId": "WRhAxxWpTKb5U7pXyxQjjY",
      "srcParty": "Coffee Ltd",
      "destParty": "crn::user:5a3b1ba7-d01k-409f-ld0a-jd81k0ald",
      "createdAt": "2022-03-31T20:36:08.562Z",
      "createdBy": "crn::service:payments-api",
      "srcAssetId": "Jd9a89ZESjjCuUD9DJD9Al",
      "destAssetId": "WRhAxxWpTKb5U7pXyxQjjY",
      "amount": "2000",
      "activityType": "value-in",
      "activityNumber": "3"
    },
    {
      "ref": "adRGJqMyMhmGfnDXasRZ",
      "type": "transfer",
      "kind": "payment",
      "refType": "payment-request",
      "assetId": "WRhAxxWpTKb5U7pXyxQjjY",
      "srcParty": "crn::user:5a3b1ba7-d01k-409f-ld0a-jd81k0ald",
      "destParty": "Coffee Ltd",
      "createdAt": "2022-03-31T20:35:54.717Z",
      "createdBy": "crn::service:payments-api",
      "srcAssetId": "WRhAxxWpTKb5U7pXyxQjjY",
      "destAssetId": "Jd9a89ZESjjCuUD9DJD9Al",
      "amount": "3000",
      "activityType": "value-out",
      "activityNumber": "2"
    },
    {
      "ref": "H4SZKwMcU9VCmnGEqDA7Mn",
      "type": "increment-balance",
      "kind": "topup",
      "refType": "topup",
      "assetId": "WRhAxxWpTKb5U7pXyxQjjY",
      "createdAt": "2022-03-31T02:37:47.207Z",
      "createdBy": "crn::application:rhea",
      "destAssetId": "WRhAxxWpTKb5U7pXyxQjjY",
      "amount": "7600",
      "activityType": "value-in",
      "activityNumber": "1"
    }
  ]
}
GET /api/asset-activities

List Asset Activities

Returns a paginated list of Asset Activities.

Query Parameters

Attributes

  • bankAccountId

    string

    The bankAccountId of the assets that activities should be returned for.

Request
curl -X GET \
 https://service.centrapay.com/api/asset-activities \
 -H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "ref": "C2kaVDzGaCpJLSbBfusu5W",
      "type": "transfer",
      "kind": "payment",
      "refType": "payment-request",
      "assetId": "ExVHwdGEFugJWVXWi4riNq",
      "srcParty": "crn::user:46d42f1f-2816-4ce9-9781-fe93e8ebb0c6",
      "destParty": "Dev Smoke Test Merchant",
      "createdAt": "2023-11-28T21:18:40.583Z",
      "accountId": "6QXN8cq8XVwEJeYe3XH9fe",
      "createdBy": "crn::service:payments-api",
      "srcAssetId": "ExVHwdGEFugJWVXWi4riNq",
      "destAssetId": "WTNEcn8HHd2YgVsKRyvcPh",
      "amount": "1",
      "activityType": "value-out",
      "activityNumber": "2",
      "bankAccountId": "7GEDRsP9cyB9fScBziSmJa"
    },
    {
      "ref": "9qyT2gthTt4Dv7AX5U1zkY",
      "type": "transfer",
      "kind": "payment",
      "refType": "payment-request",
      "assetId": "ExVHwdGEFugJWVXWi4riNq",
      "srcParty": "crn::user:46d42f1f-2816-4ce9-9781-fe93e8ebb0c6",
      "destParty": "Dev Smoke Test Merchant",
      "createdAt": "2023-11-28T03:37:23.145Z",
      "accountId": "6QXN8cq8XVwEJeYe3XH9fe",
      "createdBy": "crn::service:payments-api",
      "srcAssetId": "ExVHwdGEFugJWVXWi4riNq",
      "destAssetId": "WTNEcn8HHd2YgVsKRyvcPh",
      "amount": "1",
      "activityType": "value-out",
      "activityNumber": "3",
      "bankAccountId": "7GEDRsP9cyB9fScBziSmJa"
    },
    {
      "assetId": "WxPhZtcBsf19yXjo8gVv9Y",
      "activityNumber": "1",
      "createdAt": "2022-11-07T22:12:57.224Z",
      "createdBy": "crn::application:rhea",
      "activityType": "created",
      "accountId": "6QXN8cq8XVwEJeYe3XH9fe",
      "status": "active"
    }
  ]
}
\ No newline at end of file +
Request
curl -X GET \
 https://service.centrapay.com/api/asset-activities \
 -H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "ref": "C2kaVDzGaCpJLSbBfusu5W",
      "type": "transfer",
      "kind": "payment",
      "refType": "payment-request",
      "assetId": "ExVHwdGEFugJWVXWi4riNq",
      "srcParty": "crn::user:46d42f1f-2816-4ce9-9781-fe93e8ebb0c6",
      "destParty": "Dev Smoke Test Merchant",
      "createdAt": "2023-11-28T21:18:40.583Z",
      "accountId": "6QXN8cq8XVwEJeYe3XH9fe",
      "createdBy": "crn::service:payments-api",
      "srcAssetId": "ExVHwdGEFugJWVXWi4riNq",
      "destAssetId": "WTNEcn8HHd2YgVsKRyvcPh",
      "amount": "1",
      "activityType": "value-out",
      "activityNumber": "2",
      "bankAccountId": "7GEDRsP9cyB9fScBziSmJa"
    },
    {
      "ref": "9qyT2gthTt4Dv7AX5U1zkY",
      "type": "transfer",
      "kind": "payment",
      "refType": "payment-request",
      "assetId": "ExVHwdGEFugJWVXWi4riNq",
      "srcParty": "crn::user:46d42f1f-2816-4ce9-9781-fe93e8ebb0c6",
      "destParty": "Dev Smoke Test Merchant",
      "createdAt": "2023-11-28T03:37:23.145Z",
      "accountId": "6QXN8cq8XVwEJeYe3XH9fe",
      "createdBy": "crn::service:payments-api",
      "srcAssetId": "ExVHwdGEFugJWVXWi4riNq",
      "destAssetId": "WTNEcn8HHd2YgVsKRyvcPh",
      "amount": "1",
      "activityType": "value-out",
      "activityNumber": "3",
      "bankAccountId": "7GEDRsP9cyB9fScBziSmJa"
    },
    {
      "assetId": "WxPhZtcBsf19yXjo8gVv9Y",
      "activityNumber": "1",
      "createdAt": "2022-11-07T22:12:57.224Z",
      "createdBy": "crn::application:rhea",
      "activityType": "created",
      "accountId": "6QXN8cq8XVwEJeYe3XH9fe",
      "status": "active"
    }
  ]
}
\ No newline at end of file diff --git a/api/asset-transfers/index.html b/api/asset-transfers/index.html index 62f927226..a1be57b9a 100644 --- a/api/asset-transfers/index.html +++ b/api/asset-transfers/index.html @@ -20,7 +20,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 -
Request
curl -X POST \
 https://service.centrapay.com/api/bank-account-approvals \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "mediaUploadId": "uooxSens6ykJaim1Cu1Q55",
 "bankAccountId": "WRhAxxWpTKb5U7pXyxQjjY",
 "type": "settlement"
}
'
Response
{
  "id": "DcTs3U38HdhfEqwF1GKoT3",
  "mediaUploadId": "uooxSens6ykJaim1Cu1Q55",
  "bankAccountId": "WRhAxxWpTKb5U7pXyxQjjY",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "type": "settlement",
  "status": "created",
  "createdAt": "2021-11-08T21:52:39.915Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "modifiedAt": "2021-11-08T21:52:39.915Z",
  "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
}
-
GET /api/bank-account-approvals/{bankAccountApprovalId}

Get Bank Account Approval experimental

This endpoint allows you to retrieve a Bank Account Approval.

Request
curl -X GET \
 https://service.centrapay.com/api/bank-account-approvals/bbab9a768921019cb856 \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "bbab9a768921019cb856",
  "bankAccountId": "WRhAxxWpTKb5U7pXyxQjjY",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "type": "account-information-consent",
  "status": "approved",
  "createdAt": "2021-11-08T21:52:39.915Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "modifiedAt": "2021-11-08T21:52:39.915Z",
  "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "refreshToken": "y04Njk3LTRjNmZkYjBhMzRiZSIsIm5vbmNlIjoiOTg3MTJjMGNkZmFiNWZjNzMwM2MxMzNl",
  "consentId": "d24dbe-e2bc46ac-d924e38af112"
}
+
GET /api/bank-account-approvals/{bankAccountApprovalId}

Get Bank Account Approval experimental

This endpoint allows you to retrieve a Bank Account Approval.

Request
curl -X GET \
 https://service.centrapay.com/api/bank-account-approvals/bbab9a768921019cb856 \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "bbab9a768921019cb856",
  "bankAccountId": "WRhAxxWpTKb5U7pXyxQjjY",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "type": "account-information-consent",
  "status": "approved",
  "createdAt": "2021-11-08T21:52:39.915Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "modifiedAt": "2021-11-08T21:52:39.915Z",
  "modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "refreshToken": "y04Njk3LTRjNmZkYjBhMzRiZSIsIm5vbmNlIjoiOTg3MTJjMGNkZmFiNWZjNzMwM2MxMzNl",
  "consentId": "d24dbe-e2bc46ac-d924e38af112"
}
POST /api/bank-account-approvals/{bankAccountApprovalId}/accept

Accept Bank Account Approval experimental

This endpoint allows you to accept a Bank Account Approval.

Attributes

Request
curl -X POST \
 https://service.centrapay.com/api/bank-account-connection-intents \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "accountId": "B4u4WZCu3joZFVWT3XjWW3",
 "type": "account-information-consent",
 "test": true
}
'
Response
{
  "id": "3KVjuKW2CZCJeJVqPxwkX7",
  "accountId": "B4u4WZCu3joZFVWT3XjWW3",
  "type": "account-information-consent",
  "status": "created",
  "createdAt": "2022-03-31 02:56:29 UTC",
  "createdBy": "crn:B4u4WZCu3joZFVWT3XjWW3:api-key:MyApiKey",
  "updatedAt": "2022-03-31 02:56:29 UTC",
  "updatedBy": "crn:B4u4WZCu3joZFVWT3XjWW3:api-key:MyApiKey",
  "authorizationUrl": "https://example.com/authorization-url",
  "test": true
}
+

  • LIVENESS_MISMATCH

    403

    Only Bank Account Connection Intents with the test flag can be associated with test Bank Accounts, and vice versa.

Request
curl -X POST \
 https://service.centrapay.com/api/bank-account-connection-intents \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "accountId": "B4u4WZCu3joZFVWT3XjWW3",
 "type": "account-information-consent",
 "test": true
}
'
Response
{
  "id": "3KVjuKW2CZCJeJVqPxwkX7",
  "accountId": "B4u4WZCu3joZFVWT3XjWW3",
  "type": "account-information-consent",
  "status": "created",
  "createdAt": "2022-03-31 02:56:29 UTC",
  "createdBy": "crn:B4u4WZCu3joZFVWT3XjWW3:api-key:MyApiKey",
  "updatedAt": "2022-03-31 02:56:29 UTC",
  "updatedBy": "crn:B4u4WZCu3joZFVWT3XjWW3:api-key:MyApiKey",
  "authorizationUrl": "https://example.com/authorization-url",
  "test": true
}
POST /api/bank-account-connection-intents/{bankAccountConnectionIntentId}/authorize

Authorize Bank Account Connection Intent experimental

This endpoint allows you to authorize a Bank Account Connection Intent.

Attributes

  • code

    string required

    Authorization code returned from third-party.

Request
curl -X POST \
 https://service.centrapay.com/api/bank-account-connection-intents/3KVjuKW2CZCJeJVqPxwkX7/authorize \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "code": "hKpKupTM391pE10xfQiorMxXarRKAHRhTfH_x"
}
'
Response
{}
\ No newline at end of file +
Request
curl -X POST \
 https://service.centrapay.com/api/bank-account-connection-intents/3KVjuKW2CZCJeJVqPxwkX7/authorize \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "code": "hKpKupTM391pE10xfQiorMxXarRKAHRhTfH_x"
}
'
Response
{}
\ No newline at end of file diff --git a/api/bank-accounts/index.html b/api/bank-accounts/index.html index de99d851e..8e0c084a3 100644 --- a/api/bank-accounts/index.html +++ b/api/bank-accounts/index.html @@ -20,7 +20,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 -
Request
curl -X POST \
 https://service.centrapay.com/api/invitations \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "type": "account-membership",
 "resourceId": "Hopo4g34sLVdjEMBs2p19F",
 "resourceType": "account",
 "recipientAlias": "user@org.com",
 "params": {
  "role": "cashier"
 }
}
'
Response
{
  "id": "DKTs3U38hdhfEqwF1JKoT2",
  "code": "WIj211vFs9cNACwBb04vQw",
  "type": "account-membership",
  "resourceId": "Hopo4g34sLVdjEMBs2p19F",
  "resourceType": "account",
  "expiresAt": "2021-08-26T00:02:49.488Z",
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedAt": "2021-08-25T00:02:49.488Z",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "recipientAlias": "user@org.com",
  "params": {
    "role": "cashier",
    "accountName": "Centrapay Cafe"
  },
  "status": "created"
}
+

  • INVALID_ACCOUNT_TYPE

    403

    The resourceId is associated with an account with a non org type.

  • RECIPIENT_ALREADY_INVITED

    403

    An active invitation for this recipientAlias and resource already exists, or the recipient has already joined the resource.

Request
curl -X POST \
 https://service.centrapay.com/api/invitations \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "type": "account-membership",
 "resourceId": "Hopo4g34sLVdjEMBs2p19F",
 "resourceType": "account",
 "recipientAlias": "user@org.com",
 "params": {
  "role": "cashier"
 }
}
'
Response
{
  "id": "DKTs3U38hdhfEqwF1JKoT2",
  "code": "WIj211vFs9cNACwBb04vQw",
  "type": "account-membership",
  "resourceId": "Hopo4g34sLVdjEMBs2p19F",
  "resourceType": "account",
  "expiresAt": "2021-08-26T00:02:49.488Z",
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedAt": "2021-08-25T00:02:49.488Z",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "recipientAlias": "user@org.com",
  "params": {
    "role": "cashier",
    "accountName": "Centrapay Cafe"
  },
  "status": "created"
}
-
GET /api/invitations/code/{code}

Get Invitation By Code experimental

This endpoint allows you to retrieve an Invitation by code.

Request
curl -X GET \
 https://service.centrapay.com/api/invitations/code/WIj211vFs9cNACwBb04vQw \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "DKTs3U38hdhfEqwF1JKoT2",
  "code": "WIj211vFs9cNACwBb04vQw",
  "type": "account-membership",
  "resourceId": "5ee0c486308f590260d9a07f",
  "resourceType": "account",
  "expiresAt": "2021-08-26T00:02:49.488Z",
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedAt": "2021-08-25T00:02:49.488Z",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
}
+
GET /api/invitations/code/{code}

Get Invitation By Code experimental

This endpoint allows you to retrieve an Invitation by code.

Request
curl -X GET \
 https://service.centrapay.com/api/invitations/code/WIj211vFs9cNACwBb04vQw \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "DKTs3U38hdhfEqwF1JKoT2",
  "code": "WIj211vFs9cNACwBb04vQw",
  "type": "account-membership",
  "resourceId": "5ee0c486308f590260d9a07f",
  "resourceType": "account",
  "expiresAt": "2021-08-26T00:02:49.488Z",
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedAt": "2021-08-25T00:02:49.488Z",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
}
GET /api/accounts/{accountId}/invitations

List Invitations by Account Id experimental

This endpoint allows you list Invitations for an Account.

Request
curl -X GET \
 https://service.centrapay.com/api/accounts/8usozbJzCJYjR8i7y92vMV/invitations \
 -H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "id": "DKTs3U38hdhfEqwF1JKoT2",
      "code": "WIj211vFs9cNACwBb04vQw",
      "type": "account-membership",
      "resourceId": "Hopo4g34sLVdjEMBs2p19F",
      "resourceType": "account",
      "expiresAt": "2021-08-26T00:02:49.488Z",
      "createdAt": "2021-08-25T00:02:49.488Z",
      "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
      "updatedAt": "2021-08-25T00:02:49.488Z",
      "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
      "recipientAlias": "user@org.com",
      "params": {
        "role": "account-owner",
        "accountName": "Centrapay Cafe"
      },
      "status": "created"
    },
    {
      "id": "JKKDMU38hd01hfEqwF1oT2",
      "code": "WIj211vFs9cNACwBb04vQw",
      "type": "account-membership",
      "resourceId": "Hopo4g34sLVdjEMBs2p19F",
      "resourceType": "account",
      "expiresAt": "2021-08-26T00:02:49.488Z",
      "createdAt": "2021-08-25T00:02:49.488Z",
      "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
      "updatedAt": "2021-08-25T00:02:49.488Z",
      "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
      "recipientAlias": "john.doe@org.com",
      "params": {
        "role": "cashier",
        "accountName": "Centrapay Tea Warehouse"
      },
      "status": "sent"
    }
  ]
}
diff --git a/api/legacy-payment-requests/index.html b/api/legacy-payment-requests/index.html index e2bacddd5..ada6509d9 100644 --- a/api/legacy-payment-requests/index.html +++ b/api/legacy-payment-requests/index.html @@ -20,7 +20,7 @@
Go to home page
Docs -
Go to home page
Docs -
Go to home page
Docs -
Request
curl -X POST \
 https://service.centrapay.com/api/loyalty-programs \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "name": "Centrapay Cafe Loyalty Program",
 "description": "Centrapay Cafe Loyalty: Earn rewards, enjoy perks! Join now!",
 "mediaUploadId": "8aoMfscvtuewsuJzmzBzAs",
 "accountId": "Jaim1Cu1Q55uooxSens6yk"
}
'
Response
{
  "id": "WRhAxxWpTKb5U7pXyxQjjY",
  "name": "Centrapay Cafe Loyalty Program",
  "description": "Centrapay Cafe Loyalty: Earn rewards, enjoy perks! Join now!",
  "mediaUploadId": "8aoMfscvtuewsuJzmzBzAs",
  "img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "test": true
}
+

  • INVALID_ACCOUNT_TYPE

    403

    The Account must be type org.

Request
curl -X POST \
 https://service.centrapay.com/api/loyalty-programs \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "name": "Centrapay Cafe Loyalty Program",
 "description": "Centrapay Cafe Loyalty: Earn rewards, enjoy perks! Join now!",
 "mediaUploadId": "8aoMfscvtuewsuJzmzBzAs",
 "accountId": "Jaim1Cu1Q55uooxSens6yk"
}
'
Response
{
  "id": "WRhAxxWpTKb5U7pXyxQjjY",
  "name": "Centrapay Cafe Loyalty Program",
  "description": "Centrapay Cafe Loyalty: Earn rewards, enjoy perks! Join now!",
  "mediaUploadId": "8aoMfscvtuewsuJzmzBzAs",
  "img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
  "accountId": "Jaim1Cu1Q55uooxSens6yk",
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "test": true
}
-
GET /api/accounts/{accountId}/loyalty-programs

List Loyalty Programs by Account Id experimental

Returns a paginated list of Loyalty Programs for an Account.

Request
curl -X GET \
 https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/loyalty-programs \
 -H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "id": "WRhAxxWpTKb5U7pXyxQjjY",
      "name": "Centrapay Cafe Loyalty Program",
      "description": "Centrapay Cafe Loyalty: Earn rewards, enjoy perks! Join now!",
      "mediaUploadId": "8aoMfscvtuewsuJzmzBzAs",
      "img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
      "accountId": "Jaim1Cu1Q55uooxSens6yk",
      "createdAt": "2021-08-25T00:02:49.488Z",
      "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
      "test": true
    },
    {
      "id": "DKTs3U38hdhfEqwF1JKoT2",
      "name": "Centra Tea Warehouse Loyalty Program",
      "description": "Centra Tea Warehouse Loyalty: Earn rewards, enjoy perks! Join now!",
      "mediaUploadId": "Hopo4g34sLVdjEMBs2p19F",
      "img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
      "accountId": "Jaim1Cu1Q55uooxSens6yk",
      "createdAt": "2021-08-25T00:02:49.488Z",
      "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
      "test": true
    }
  ]
}
\ No newline at end of file +
GET /api/accounts/{accountId}/loyalty-programs

List Loyalty Programs by Account Id experimental

Returns a paginated list of Loyalty Programs for an Account.

Request
curl -X GET \
 https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/loyalty-programs \
 -H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "id": "WRhAxxWpTKb5U7pXyxQjjY",
      "name": "Centrapay Cafe Loyalty Program",
      "description": "Centrapay Cafe Loyalty: Earn rewards, enjoy perks! Join now!",
      "mediaUploadId": "8aoMfscvtuewsuJzmzBzAs",
      "img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
      "accountId": "Jaim1Cu1Q55uooxSens6yk",
      "createdAt": "2021-08-25T00:02:49.488Z",
      "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
      "test": true
    },
    {
      "id": "DKTs3U38hdhfEqwF1JKoT2",
      "name": "Centra Tea Warehouse Loyalty Program",
      "description": "Centra Tea Warehouse Loyalty: Earn rewards, enjoy perks! Join now!",
      "mediaUploadId": "Hopo4g34sLVdjEMBs2p19F",
      "img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
      "accountId": "Jaim1Cu1Q55uooxSens6yk",
      "createdAt": "2021-08-25T00:02:49.488Z",
      "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
      "test": true
    }
  ]
}
\ No newline at end of file diff --git a/api/managed-integrations/index.html b/api/managed-integrations/index.html index 60e33ad40..63016837e 100644 --- a/api/managed-integrations/index.html +++ b/api/managed-integrations/index.html @@ -20,7 +20,7 @@
Go to home page
Docs -
Go to home page
Docs -
Go to home page
Docs -
Request
curl -X POST \
 https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f/configs \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "paymentOptions": [
  {
   "type": "centrapay.nzd.main",
   "walletId": "1234c486308f3f0a23f0f92b"
  },
  {
   "type": "epay.main",
   "externalMerchantId": "11000021"
  },
  {
   "type": "farmlands.nzd.main",
   "farmlandsMerchantNumber": "DbgY2SyD5M85zkePJjsQEf"
  },
  {
   "type": "quartz.nzd.main",
   "externalMerchantId": "0012399012"
  }
 ]
}
'
Response
{
  "id": "mc_5ee168e8597be5002af7b454",
  "merchantId": "5ee0c486308f590260d9a07f",
  "createdAt": "2021-11-12T01:17:46.499Z",
  "updatedAt": "2021-11-12T01:17:46.499Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "paymentOptions": [
    {
      "type": "centrapay.nzd.main",
      "walletId": "1234c486308f3f0a23f0f92b"
    },
    {
      "type": "epay.main",
      "externalMerchantId": "11000021"
    },
    {
      "type": "farmlands.nzd.main",
      "farmlandsMerchantNumber": "DbgY2SyD5M85zkePJjsQEf"
    },
    {
      "type": "quartz.nzd.main",
      "externalMerchantId": "0012399012"
    }
  ]
}
+

  • INVALID_WALLET_TYPE

    403

    walletId does not belong to a Settlement Wallet.

  • LIVENESS_MISMATCH

    403

    Only Merchants with the test flag can have merchant configs with test assets, vice versa

  • COLLECTIONS_INVALID

    403

    An item in the collectionIds array does not exist or does not belong to a supported collection type.

Request
curl -X POST \
 https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f/configs \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "paymentOptions": [
  {
   "type": "centrapay.nzd.main",
   "walletId": "1234c486308f3f0a23f0f92b"
  },
  {
   "type": "epay.main",
   "externalMerchantId": "11000021"
  },
  {
   "type": "farmlands.nzd.main",
   "farmlandsMerchantNumber": "DbgY2SyD5M85zkePJjsQEf"
  },
  {
   "type": "quartz.nzd.main",
   "externalMerchantId": "0012399012"
  }
 ]
}
'
Response
{
  "id": "mc_5ee168e8597be5002af7b454",
  "merchantId": "5ee0c486308f590260d9a07f",
  "createdAt": "2021-11-12T01:17:46.499Z",
  "updatedAt": "2021-11-12T01:17:46.499Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "paymentOptions": [
    {
      "type": "centrapay.nzd.main",
      "walletId": "1234c486308f3f0a23f0f92b"
    },
    {
      "type": "epay.main",
      "externalMerchantId": "11000021"
    },
    {
      "type": "farmlands.nzd.main",
      "farmlandsMerchantNumber": "DbgY2SyD5M85zkePJjsQEf"
    },
    {
      "type": "quartz.nzd.main",
      "externalMerchantId": "0012399012"
    }
  ]
}
-
GET /api/merchants/{merchantId}/configs/{configId}

Get Merchant Config

This endpoint allows you to retrieve a Merchant Config by id.

Request
curl -X GET \
 https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f/configs/5ee168e8597be5002af7b454 \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "mc_5ee168e8597be5002af7b454",
  "merchantId": "5ee0c486308f590260d9a07f",
  "createdAt": "2021-11-12T01:17:46.499Z",
  "updatedAt": "2021-11-12T01:17:46.499Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "paymentOptions": [
    {
      "type": "farmlands.nzd.main",
      "farmlandsMerchantNumber": "DbgY2SyD5M85zkePJjsQEf"
    }
  ]
}
+
GET /api/merchants/{merchantId}/configs/{configId}

Get Merchant Config

This endpoint allows you to retrieve a Merchant Config by id.

Request
curl -X GET \
 https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f/configs/5ee168e8597be5002af7b454 \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "mc_5ee168e8597be5002af7b454",
  "merchantId": "5ee0c486308f590260d9a07f",
  "createdAt": "2021-11-12T01:17:46.499Z",
  "updatedAt": "2021-11-12T01:17:46.499Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "paymentOptions": [
    {
      "type": "farmlands.nzd.main",
      "farmlandsMerchantNumber": "DbgY2SyD5M85zkePJjsQEf"
    }
  ]
}
GET /api/merchants/{merchantId}/configs

List Merchant Configs

This endpoint allows you to retrieve a list of Merchant Configs.

Request
curl -X GET \
 https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f/configs \
 -H 'x-api-key: <TOKEN>'
Response
[
  {
    "id": "mc_5ee168e8597be5002af7b454",
    "merchantId": "5ee0c486308f590260d9a07f",
    "createdAt": "2021-09-12T01:17:46.499Z",
    "updatedAt": "2021-09-12T01:17:46.499Z",
    "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
    "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
    "paymentOptions": [
      {
        "type": "farmlands.nzd.main",
        "farmlandsMerchantNumber": "DbgY2SyD5M85zkePJjsQEf"
      }
    ]
  },
  {
    "id": "mc_5ee168e8597be5002af7baed",
    "merchantId": "5ee0c486308f590260d9a07f",
    "createdAt": "2021-11-12T01:17:46.499Z",
    "updatedAt": "2021-11-12T01:17:46.499Z",
    "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
    "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
    "paymentOptions": [
      {
        "type": "test"
      }
    ]
  }
]
diff --git a/api/merchants/index.html b/api/merchants/index.html index 79f57097b..b0c0897c7 100644 --- a/api/merchants/index.html +++ b/api/merchants/index.html @@ -20,7 +20,7 @@
Go to home page
Docs -
Request
curl -X POST \
 https://service.centrapay.com/api/merchants \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "accountId": "C4QnjXvj8At6SMsEN4LRi9",
 "name": "Centrapay Cafe Auckland",
 "country": "NZ",
 "test": false
}
'
Response
{
  "id": "5ee0c486308f590260d9a07f",
  "accountId": "C4QnjXvj8At6SMsEN4LRi9",
  "name": "Centrapay Cafe Auckland",
  "country": "NZ",
  "test": false,
  "onboardingStatus": "applied",
  "createdAt": "2021-11-12T01:17:46.499Z",
  "updatedAt": "2021-11-12T01:17:46.499Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
}
-
GET /api/merchants/{merchantId}

Get Merchant

This endpoint allows you to retrieve a Merchant by id.

Request
curl -X GET \
 https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "5ee0c486308f590260d9a07f",
  "accountId": "yqwyya0rzz3vvshqw0474u89xtj5fn",
  "name": "Parisian - Brown",
  "test": false,
  "country": "AD",
  "onboardingStatus": "applied",
  "createdAt": "2021-11-12T01:17:46.499Z",
  "updatedAt": "2021-11-12T01:17:46.499Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
}
+
GET /api/merchants/{merchantId}

Get Merchant

This endpoint allows you to retrieve a Merchant by id.

Request
curl -X GET \
 https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "5ee0c486308f590260d9a07f",
  "accountId": "yqwyya0rzz3vvshqw0474u89xtj5fn",
  "name": "Parisian - Brown",
  "test": false,
  "country": "AD",
  "onboardingStatus": "applied",
  "createdAt": "2021-11-12T01:17:46.499Z",
  "updatedAt": "2021-11-12T01:17:46.499Z",
  "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
  "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
}
GET /api/accounts/{accountId}/merchants

List Merchants for Account

This endpoint allows you to retrieve a paginated list of Merchants attached to an Account.

Request
curl -X GET \
 https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/merchants \
 -H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "accountId": "Jaim1Cu1Q55uooxSens6yk",
      "country": "BT",
      "id": "5f6bf6ff81552101f8ff6122",
      "name": "Adams, Runolfsdottir and Botsford",
      "test": true,
      "onboardingStatus": "applied",
      "createdAt": "2021-11-12T01:17:46.499Z",
      "updatedAt": "2021-11-12T01:17:46.499Z",
      "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
      "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
    },
    {
      "accountId": "Jaim1Cu1Q55uooxSens6yk",
      "country": "GM",
      "id": "5f6bf6ff81552101f8ff6123",
      "name": "Vandervort Inc",
      "test": false,
      "onboardingStatus": "applied",
      "createdAt": "2021-11-12T01:17:46.499Z",
      "updatedAt": "2021-11-12T01:17:46.499Z",
      "createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
      "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
    }
  ]
}
diff --git a/api/object-ids/index.html b/api/object-ids/index.html index 71598ce5d..3ac255749 100644 --- a/api/object-ids/index.html +++ b/api/object-ids/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 -
Request
curl -X POST \
 https://service.centrapay.com/api/payment-requests \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "configId": "mc_5efbe2fb96c08357bb2b9242",
 "expirySeconds": "120",
 "value": {
  "amount": "1",
  "currency": "NZD"
 }
}
'
Response
{
  "id": "VYowvZmuw3hbp1va9xqWx7",
  "shortCode": "CP-X4V-6N",
  "url": "https://app.centrapay.com/pay/VYowvZmuw3hbp1va9xqWx7",
  "merchantId": "5efbe17d96c083633e2b9241",
  "merchantName": "NZD Test Merchant",
  "configId": "mc_5efbe2fb96c08357bb2b9242",
  "value": {
    "amount": "1",
    "currency": "NZD"
  },
  "paymentOptions": [
    {
      "assetType": "centrapay.nzd.test",
      "amount": "1"
    },
    {
      "assetType": "cca.coke.test",
      "amount": "1"
    },
    {
      "assetType": "farmlands.nzd.test",
      "amount": "1"
    },
    {
      "assetType": "quartz.nzd.test",
      "amount": "1"
    },
    {
      "assetType": "uplinkapi.test",
      "amount": "1"
    },
    {
      "assetType": "epay.test",
      "amount": "1"
    }
  ],
  "status": "new",
  "createdAt": "2023-10-23T22:56:46.145Z",
  "updatedAt": "2023-10-23T22:56:46.145Z",
  "expiresAt": "2023-10-23T22:58:46.145Z",
  "liveness": "test",
  "expirySeconds": 120,
  "merchantConditions": [],
  "createdByAccountId": "BtCjTpNwFcbuJQUP1c4qXp",
  "createdByAccountName": "Smoke Test Merchant Prod",
  "taxNumber": {
    "value": "123-456-789",
    "type": "nz-gst"
  },
  "remainingAmount": "1"
}
-
GET /api/payment-requests/{paymentRequestId}

Get a Payment Request

This endpoint allows you to retrieve a Payment Request.

Request
curl -X GET \
 https://service.centrapay.com/api/payment-requests/MhocUmpxxmgdHjr7DgKoKw \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "MhocUmpxxmgdHjr7DgKoKw",
  "shortCode": "CP-C7F-ZS5",
  "url": "https://app.centrapay.com/pay/MhocUmpxxmgdHjr7DgKoKw",
  "patronCodeId": "V17FByEP9gm1shSG6a1Zzx",
  "barcode": "9990001234567895",
  "merchantId": "26d3Cp3rJmbMHnuNJmks2N",
  "merchantName": "Centrapay Café",
  "configId": "5efbe2fb96c08357bb2b9242",
  "purchaseOrderRef": "oF6kj1QlH5gK0y9rjRHFh2",
  "invoiceRef": "sy8CRmo3sp3ArOpnfmb423",
  "value": {
    "currency": "NZD",
    "amount": "8991"
  },
  "paymentOptions": [
    {
      "amount": "8991",
      "assetType": "centrapay.nzd.test"
    },
    {
      "amount": "6190",
      "assetType": "centrapay.token.test",
      "acceptedCollections": [
        {
          "id": "QWNB6jurnBczmvXDVfRuMK",
          "lineItems": [
            {
              "name": "Coffee Grounds",
              "sku": "GH1234",
              "qty": "1",
              "price": "4195",
              "tax": "15.00"
            }
          ]
        }
      ]
    }
  ],
  "lineItems": [
    {
      "name": "Coffee Grounds",
      "sku": "GH1234",
      "qty": "1",
      "price": "4195",
      "tax": "15.00"
    },
    {
      "name": "Centrapay Cafe Mug",
      "sku": "SB456",
      "qty": "25",
      "price": "1995",
      "tax": "15.00",
      "discount": "199"
    }
  ],
  "merchantConditions": [
    {
      "id": "1",
      "name": "photo-id-check",
      "message": "Please check ID",
      "status": "awaiting-merchant"
    }
  ],
  "status": "new",
  "createdAt": "2021-06-08T04:04:27.426Z",
  "updatedAt": "2021-06-08T04:04:27.426Z",
  "expiresAt": "2021-06-08T04:06:27.426Z",
  "liveness": "test",
  "expirySeconds": 120
}
+
GET /api/payment-requests/{paymentRequestId}

Get a Payment Request

This endpoint allows you to retrieve a Payment Request.

Request
curl -X GET \
 https://service.centrapay.com/api/payment-requests/MhocUmpxxmgdHjr7DgKoKw \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "MhocUmpxxmgdHjr7DgKoKw",
  "shortCode": "CP-C7F-ZS5",
  "url": "https://app.centrapay.com/pay/MhocUmpxxmgdHjr7DgKoKw",
  "patronCodeId": "V17FByEP9gm1shSG6a1Zzx",
  "barcode": "9990001234567895",
  "merchantId": "26d3Cp3rJmbMHnuNJmks2N",
  "merchantName": "Centrapay Café",
  "configId": "5efbe2fb96c08357bb2b9242",
  "purchaseOrderRef": "oF6kj1QlH5gK0y9rjRHFh2",
  "invoiceRef": "sy8CRmo3sp3ArOpnfmb423",
  "value": {
    "currency": "NZD",
    "amount": "8991"
  },
  "paymentOptions": [
    {
      "amount": "8991",
      "assetType": "centrapay.nzd.test"
    },
    {
      "amount": "6190",
      "assetType": "centrapay.token.test",
      "acceptedCollections": [
        {
          "id": "QWNB6jurnBczmvXDVfRuMK",
          "lineItems": [
            {
              "name": "Coffee Grounds",
              "sku": "GH1234",
              "qty": "1",
              "price": "4195",
              "tax": "15.00"
            }
          ]
        }
      ]
    }
  ],
  "lineItems": [
    {
      "name": "Coffee Grounds",
      "sku": "GH1234",
      "qty": "1",
      "price": "4195",
      "tax": "15.00"
    },
    {
      "name": "Centrapay Cafe Mug",
      "sku": "SB456",
      "qty": "25",
      "price": "1995",
      "tax": "15.00",
      "discount": "199"
    }
  ],
  "merchantConditions": [
    {
      "id": "1",
      "name": "photo-id-check",
      "message": "Please check ID",
      "status": "awaiting-merchant"
    }
  ],
  "status": "new",
  "createdAt": "2021-06-08T04:04:27.426Z",
  "updatedAt": "2021-06-08T04:04:27.426Z",
  "expiresAt": "2021-06-08T04:06:27.426Z",
  "liveness": "test",
  "expirySeconds": 120
}
GET /api/payment-requests/short-code/{shortCode}

Get a Payment Request by Short Code

This endpoint returns the latest Payment Request that matches the given short code.

Errors

Request
curl -X POST \
 https://service.centrapay.com/api/me/profile/update \
 -H 'authorization: <TOKEN>' \
 -H 'content-type: application/json' \
 -d '
{
 "givenName": "John",
 "familyName": "Doe",
 "featureUpdates": false,
 "marketingUpdates": true,
 "email": "john.doe@centrapay.com"
}
'
Response
{
  "userId": "9f4b3bae-dc30-11ea-ab70-2743d9be3dd5",
  "givenName": "John",
  "familyName": "Doe",
  "featureUpdates": true,
  "marketingUpdates": true,
  "email": "john.doe@centrapay.com",
  "emailVerified": true,
  "phoneNumber": "+64271112222",
  "phoneVerified": true
}
-
GET /api/users/{userId}/profile

Get Profile experimental

This endpoint allows you to retrieve a user’s Profile.

Request
curl -X GET \
 https://service.centrapay.com/api/users/da75ad90-9a5b-4df0-8374-f48b3a8fbfcc/profile \
 -H 'x-api-key: <TOKEN>'
Response
{
  "givenName": "John",
  "familyName": "Doe",
  "featureUpdates": false,
  "marketingUpdates": true,
  "email": "john.doe@centrapay.com"
}
\ No newline at end of file +
GET /api/users/{userId}/profile

Get Profile experimental

This endpoint allows you to retrieve a user’s Profile.

Request
curl -X GET \
 https://service.centrapay.com/api/users/da75ad90-9a5b-4df0-8374-f48b3a8fbfcc/profile \
 -H 'x-api-key: <TOKEN>'
Response
{
  "givenName": "John",
  "familyName": "Doe",
  "featureUpdates": false,
  "marketingUpdates": true,
  "email": "john.doe@centrapay.com"
}
\ No newline at end of file diff --git a/api/promotion-memberships/index.html b/api/promotion-memberships/index.html index 13b77d602..d4db5a5d8 100644 --- a/api/promotion-memberships/index.html +++ b/api/promotion-memberships/index.html @@ -20,7 +20,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 -
Request
curl -X POST \
 https://service.centrapay.com/api/collections \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "name": "Bread",
 "accountId": "T3y6hogYA4d612BExypWYH",
 "tokenExpiresAfter": {
  "period": "month",
  "duration": "1"
 },
 "maxValue": {
  "currency": "NZD",
  "amount": "400"
 },
 "type": "product",
 "mediaUploadId": "12345",
 "externalId": "ABC"
}
'
Response
{
  "id": "c_Xv990BzkgfoDS7bBls50pd",
  "name": "Bread",
  "accountId": "T3y6hogYA4d612BExypWYH",
  "tokenExpiresAfter": {
    "period": "month",
    "duration": "1"
  },
  "maxValue": {
    "currency": "NZD",
    "amount": "400"
  },
  "test": true,
  "type": "product",
  "status": "active",
  "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "createdAt": "2021-05-12T04:30:11.001Z",
  "mediaUploadId": "12345",
  "img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
  "issuer": "Centrapay",
  "externalId": "ABC"
}
GET /api/accounts/{accountId}/collections

List Token Collections experimental

Returns a paginated list of Token Collections for an Account.

Attributes

  • pageKey

    string

    Used to retrieve the next page of items.

Request
curl -X GET \
 'https://service.centrapay.com/api/accounts/T3y6hogYA4d612BExypWYH/collections?pageKey=Collection%232G5bXm4dnuDHnnKY8WeCPm%7C%23Collection%7C8vq4kn03o0g1grrihk7ooloizpqt2y' \
 -H 'x-api-key: <TOKEN>'
Response
{
  "nextPageKey": "Collection#E9eXsErwA444qFDoZt5iLA|#Collection",
  "items": [
    {
      "id": "c_Xv990BzkgfoDS7bBls50pd",
      "name": "Bread",
      "accountId": "T3y6hogYA4d612BExypWYH",
      "tokenExpiresAfter": {
        "period": "month",
        "duration": "1"
      },
      "maxValue": {
        "currency": "NZD",
        "amount": "400"
      },
      "test": true,
      "type": "product",
      "status": "active",
      "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
      "createdAt": "2021-05-12T04:30:11.001Z",
      "mediaUploadId": "12345",
      "img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
      "issuer": "Centrapay"
    }
  ]
}
+

  • pageKey

    string

    Used to retrieve the next page of items.

Request
curl -X GET \
 'https://service.centrapay.com/api/accounts/T3y6hogYA4d612BExypWYH/collections?pageKey=Collection%232G5bXm4dnuDHnnKY8WeCPm%7C%23Collection%7C8vq4kn03o0g1grrihk7ooloizpqt2y' \
 -H 'x-api-key: <TOKEN>'
Response
{
  "nextPageKey": "Collection#E9eXsErwA444qFDoZt5iLA|#Collection",
  "items": [
    {
      "id": "c_Xv990BzkgfoDS7bBls50pd",
      "name": "Bread",
      "accountId": "T3y6hogYA4d612BExypWYH",
      "tokenExpiresAfter": {
        "period": "month",
        "duration": "1"
      },
      "maxValue": {
        "currency": "NZD",
        "amount": "400"
      },
      "test": true,
      "type": "product",
      "status": "active",
      "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
      "createdAt": "2021-05-12T04:30:11.001Z",
      "mediaUploadId": "12345",
      "img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
      "issuer": "Centrapay"
    }
  ]
}
POST /api/collections/{collectionId}/redemption-conditions

Create Redemption Condition experimental

This endpoint allows you to create a Redemption Condition.

Attributes

Request
curl -X POST \
 https://service.centrapay.com/api/wallets \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "accountId": "Te2uDM7xhDLWGVJU3nzwnh",
 "ledgerId": "centrapay.nzd.main",
 "settlement": "true"
}
'
Response
{
  "id": "WRhAxxWpTKb5U7pXyxQjjY",
  "accountId": "Te2uDM7xhDLWGVJU3nzwnh",
  "category": "money",
  "type": "centrapay.nzd.main",
  "liveness": "main",
  "description": "NZD",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "status": "active",
  "currency": "NZD",
  "balance": "0",
  "availableBalance": "6000",
  "settlement": true
}
+
Request
curl -X POST \
 https://service.centrapay.com/api/wallets \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "accountId": "Te2uDM7xhDLWGVJU3nzwnh",
 "ledgerId": "centrapay.nzd.main",
 "settlement": "true"
}
'
Response
{
  "id": "WRhAxxWpTKb5U7pXyxQjjY",
  "accountId": "Te2uDM7xhDLWGVJU3nzwnh",
  "category": "money",
  "type": "centrapay.nzd.main",
  "liveness": "main",
  "description": "NZD",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "status": "active",
  "currency": "NZD",
  "balance": "0",
  "availableBalance": "6000",
  "settlement": true
}
-
GET /api/wallets

List Wallets

This endpoint allows you to list authorized Wallets.

Request
curl -X GET \
 https://service.centrapay.com/api/wallets \
 -H 'x-api-key: <TOKEN>'
Response
[
  {
    "id": "WRhAxxWpTKb5U7pXyxQjjY",
    "accountId": "Te2uDM7xhDLWGVJU3nzwnh",
    "ledgerId": "centrapay.nzd.main",
    "currency": "NZD",
    "balance": "2000",
    "availableBalance": "6000"
  },
  {
    "id": "NQ1yeromwnWPD2hY41L2yS",
    "accountId": "Te2uDM7xhDLWGVJU3nzwnh",
    "ledgerId": "centrapay.nzd.test",
    "currency": "NZD",
    "balance": "20",
    "availableBalance": "6000"
  }
]
+
GET /api/wallets

List Wallets

This endpoint allows you to list authorized Wallets.

Request
curl -X GET \
 https://service.centrapay.com/api/wallets \
 -H 'x-api-key: <TOKEN>'
Response
[
  {
    "id": "WRhAxxWpTKb5U7pXyxQjjY",
    "accountId": "Te2uDM7xhDLWGVJU3nzwnh",
    "ledgerId": "centrapay.nzd.main",
    "currency": "NZD",
    "balance": "2000",
    "availableBalance": "6000"
  },
  {
    "id": "NQ1yeromwnWPD2hY41L2yS",
    "accountId": "Te2uDM7xhDLWGVJU3nzwnh",
    "ledgerId": "centrapay.nzd.test",
    "currency": "NZD",
    "balance": "20",
    "availableBalance": "6000"
  }
]
GET /api/wallets/{walletId}/transactions

List Wallet Transactions

This endpoint allows you to list Wallet Transactions.

Request
curl -X GET \
 https://service.centrapay.com/api/wallets/WRhAxxWpTKb5U7pXyxQjjY/transactions \
 -H 'x-api-key: <TOKEN>'
Response
{
  "items": [
    {
      "activityNumber": "1",
      "amount": "5000",
      "value": "5000",
      "createdAt": "2020-06-17T18:00:23.000Z",
      "srcParty": "12-4000-100001-00",
      "destWalletId": "EBVSreNmpsE2Pazw3SipXC",
      "topupId": "77hqHDzw6KaaG2P2hoshUB"
    }
  ]
}
\ No newline at end of file diff --git a/connections/farmlands/index.html b/connections/farmlands/index.html index 39656fdff..58140c1e5 100644 --- a/connections/farmlands/index.html +++ b/connections/farmlands/index.html @@ -14,7 +14,7 @@ })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
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 -