diff --git a/404.html b/404.html index bbfa2cb87..d7fce6275 100644 --- a/404.html +++ b/404.html @@ -17,7 +17,7 @@ -
Go to home page
Docs

+

Go to home page
Docs

404

Page not found diff --git a/api/account-memberships/index.html b/api/account-memberships/index.html index 8a7a9a212..a9ae212da 100644 --- a/api/account-memberships/index.html +++ b/api/account-memberships/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

Account Memberships

An Account Membership represents a user having access to a Centrapay +

Go to home page
Docs

Account Memberships

An Account Membership represents a user having access to a Centrapay Account  API . An Account Membership has a role which grants the user access to some or all of the operations and resources within the account.

Account Membership Model

diff --git a/api/accounts/index.html b/api/accounts/index.html index 6ffb96f4d..a7a6ed168 100644 --- a/api/accounts/index.html +++ b/api/accounts/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

Accounts

An Account represents a permission boundary around Centrapay resources. +

Go to home page
Docs

Accounts

An Account represents a permission boundary around Centrapay resources. Accounts can have API Keys  API  and Account Memberships  API  which grant access to the resources.

Accounts are classified as either “individual” or “org”. Individual accounts can only have a single member and Centrapay users can only be a member of a single diff --git a/api/api-keys/index.html b/api/api-keys/index.html index b44603239..33ac50eb3 100644 --- a/api/api-keys/index.html +++ b/api/api-keys/index.html @@ -18,7 +18,7 @@

Go to home page
Docs

API Keys

API keys provide enduring access to a single Centrapay Account  API .

+
Go to home page
Docs

API Keys

API keys provide enduring access to a single Centrapay Account  API .

API Key Model

Attributes

  • accountId

    string

    The id of the Centrapay Account  API  the API Key is scoped to.

  • name

    string

    The alphanumeric name of the API key, must be unique within the account.

  • role

    string

    Supported roles are: “account-owner” and “merchant-terminal”. See Auth Permissions  API  for role details.

  • enabled

    boolean

    Flag indicating the API Key is usable for authentication.

  • createdAt

    timestamp

    When the API Key was created.

  • createdBy

    crn

    The User or API Key that created the API Key.

  • modifiedAt

    timestamp

    When the API Key was modified.

  • modifiedBy

    crn

    The User or API Key that modified the API Key.

  • version

    string

    An API Key version that is incremented when the API Key is updated.

diff --git a/api/asset-transfers/index.html b/api/asset-transfers/index.html index 5b0ec24b2..d0cd861ca 100644 --- a/api/asset-transfers/index.html +++ b/api/asset-transfers/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

Asset Transfers

An asset transfer is an asynchronous exchange of an asset or an amount to a recipient.

+
Go to home page
Docs

Asset Transfers

An asset transfer is an asynchronous exchange of an asset or an amount to a recipient.

A recipient is an existing Centrapay user or someone who can create an account to claim the asset transfer by verifying their phone number.

After an asset transfer is completed the recipientAlias, lastSentTo and diff --git a/api/asset-types/index.html b/api/asset-types/index.html index a812da5ab..6e7e66ba0 100644 --- a/api/asset-types/index.html +++ b/api/asset-types/index.html @@ -17,7 +17,7 @@ -

Go to home page
Docs

Asset Types

The following table describes the Asset Types supported for payments.

+
Go to home page
Docs

Asset Types

The following table describes the Asset Types supported for payments.

The Category column refers to the Centrapay asset type representation if applicable. When blank, the Asset is not managed by a Centrapay Account.

diff --git a/api/assets/index.html b/api/assets/index.html index 28dd89e64..902f672f9 100644 --- a/api/assets/index.html +++ b/api/assets/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

Assets

Centrapay digital assets are resources that represent the ability for a +

Go to home page
Docs

Assets

Centrapay digital assets are resources that represent the ability for a Centrapay account to perform transactions where value is exchanged. Assets can be spent to satisfy Payment Requests  API , withdrawn to a bank account via Funds Transfers  API  and sent to other Centrapay users via Asset Transfers  API .

diff --git a/api/auth/index.html b/api/auth/index.html index 6409722f7..00f5c0868 100644 --- a/api/auth/index.html +++ b/api/auth/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

Auth

Authenticating API Calls

+
Go to home page
Docs

Auth

Authenticating API Calls

API calls can be authenticated by either providing an API key in the “X-Api-Key” header or by providing a user access token in the “Authorization” header.

diff --git a/api/bank-account-approvals/index.html b/api/bank-account-approvals/index.html index ff01d7770..205e7907d 100644 --- a/api/bank-account-approvals/index.html +++ b/api/bank-account-approvals/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

Bank Account Approvals

A Bank Account Approval represents any added authorization on a Bank Account  API . +

Go to home page
Docs

Bank Account Approvals

A Bank Account Approval represents any added authorization on a Bank Account  API . This may be an approval from Centrapay or a consent from a Centrapay Account  API  owner that allows access to a third-party system. See Bank Account Approval Types.

diff --git a/api/bank-account-connection-intents/index.html b/api/bank-account-connection-intents/index.html index 10f150937..d837c8e35 100644 --- a/api/bank-account-connection-intents/index.html +++ b/api/bank-account-connection-intents/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

Bank Account Connection Intents

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.

+
Go to home page
Docs

Bank Account Connection Intents

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

  • id

    string

    The Bank Account Connection Intent’s unique identifier.

  • accountId

    string

    The id of the owning Centrapay Account  API .

  • type

    string

    The type of Bank Account Connection Intent. See Bank Account Connection Intent Types.

  • status

    string

    The current status of the Bank Account Connection Intent. Supported values are created, authorized and failed.

  • createdAt

    timestamp

    When the Bank Account Connection Intent was created.

  • createdBy

    crn

    The User or API Key that created the Bank Account Connection Intent.

  • updatedAt

    timestamp

    When the Bank Account Connection Intent was updated.

  • updatedBy

    crn

    The User or API Key that updated the Bank Account Connection Intent.

  • authorizationUrl

    string

    A URL to the third-party beginning the authorization flow.

  • test

    boolean

    A flag which is present if the intention is to connect with a Bank Account  API  used for testing.

diff --git a/api/bank-accounts/index.html b/api/bank-accounts/index.html index 3e0a49db0..d30fb54c5 100644 --- a/api/bank-accounts/index.html +++ b/api/bank-accounts/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

Bank Accounts

Bank Accounts are used to get money in and out of a Centrapay Account. Money is +

Go to home page
Docs

Bank Accounts

Bank Accounts are used to get money in and out of a Centrapay Account. Money is moved by creating “Top Up” or “Withdrawal” Funds Transfers  API .

Bank Accounts must be “direct debit authorized” before they can be used for a Top Up and they must be “verified” before top up funds are released. Bank diff --git a/api/batch-types/farmlands-external-asset/index.html b/api/batch-types/farmlands-external-asset/index.html index 16b0b4700..ac56638d1 100644 --- a/api/batch-types/farmlands-external-asset/index.html +++ b/api/batch-types/farmlands-external-asset/index.html @@ -18,7 +18,7 @@

Go to home page
Docs

Farmlands External Asset Batch

Loads Farmlands Card data into Centrapay as external assets.

+
Go to home page
Docs

Farmlands External Asset Batch

Loads Farmlands Card data into Centrapay as external assets.

diff --git a/api/batch-types/verifone-terminal-status/index.html b/api/batch-types/verifone-terminal-status/index.html index 619aeceb5..540938862 100644 --- a/api/batch-types/verifone-terminal-status/index.html +++ b/api/batch-types/verifone-terminal-status/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

Verifone Terminal Status Batch

Performs a bulk update to the current status for connected Verifone NZ payment terminals. See the Batch  API  resource for how to submit an instance of this batch.

+
Go to home page
Docs

Verifone Terminal Status Batch

Performs a bulk update to the current status for connected Verifone NZ payment terminals. See the Batch  API  resource for how to submit an instance of this batch.

diff --git a/api/batches/index.html b/api/batches/index.html index de9a94931..90d078a98 100644 --- a/api/batches/index.html +++ b/api/batches/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

Batches

Batches enable bulk loading of resource onto the Centrapay platform.

+
Go to home page
Docs

Batches

Batches enable bulk loading of resource onto the Centrapay platform.

Batch Model

Attributes

  • id

    string

    The Batch’s unique identifier.

  • status

    string

    The current Lifecycle Stage of the batch.

  • type

    string

    Batch Type id used to describe the batch content.

  • totalCount

    bignumber

    The number of items processed.

  • errorCount

    bignumber

    Total Error counted.

  • errors

    array

    Error list for the batch.

  • test

    boolean

    true if the batch is for testing purposes only.

diff --git a/api/businesses/index.html b/api/businesses/index.html index 71217f74a..209ec5bf4 100644 --- a/api/businesses/index.html +++ b/api/businesses/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

Businesses

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

+
Go to home page
Docs

Businesses

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

Business Model

Attributes

  • id

    string

    The unique identifier.

  • accountId

    string

    The Centrapay accountId for an org account.

  • accountName

    string

    The Centrapay account name for an org account.

  • nzbn

    string

    The unique NZBN identifier.

  • name

    string

    Legal name recorded in the Companies Register.

  • tradingName

    string

    Trading name recorded in the Companies Register.

  • companyNumber

    string

    Company number recorded in the Companies Register.

  • createdAt

    timestamp

    When the Business was created.

  • updatedAt

    timestamp

    When the Business was updated.

  • createdBy

    crn

    The User or API Key that created the Business.

  • updatedBy

    crn

    The User or API Key that updated the Business.

  • taxNumber

    object

    The value-added tax configuration for the Business. See Tax Number Model.

  • onboardingStatus

    crn

    The onboarding status of the Business. See Onboarding Statuses for possible values.

  • onboardingStatusReason

    string

    The reason associated with the Onboarding Status. See Onboarding Status Reasons for possible values.

diff --git a/api/data-types/index.html b/api/data-types/index.html index 888132a26..5206b6177 100644 --- a/api/data-types/index.html +++ b/api/data-types/index.html @@ -17,7 +17,7 @@ -
Go to home page
Docs

Data Types

Timestamp

+
Go to home page
Docs

Data Types

Timestamp

A point in time, usually with millisecond precision, represented as an ISO 8601 date string (eg “2021-06-11T02:51:11.000Z”). Timestamps are in the UTC timezone as denoted by the “Z” suffix.

diff --git a/api/external-assets/index.html b/api/external-assets/index.html index f8f0566b7..6caf11160 100644 --- a/api/external-assets/index.html +++ b/api/external-assets/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

External Assets

External assets are Assets  API  which are issued by a third-party.

+
Go to home page
Docs

External Assets

External assets are Assets  API  which are issued by a third-party.

POST/api/external-assets

Load an External Asset

Load an asset from a supported third-party issuer. Asset details will be obtained from the issuer.

Attributes

  • accountId

    stringrequired

    The Centrapay account which will own the asset.

  • category

    stringrequired

    The category an asset will be grouped by. Valid values: “giftcard”.

  • type

    stringrequired

    The Centrapay ledger corresponding to the asset. Valid values: “epay.nzd.main”, “epay.nzd.test”.

  • issuer

    stringrequired

    The asset issuer. Valid values: “ezipay”.

  • externalId

    stringrequired

    The issuer’s asset id such as card number.

  • pin

    string

    Additional secret required by the issuer for loading or redeeming the asset.

  • description

    string

    Description of the asset, eg: “$60 Acme Giftcard”.

Errors

  • UNKNOWN_ASSET

    403

    Asset id or PIN is incorrect.

  • DUPLICATE_ASSET

    403

    Asset already claimed by another account.

  • UNSUPPORTED_ASSET_TYPE

    403

    Unsupported asset type, origin, or issuer.

  • DENIED_BY_ASSET_PROVIDER

    403

    Asset exists, but is not enabled for use through Centrapay.

  • EXPIRED_BY_ASSET_PROVIDER

    403

    Asset exists, but it’s expired.

Request
POST/api/external-assets
    curl -X POST https://service.centrapay.com/api/external-assets \
   -H "X-Api-Key: $api_key" \
diff --git a/api/funds-transfers/index.html b/api/funds-transfers/index.html
index 9ed8ee25c..d86aa4c14 100644
--- a/api/funds-transfers/index.html
+++ b/api/funds-transfers/index.html
@@ -18,7 +18,7 @@
 
 
 
Go to home page
 Docs 
Funds Transfers
A funds transfer represents either a top up to or a withdrawal from a Centrapay wallet. Topping up a wallet consists of making a bank transfer from the user’s bank account to Centrapay. Once Centrapay has verified the transfer was successful a user will be given credit on their Centrapay wallet equal to the amount of the bank transfer.

+
Go to home page
 Docs 
Funds Transfers
A funds transfer represents either a top up to or a withdrawal from a Centrapay wallet. Topping up a wallet consists of making a bank transfer from the user’s bank account to Centrapay. Once Centrapay has verified the transfer was successful a user will be given credit on their Centrapay wallet equal to the amount of the bank transfer.

 

 
POST/api/topups
Create a Top Up
This endpoint allows you to create a topup.
Attributes
  • amount
    bignumberrequired
    Total amount of the transaction in cents
  • assetId
    stringrequired
    The id of the asset
  • bankAccountId
    stringrequired
    The id of the bank account
Errors
  • BANK_AUTHORITY_WALLET_MISMATCH
    403
    The wallet and the bank account for the top up request do not belong to the same account.
  • MAX_INFLIGHT_TOPUPS_EXCEEDED
    403
    The bank account already has ten pending top ups, which is the maximum a bank authority can have at any one time.
  • MAX_INFLIGHT_TOPUP_AMOUNT_EXCEEDED
    403
    The top up can not be created because it is above the max amount of funds a bank account can have pending at any one time. The max amount is $1000.00 for verified bank accounts and $100.00 for non-verified bank accounts.
  • QUOTA_EXCEEDED
    403
    The topup exceeds one or more top up quota limits. See Quota Error Response  API .
  • DIRECT_DEBIT_NOT_AUTHORIZED
    403
    Bank account requires authorization for top up. See bank accounts direct debit endpoint  API .
  • INVALID_WALLET_TYPE
    403
    The wallet type does not support top ups. See settlement wallets  API .
  • BANK_ACCOUNT_TYPE_NOT_CONFIGURED_FOR_TOPUP
    403
    The bank account type is not configured for topups. Only centrapay type bank accounts are configured.
Request
POST/api/topups
    curl -X POST https://service.centrapay.com/api/topups \
   -H "X-Api-Key: $api_key" \
diff --git a/api/http-status-codes/index.html b/api/http-status-codes/index.html
index 0726ad8af..49e2129c6 100644
--- a/api/http-status-codes/index.html
+++ b/api/http-status-codes/index.html
@@ -18,7 +18,7 @@
 
 
 
Go to home page
 Docs 
HTTP Status Codes
Centrapay APIs respond with 200, 400, 401, 403, 404, or 429 HTTP status codes.
+
Go to home page
 Docs 
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.

diff --git a/api/integration-requests/index.html b/api/integration-requests/index.html
index 0f789da73..5920de3e3 100644
--- a/api/integration-requests/index.html
+++ b/api/integration-requests/index.html
@@ -18,10 +18,10 @@
 
 
 
Go to home page
 Docs 
Integration Requests
An Integration Request allows Centrapay users to request the creation of an Integration  API  on a Centrapay Account.

+
Go to home page
 Docs 
Integration Requests
An Integration Request allows Centrapay users to request the creation of an Integration  API  on a Centrapay Account.

 
Integration Request Model

 
Attributes

-
  • id
    string
    The unique identifier of the Integration Request.
  • accountId
    string
    The Integration Request’s owning Centrapay Account  API  id.
  • merchantId
    string
    The Merchant  API  id for the Integration Request.
  • type
    object
    The type of the Integration Request. Refer to Integration Types.
  • status
    string
    The current status of the Integration Request. Supported values are active, available, pending, rejected and disabled.
  • terminalId
    string
    Epay terminalId for the Integration Request. Required if type is epay.
  • terminal
    object
    The terminal configuration. Required for all terminal vendors except Vista. Refer to Terminal.
  • product
    object
    The requested Epay gift card types to support. Refer to Product.

+
  • id
    string
    The unique identifier of the Integration Request.
  • accountId
    string
    The Integration Request’s owning Centrapay Account  API  id.
  • merchantId
    string
    The Merchant  API  id for the Integration Request.
  • type
    object
    The type of the Integration Request. Refer to Integration Types.
  • status
    string
    The current status of the Integration Request. Supported values are active, available, pending, rejected and disabled.
  • terminalId
    string
    Epay terminalId for the Integration Request. Required if type is epay.
  • terminal
    object
    The terminal configuration. Required for all terminal vendors except Vista. Refer to Terminal.
  • product
    object
    The requested Epay gift card types to support. Refer to Product.
  • createdAt
    timestamp
    When the Integration Request was created.
  • createdBy
    crn
    The User or API Key that created the Integration Request.
  • updatedAt
    timestamp
    When the Integration Request was updated.
  • updatedBy
    crn
    The User or API Key that updated the Integration Request.
  • notifiedAt
    timestamp
    When the Integration Request was submitted to the terminal provider in order to enable the terminal for Centrapay acceptance.

 
Terminal

 
  • terminalId
    string
    The software or logical id of the payment terminal.
  • deviceId
    string
    The hardware id or serial number of the payment terminal.

 

@@ -116,13 +116,14 @@
   "updatedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
   "product": {
     "name": "koha-card"
-  }
+  },
+  "notifiedAt": "2020-06-13T05:00:00.000Z"
 }
   

 

-
GET/api/integration-requests
Search Merchants
Returns a paginated  API  response of Integration Requests.
Query Parameters
  • accountId
    string
    The Integration Request’s owning Centrapay Account id. Required unless caller has global read access permission.
  • type
    string
    The type of Integration Request.
  • pending
    boolean
    When set to true, only include Integration Requests with pending status.
Request
GET/api/integration-requests
    curl -G https://service.centrapay.com/api/integration-requests \
+
GET/api/integration-requests
Search Integration Requests
Returns a paginated  API  response of Integration Requests.
Query Parameters
  • accountId
    string
    The Integration Request’s owning Centrapay Account id. Required unless caller has global read access permission.
  • type
    string
    The type of Integration Request.
  • pending
    boolean
    When set to true, only include Integration Requests with pending status.
Request
GET/api/integration-requests
    curl -G https://service.centrapay.com/api/integration-requests \
   -H "X-Api-Key: $api_key" \
   -d type=epay \
   -d pending=true \
diff --git a/api/integrations/index.html b/api/integrations/index.html
index cf02a681c..b63fd4f5c 100644
--- a/api/integrations/index.html
+++ b/api/integrations/index.html
@@ -17,4 +17,4 @@
 
 
 
-
Go to home page
 Docs 

\ No newline at end of file
+
Go to home page
 Docs 

\ No newline at end of file
diff --git a/api/introduction/index.html b/api/introduction/index.html
index e43e1702a..8d350f8cc 100644
--- a/api/introduction/index.html
+++ b/api/introduction/index.html
@@ -17,7 +17,7 @@
 
 
 
-
Go to home page
 Docs 
Introduction
The Centrapay API is an RMM
+
Go to home page
 Docs 
Introduction
The Centrapay API is an RMM
 level 2 RESTful web service which expresses operations in terms of HTTP verbs on
 resource-oriented URLs. API endpoint definitions in these docs are grouped by resource
 type along with definitions for the associated resource types.

diff --git a/api/invitations/index.html b/api/invitations/index.html
index e2e85a85d..68840f3e1 100644
--- a/api/invitations/index.html
+++ b/api/invitations/index.html
@@ -18,7 +18,7 @@
 
 
 
Go to home page
 Docs 
Invitations
An Invitation can be used to allow users to claim ownership of a resource on the Centrapay platform.

+
Go to home page
 Docs 
Invitations
An Invitation can be used to allow users to claim ownership of a resource on the Centrapay platform.

 
Invitation Model

 
Attributes

 
  • id
    string
    The Invitation’s unique identifier.
  • code
    string
    The Invitation code.
  • type
    string
    The type of invitation. Supported values are account-membership.
  • resourceId
    string
    The id of the related resource.
  • resourceType
    string
    The type of the related resource. Supported values are account.
  • expiresAt
    timestamp
    When the Invitation expires.
  • createdAt
    timestamp
    When the Invitation was created.
  • createdBy
    crn
    The User or API Key that created the Invitation.
  • updatedAt
    timestamp
    When the Invitation was updated.
  • updatedBy
    crn
    The User or API Key that updated the Invitation.
  • accepted
    boolean
    A flag indicating whether the Invitation has been accepted.
  • acceptedAt
    timestamp
    When the Invitation was accepted.
  • acceptedBy
    crn
    The User or API Key that accepted the Invitation.
  • acceptedByAccountId
    string
    The Account  API  id of the user accepting the Invitation.
  • recipientAlias
    string
    The email address of the user accepting the Invitation.
  • params
    object
    Params dependent on the Invitation type.
  • status
    string
    The status of the invitation. Possible values are created, sent, accepted and revoked.

diff --git a/api/legacy-payment-requests/index.html b/api/legacy-payment-requests/index.html
index 994cc36be..5345289d1 100644
--- a/api/legacy-payment-requests/index.html
+++ b/api/legacy-payment-requests/index.html
@@ -18,7 +18,7 @@
 
 
 
Go to home page
 Docs 
Legacy Payment Requests
Centrapay Payment Requests are serviced via two sets of endpoints; the “next”
+
Go to home page
 Docs 
Legacy Payment Requests
Centrapay Payment Requests are serviced via two sets of endpoints; the “next”
 version (documented Payment Requests  API ) and the “legacy” version
 (documented on this page). These endpoints are deprecated.

 

diff --git a/api/managed-integrations/index.html b/api/managed-integrations/index.html
index d7964d289..8adec430c 100644
--- a/api/managed-integrations/index.html
+++ b/api/managed-integrations/index.html
@@ -18,7 +18,7 @@
 
 
 
Go to home page
 Docs 
Managed Integrations
A Managed Integration is an Integration  API   which a third party can control.

+
Go to home page
 Docs 
Managed Integrations
A Managed Integration is an Integration  API   which a third party can control.

 
Managed Integration Model

 
Attributes

 
  • id
    string
    The Managed Integration’s unique identifier.
  • type
    string
    The type of Managed Integration. Supported types are paypal-referral.
  • enabled
    boolean
    Flag indicating whether the Managed Integration should become active or inactive.
  • status
    string
    Current status of the Managed Integration. Supported values are created, pending, provisioning, active, inactive and archived.
  • externalId
    string
    Field used to reference an id from an external system.
  • params
    object
    Params depending on the Managed Integration type.
  • createdAt
    timestamp
    When the Managed Integration was created.
  • createdBy
    crn
    The User or API Key that created the Managed Integration.
  • updatedAt
    timestamp
    When the Managed Integration was updated.
  • updatedBy
    crn
    The User or API Key that updated the Managed Integration.
  • claimedByAccountId
    string
    Centrapay account id used to claim the Managed Integration.
  • claimedBy
    crn
    The User or API Key that claimed the Managed Integration.
  • claimedAt
    timestamp
    When the Managed Integration was claimed.
  • invitation
    object
    A summary of the associated Invitation  API . See Invitation Summary.
  • inProgress
    boolean
    Flag indicating whether a status transition is in progress.
  • test
    boolean
    A flag which is present if the Managed Integration is for testing.

diff --git a/api/media-uploads/index.html b/api/media-uploads/index.html
index 5ea80fcb4..b82f3bb34 100644
--- a/api/media-uploads/index.html
+++ b/api/media-uploads/index.html
@@ -18,7 +18,7 @@
 
 
 
Go to home page
 Docs 
Media Uploads
Media Upload Model

+
Go to home page
 Docs 
Media Uploads
Media Upload Model

 
Attributes

 
  • id
    string
    The Media Upload’s unique identifier.
  • accountId
    string
    The Media Upload’s owning Centrapay Account id.
  • mimeType
    string
    The media (MIME) type of the upload.
  • fileName
    string
    The file name of the upload.
  • createdAt
    timestamp
    When the Media Upload was created.
  • createdBy
    crn
    The User or API Key that created the Media Upload.
  • updatedAt
    timestamp
    When the Media Upload was updated.
  • updatedBy
    crn
    The User or API Key that updated the Media Upload.
  • uploadUrl
    string
    A presigned URL that gives users time-limited permission to upload media.

 

diff --git a/api/merchant-configs/index.html b/api/merchant-configs/index.html
index 0fb1519c0..bfbc7c863 100644
--- a/api/merchant-configs/index.html
+++ b/api/merchant-configs/index.html
@@ -18,7 +18,7 @@
 
 
 
Go to home page
 Docs 
Merchant Configs
A Merchant Config defines the available payment options for paying a Payment Request  API .

+
Go to home page
 Docs 
Merchant Configs
A Merchant Config defines the available payment options for paying a Payment Request  API .

 
Merchant Config Model

 
Attributes

 
  • paymentOptions
    array
    Array of Payment Option Configs.
  • createdAt
    timestamp
    When the Merchant Config was created.
  • createdBy
    crn
    The User or API Key that created the Merchant Config.
  • updatedAt
    timestamp
    When the Merchant Config was updated.
  • updatedBy
    crn
    The User or API Key that updated the Merchant Config.
  • allowedRedirectUrls
    arrayexperimental
    Allowed prefixes for the redirectUrl property on Payment Requests created with this Config.

diff --git a/api/merchants/index.html b/api/merchants/index.html
index 05592b6dc..0d59c5c9d 100644
--- a/api/merchants/index.html
+++ b/api/merchants/index.html
@@ -18,7 +18,7 @@
 
 
 
Go to home page
 Docs 
Merchants
A merchant is an initiator of Payment Requests  API . A Merchant has Merchant Configs  API 
+
Go to home page
 Docs 
Merchants
A merchant is an initiator of Payment Requests  API . A Merchant has Merchant Configs  API 
 which define the payment methods available for a Payment Request.

 
Merchant Model

 
Attributes

diff --git a/api/pagination/index.html b/api/pagination/index.html
index 9145db286..406a00b7f 100644
--- a/api/pagination/index.html
+++ b/api/pagination/index.html
@@ -18,7 +18,7 @@
 
 
 
Go to home page
 Docs 
Pagination
Pagination allows a listing endpoint to return a subset of results. The goal is to reduce memory
+
Go to home page
 Docs 
Pagination
Pagination allows a listing endpoint to return a subset of results. The goal is to reduce memory
 usage and speed up page rendering.

 
To retrieve the next page, a pageKey can be supplied. Typically this will be the nextPageKey
 returned from your previous query.

diff --git a/api/patron-codes/index.html b/api/patron-codes/index.html
index 66a9f8313..d7fa02901 100644
--- a/api/patron-codes/index.html
+++ b/api/patron-codes/index.html
@@ -18,7 +18,7 @@
 
 
 
Go to home page
 Docs 
Patron Codes
A Patron Code is an alternative to presenting a QR code where that option isn’t available.

+
Go to home page
 Docs 
Patron Codes
A Patron Code is an alternative to presenting a QR code where that option isn’t available.

 
Patron Code Model

 
Attributes

 
  • id
    string
    The Patron Code’s unique identifier.
  • barcode
    string
    ✩ Field to display in barcode format.
  • createdAt
    timestamp
    Date when the Patron Code was created.
  • expiresAt
    timestamp
    Date when the Patron Code will expire.
  • appName
    stringdeprecated
    The app used to create the Patron Code.
  • accountId
    string
    The account id of the creator of the patron code.
  • testScenarioName
    string
    The Test Scenario Name of the Patron Code.

diff --git a/api/payment-requests/index.html b/api/payment-requests/index.html
index 75735ebe3..573a443dc 100644
--- a/api/payment-requests/index.html
+++ b/api/payment-requests/index.html
@@ -18,7 +18,7 @@
 
 
 
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.

+
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.

 
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: