An Account Membership represents a user having access to a Centrapay +
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
Accounts
An Account represents a permission boundary around Centrapay resources. +
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 0740fbf6b..b31b45b60 100644 --- a/api/api-keys/index.html +++ b/api/api-keys/index.html @@ -12,13 +12,13 @@ r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv; a.appendChild(r); })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv='); - +
API Keys
API keys provide enduring access to a single Centrapay Account API .
+API Keys
API keys provide enduring access to a single Centrapay Account API .
API Key Model
Attributes
accountId
stringThe id of the Centrapay Account API the API Key is scoped to.
name
stringThe alphanumeric name of the API key, must be unique within the account.
role
stringSupported roles are: “account-owner” and “merchant-terminal”. See Auth Permissions API for role details.
enabled
booleanFlag indicating the API Key is usable for authentication.
createdAt
timestampWhen the API Key was created.
createdBy
crnThe User or API Key that created the API Key.
modifiedAt
timestampWhen the API Key was modified.
modifiedBy
crnThe User or API Key that modified the API Key.
version
stringAn API Key version that is incremented when the API Key is updated.
Asset Transfers
An asset transfer is an asynchronous exchange of an asset or an amount to a recipient.
+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 83dfc5c90..49c51777d 100644 --- a/api/asset-types/index.html +++ b/api/asset-types/index.html @@ -12,12 +12,12 @@ r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv; a.appendChild(r); })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv='); - + -
Asset Types
The following table describes the Asset Types supported for payments.
+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 a83402700..f7497a30b 100644 --- a/api/assets/index.html +++ b/api/assets/index.html @@ -12,13 +12,13 @@ r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv; a.appendChild(r); })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv='); - +Assets
Centrapay digital assets are resources that represent the ability for a +
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 a0e232d0b..985db1d0b 100644 --- a/api/auth/index.html +++ b/api/auth/index.html @@ -12,13 +12,13 @@ r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv; a.appendChild(r); })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv='); - +Auth
Authenticating API Calls
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 f9dd53974..50cfb3090 100644 --- a/api/bank-account-approvals/index.html +++ b/api/bank-account-approvals/index.html @@ -12,13 +12,13 @@ r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv; a.appendChild(r); })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv='); - +Bank Account Approvals
A Bank Account Approval represents any added authorization on a Bank Account API . +
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 288873ea0..77b279da1 100644 --- a/api/bank-account-connection-intents/index.html +++ b/api/bank-account-connection-intents/index.html @@ -12,13 +12,13 @@ r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv; a.appendChild(r); })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv='); - +
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 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
stringThe Bank Account Connection Intent’s unique identifier.
accountId
stringThe id of the owning Centrapay Account API .
type
stringThe type of Bank Account Connection Intent. See Bank Account Connection Intent Types.
status
stringThe current status of the Bank Account Connection Intent. Supported values are
created,authorizedandfailed.createdAt
timestampWhen the Bank Account Connection Intent was created.
createdBy
crnThe User or API Key that created the Bank Account Connection Intent.
updatedAt
timestampWhen the Bank Account Connection Intent was updated.
updatedBy
crnThe User or API Key that updated the Bank Account Connection Intent.
authorizationUrl
stringA URL to the third-party beginning the authorization flow.
test
booleanA flag which is present if the intention is to connect with a Bank Account API used for testing.