From d29fb01a4288ddc7b3ede3a878ec645e3f00d22a Mon Sep 17 00:00:00 2001 From: MeganSteenkamp <64108933+MeganSteenkamp@users.noreply.github.com> Date: Mon, 22 Apr 2024 00:39:23 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=204c2f3?= =?UTF-8?q?feb9e5b72b10d68c0203f3086f7faac3dc2=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 | 2 +- api/api-keys/index.html | 2 +- api/asset-activities/index.html | 2 +- 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 | 2 +- .../index.html | 2 +- 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/external-assets/index.html | 2 +- api/funds-transfers/index.html | 2 +- api/http-status-codes/index.html | 5 +- api/integration-requests/index.html | 2 +- api/integrations/index.html | 2 +- api/introduction/index.html | 2 +- api/invitations/index.html | 2 +- api/legacy-payment-requests/index.html | 2 +- api/loyalty-program-memberships/index.html | 2 +- api/loyalty-programs/index.html | 2 +- api/managed-integrations/index.html | 2 +- api/media-uploads/index.html | 2 +- api/merchant-configs/index.html | 18 +++---- api/merchants/index.html | 2 +- api/object-ids/index.html | 54 +++++++++++++++++++ api/pagination/index.html | 2 +- api/patron-codes/index.html | 2 +- api/payment-requests/index.html | 10 ++-- api/profiles/index.html | 2 +- api/promotion-memberships/index.html | 2 +- api/promotions/index.html | 2 +- api/quotas/index.html | 2 +- api/scanned-codes/index.html | 2 +- api/settlements/index.html | 2 +- api/tokens/index.html | 18 +++---- api/wallets/index.html | 2 +- connections/farmlands/index.html | 2 +- guides/creating-digital-tokens/index.html | 10 ++-- guides/creating-test-money/index.html | 2 +- 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/loading-and-sending-assets/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 +- index-data.json | 2 +- index.html | 2 +- 73 files changed, 152 insertions(+), 97 deletions(-) create mode 100644 api/object-ids/index.html diff --git a/404.html b/404.html index 132986129..3f763d263 100644 --- a/404.html +++ b/404.html @@ -17,7 +17,7 @@ -
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs

HTTP Status Codes

Centrapay APIs respond with 200, 400, 401, 403, 404, or 429 HTTP status codes. +

HTTP Status Codes

Centrapay APIs respond with 200, 400, 401, 403, 404, or 429 HTTP status codes. In rare cases endpoints may respond with 5xx status codes.

Some legacy or deprecated endpoints may have exceptions to the guidelines documented here. Any such exceptions will be documented on the endpoints.

@@ -54,6 +54,7 @@
  • Check your HTTP verb is correct (POST, PUT, GET etc.).
  • Check query parameters are set correctly.
  • Check path parameters are set correctly.
    • +
  • Make sure your object IDs  API  have the correct prefix if present.

    • 401 Unauthorized

    API key or JWT is missing, expired or invalid. Go look at our Auth  API  documentation.

    diff --git a/api/integration-requests/index.html b/api/integration-requests/index.html index 2588c735e..b811c5656 100644 --- a/api/integration-requests/index.html +++ b/api/integration-requests/index.html @@ -19,7 +19,7 @@
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs
    Go to home page
    Docs

    Merchant Configs

    A Merchant Config defines the available payment options for paying a Payment Request  API .

    +

    Merchant Configs

    A Merchant Config defines the available payment options for paying a Payment Request  API .

    Merchant Config Model

    Attributes

    Response
    {
-  "id": "5ee168e8597be5002af7b454",
+  "id": "mc_5ee168e8597be5002af7b454",
   "merchantId": "5ee0c486308f590260d9a07f",
   "createdAt": "2021-11-12T01:17:46.499Z",
   "updatedAt": "2021-11-12T01:17:46.499Z",
@@ -103,7 +103,7 @@
  -H 'x-api-key: <TOKEN>'
    Response
    {
-  "id": "5ee168e8597be5002af7b454",
+  "id": "mc_5ee168e8597be5002af7b454",
   "merchantId": "5ee0c486308f590260d9a07f",
   "createdAt": "2021-11-12T01:17:46.499Z",
   "updatedAt": "2021-11-12T01:17:46.499Z",
@@ -125,7 +125,7 @@
 Copy
    Response
    [
   {
-    "id": "5ee168e8597be5002af7b454",
+    "id": "mc_5ee168e8597be5002af7b454",
     "merchantId": "5ee0c486308f590260d9a07f",
     "createdAt": "2021-09-12T01:17:46.499Z",
     "updatedAt": "2021-09-12T01:17:46.499Z",
@@ -139,7 +139,7 @@
     ]
   },
   {
-    "id": "5ee168e8597be5002af7baed",
+    "id": "mc_5ee168e8597be5002af7baed",
     "merchantId": "5ee0c486308f590260d9a07f",
     "createdAt": "2021-11-12T01:17:46.499Z",
     "updatedAt": "2021-11-12T01:17:46.499Z",
@@ -159,8 +159,8 @@
 Collapse all

    • paymentOptions

      arrayrequired

      A list of Payment Option Configs.

    • allowedRedirectUrls

      arrayexperimental

      Allowed prefixes for the redirectUrl property on Payment Requests created with this Config.

    Errors

    Request
    PUT/api/merchants/5ee0c486308f590260d9a07f/configs/5ee168e8597be5002af7baed
    curl -X PUT \
- https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f/configs/5ee168e8597be5002af7baed \
+
    Request
    PUT/api/merchants/5ee0c486308f590260d9a07f/configs/mc_5ee168e8597be5002af7baed
    curl -X PUT \
+ https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f/configs/mc_5ee168e8597be5002af7baed \
  -H 'content-type: application/json' \
  -H 'x-api-key: <TOKEN>' \
  -d '
@@ -182,7 +182,7 @@
 '
    Response
    {
-  "id": "5ee168e8597be5002af7baed",
+  "id": "mc_5ee168e8597be5002af7baed",
   "merchantId": "5ee0c486308f590260d9a07f",
   "createdAt": "2021-09-12T01:17:46.499Z",
   "updatedAt": "2021-12-12T01:17:46.499Z",
diff --git a/api/merchants/index.html b/api/merchants/index.html
index 7e24b2ce0..490a0aadd 100644
--- a/api/merchants/index.html
+++ b/api/merchants/index.html
@@ -19,7 +19,7 @@
 
 
    Go to home page
     Docs 
    Go to home page
     Docs 
    
+
+
+
+
+
    Go to home page
     Docs 
    Object IDs
    Centrapay uses identifiers (IDs) to uniquely distinguish objects within our system. Object IDs are alphanumeric strings with an optional prefix.
+Prefixes enhance readability and allow Centrapay to immediately return errors  API  to integrators when an invalid ID is used.
    
+
    Format
    
+
    Objects with prefixes will conform to the format {prefix}_{random-characters} e.g. mc_3LKQhvGUcADgqoEM3bh6pslE.
    
+
    Prefix List
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    PrefixDescription
    mc_Identifier for a Merchant Config  API  object.
    c_Identifier for a Collection  API  object.
    
\ No newline at end of file
diff --git a/api/pagination/index.html b/api/pagination/index.html
index 6124f474e..0e0c1b51a 100644
--- a/api/pagination/index.html
+++ b/api/pagination/index.html
@@ -19,7 +19,7 @@
 
 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Payment Requests
    Payment Requests represent the intention for a merchant to receive payment for goods and services. Payment Requests define the amount to be paid and the Asset Types that are acceptable for payment.
    
+
    Payment Requests
    Payment Requests represent the intention for a merchant to receive payment for goods and services. Payment Requests define the amount to be paid and the Asset Types that are acceptable for payment.
    
 
    A Payment Request is shared with, and paid by, a patron. The Payment Flows Guide has more details regarding negotiation of Payment Requests.
    
 
    Payment Requests have the following statuses:
    Response
    {
-  "id": "Xv990BzkgfoDS7bBls50pd",
+  "id": "c_Xv990BzkgfoDS7bBls50pd",
   "name": "Bread",
   "accountId": "T3y6hogYA4d612BExypWYH",
   "tokenExpiresAfter": {
@@ -121,7 +121,7 @@
   "nextPageKey": "Collection#E9eXsErwA444qFDoZt5iLA|#Collection",
   "items": [
     {
-      "id": "Xv990BzkgfoDS7bBls50pd",
+      "id": "c_Xv990BzkgfoDS7bBls50pd",
       "name": "Bread",
       "accountId": "T3y6hogYA4d612BExypWYH",
       "tokenExpiresAfter": {
@@ -150,8 +150,8 @@
 Collapse all

    • merchantId

      string

      The identifier of the Merchant  API  that is accepting the collection.

    • allowedProducts

      object

      List of Allowed Products. Required for collections of type product.

    Errors

    • INVALID_AMOUNT

      403

      One or more of the maxValue amount in the products has exceeded the maxValue amount defined on the collection.

    • REDEMPTION_CONDITION_ALREADY_EXISTS

      403

      A redemption condition for the collection and the merchant has already been created.

    Request
    POST/api/collections/NFhUgPQEYbk2EbTXAYArTX/redemption-conditions
    curl -X POST \
- https://service.centrapay.com/api/collections/NFhUgPQEYbk2EbTXAYArTX/redemption-conditions \
+

    • INVALID_AMOUNT

      403

      One or more of the maxValue amount in the products has exceeded the maxValue amount defined on the collection.

    • REDEMPTION_CONDITION_ALREADY_EXISTS

      403

      A redemption condition for the collection and the merchant has already been created.

    Request
    POST/api/collections/c_NFhUgPQEYbk2EbTXAYArTX/redemption-conditions
    curl -X POST \
+ https://service.centrapay.com/api/collections/c_NFhUgPQEYbk2EbTXAYArTX/redemption-conditions \
  -H 'content-type: application/json' \
  -H 'x-api-key: <TOKEN>' \
  -d '
@@ -181,7 +181,7 @@
    Response
    {
   "id": "1234",
   "merchantId": "36EALpZ89XpShxM2Ee9sXT",
-  "collectionId": "NFhUgPQEYbk2EbTXAYArTX",
+  "collectionId": "c_NFhUgPQEYbk2EbTXAYArTX",
   "allowedProducts": [
     {
       "sku": "100001",
@@ -216,7 +216,7 @@
  -H 'x-api-key: <TOKEN>' \
  -d '
 {
- "collectionId": "Jaim1Cu1Q55uooxSens6yk",
+ "collectionId": "c_Jaim1Cu1Q55uooxSens6yk",
  "idempotencyKey": "payment-de32dd90-b46c-11ea-93c3-83a333b86e7b",
  "externalId": "23403283262"
 }
@@ -226,7 +226,7 @@
   "id": "pe32dd90-b46c-11ea-92828sa",
   "accountId": "WRhAxxWpTKb5U7pXyxQjjP",
   "category": "token",
-  "collectionId": "Jaim1Cu1Q55uooxSens6yk",
+  "collectionId": "c_Jaim1Cu1Q55uooxSens6yk",
   "status": "active",
   "createdAt": "2021-01-17T18:00:23.000Z",
   "activeFrom": "2021-01-17T18:00:23.000Z",
diff --git a/api/wallets/index.html b/api/wallets/index.html
index aa7081642..b0758a7b0 100644
--- a/api/wallets/index.html
+++ b/api/wallets/index.html
@@ -19,7 +19,7 @@
 
 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    
 Guides
-
    Creating Digital Tokens
    Digital tokens are assets that can be exchanged for specific products or deals. Think a “Free coffee” coupon or a “50% off” voucher.
+
    Creating Digital Tokens
    Digital tokens are assets that can be exchanged for specific products or deals. Think a “Free coffee” coupon or a “50% off” voucher.
 Unlike assets such as gift cards or currency, tokens can only be spent in their entirety, all at once.
    
 
    Token Collection
    
 
    A collection is a grouping of tokens that share the same attributes and redemption conditions, e.g.
    
@@ -85,7 +85,7 @@
 
  • 
 
    Create Redemption Condition for each merchant, using the collection Id from step 1
    
 
    Redemption Conditions are created by calling the Create Redemption Condition  API  endpoint. You will need the merchant identifier for the merchantId field. The list of allowedProducts defines those products sold by the merchant that are eligible for redemption. The sku for the product will need to match the sku that is passed in with the line item when the merchant creates the payment during redemption: Create Payment Request  API .
    
-
    Request
    POST/api/collections/{collectionId}/redemption-conditions
    curl -X POST https://service.centrapay.com/api/collections/NFhUgPQEYbk2EbTXAYArTX/redemption-conditions \
+
    Request
    POST/api/collections/{collectionId}/redemption-conditions
    curl -X POST https://service.centrapay.com/api/collections/c_NFhUgPQEYbk2EbTXAYArTX/redemption-conditions \
   -H "X-Api-Key: $api_key" \
   -H "Content-Type: application/json" \
   -d '{
@@ -119,7 +119,7 @@
   -H "X-Api-Key: $api_key" \
   -H "Content-Type: application/json" \
   -d '{
-    "collectionId": "NFhUgPQEYbk2EbTXAYArTX",
+    "collectionId": "c_NFhUgPQEYbk2EbTXAYArTX",
     "idempotencyKey": "token-de32dd90-b46c-11ea-93c3-83a333b86e7b"
   }'
    • Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs 
    Go to home page
     Docs