curl -X POST https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/members \ POST /api/accounts/{accountId}/members
This endpoint allows you to add or update the membership of a user to an account.
userId string required The id of the user the Membership belongs to.
role string required The role governing Membership permissions.
Request
POST /api/accounts/{accountId}/members
curl -X POST https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/members \ -H " X-Api-Key: $api_key " \ -H " Content-Type: application/json " \ -d ' {
-
GET /api/accounts/{accountId}/members
This endpoint allows you to retrieve the list memberships to an account.
No attributes.
Request
GET /api/accounts/{accountId}/members
curl https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/members \ GET /api/accounts/{accountId}/members
This endpoint allows you to retrieve the list memberships to an account.
No attributes.
Request
GET /api/accounts/{accountId}/members
curl https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/members \ -H " X-Api-Key: $api_key "
Copy
@@ -81,13 +81,13 @@
Copy
DELETE /api/accounts/{accountId}/members/{userId}
This endpoint allows you to revoke a users membership to an account.
No attributes.
Request
DELETE /api/accounts/{accountId}/members/{userId}
curl -X DELETE https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/members/45dwes-rf4h55-tyf45s-6st4gd \ DELETE /api/accounts/{accountId}/members/{userId}
This endpoint allows you to revoke a users membership to an account.
No attributes.
Request
DELETE /api/accounts/{accountId}/members/{userId}
curl -X DELETE https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/members/45dwes-rf4h55-tyf45s-6st4gd \ -H " X-Api-Key: $api_key "
Copy
GET /api/account-memberships
This endpoint allows you to retrieve the accounts that the authenticated subject is a member of.
No attributes.
Request
GET /api/account-memberships
curl https://service.centrapay.com/api/account-memberships \ GET /api/account-memberships
This endpoint allows you to retrieve the accounts that the authenticated subject is a member of.
No attributes.
Request
GET /api/account-memberships
curl https://service.centrapay.com/api/account-memberships \ -H " X-Api-Key: $api_key "
Copy
@@ -103,7 +103,7 @@
Copy
GET /api/users/{userId}/account-memberships
This endpoint allows you to retrieve the accounts that a user is a member of.
No attributes.
Request
GET /api/users/{userId}/account-memberships
curl https://service.centrapay.com/api/users/1234/account-memberships \ GET /api/users/{userId}/account-memberships
This endpoint allows you to retrieve the accounts that a user is a member of.
No attributes.
Request
GET /api/users/{userId}/account-memberships
curl https://service.centrapay.com/api/users/1234/account-memberships \ -H " X-Api-Key: $api_key "
Copy
diff --git a/api/accounts/index.html b/api/accounts/index.html
index e1972eed9..9ce824dc5 100644
--- a/api/accounts/index.html
+++ b/api/accounts/index.html
@@ -12,25 +12,25 @@
r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
a.appendChild(r);
})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
- Reference Learn about core features
Connections For our partners
An Account represents a permission boundary around Centrapay resources.
+
Reference Learn about core features
Connections For our partners
An Account represents a permission boundary around Centrapay resources.
Accounts can have API Keys API Account Memberships API
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
individual account.
-
id string
type string Account type, must be either ‘org’ or ‘individual’.
name string The display name of the Account.
region string The region that the Account will operate in.
test boolean A flag which is only present if the Account is for testing.
When the Account was created.
When the Account was updated.
The User or API Key that created the Account.
The User or API Key that updated the Account.
subscriptions array
id string
type string Account type, must be either ‘org’ or ‘individual’.
name string The display name of the Account.
region string The region that the Account will operate in.
test boolean A flag which is only present if the Account is for testing.
When the Account was created.
When the Account was updated.
The User or API Key that created the Account.
The User or API Key that updated the Account.
subscriptions array
-
name string The name of the Subscription.
name string The name of the Subscription.
This endpoint allows you to create an Account.
name string required
type string required Account type, must be either “org” or “individual”.
owner string Id of user to add as member with “account-owner” role.
test boolean A flag indicating if the Account is for testing.
region string The region that the Account will operate in. Required for ‘org’ Accounts, not allowed for ‘individual’ Accounts. Can be “NZ”, “AU”, or “US”.
Request
POST /api/accounts
curl -X POST https://service.centrapay.com/api/accounts \
This endpoint allows you to create an Account.
name string required
type string required Account type, must be either “org” or “individual”.
owner string Id of user to add as member with “account-owner” role.
test boolean A flag indicating if the Account is for testing.
region string The region that the Account will operate in. Required for ‘org’ Accounts, not allowed for ‘individual’ Accounts. Can be “NZ”, “AU”, or “US”.
Request
POST /api/accounts
curl -X POST https://service.centrapay.com/api/accounts \ -H " X-Api-Key: $api_key " \ -H " Content-Type: application/json " \ -d ' {
-
GET /api/accounts/{accountId}
This endpoint allows you to retrieve an Account.
No attributes.
Request
GET /api/accounts/{accountId}
curl https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk \ GET /api/accounts/{accountId}
This endpoint allows you to retrieve an Account.
No attributes.
Request
GET /api/accounts/{accountId}
curl https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk \ -H " X-Api-Key: $api_key "
Copy
@@ -75,7 +75,7 @@
Copy
PUT /api/accounts/{accountId}
This endpoint allows you to update an account.
Request
PUT /api/accounts/{accountId}
curl -X PUT https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk \ PUT /api/accounts/{accountId}
This endpoint allows you to update an account.
Request
PUT /api/accounts/{accountId}
curl -X PUT https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk \ -H " X-Api-Key: $api_key " \ -H " Content-Type: application/json " \ -d ' {
-
PUT /api/accounts/{accountId}/subscriptions
This endpoint allows you to update the subscriptions on an account.
Request
PUT /api/accounts/{accountId}/subscriptions
curl -X PUT https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/subscriptions \ PUT /api/accounts/{accountId}/subscriptions
This endpoint allows you to update the subscriptions on an account.
Request
PUT /api/accounts/{accountId}/subscriptions
curl -X PUT https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/subscriptions \ -H " X-Api-Key: $api_key " \ -H " Content-Type: application/json " \ -d ' { Reference Learn about core features
Connections For our partners
API keys provide enduring access to a single Centrapay Account API
+Reference Learn about core features
Connections For our partners
API keys provide enduring access to a single Centrapay Account API
-
accountId string The id of the Centrapay Account API
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
enabled boolean Flag indicating the API Key is usable for authentication.
When the API Key was created.
The User or API Key that created the API Key.
When the API Key was modified.
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.
accountId string The id of the Centrapay Account API
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
enabled boolean Flag indicating the API Key is usable for authentication.
When the API Key was created.
The User or API Key that created the API Key.
When the API Key was modified.
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.
POST /api/accounts/{accountId}/api-keys
This endpoint allows you to create an API key.
name string required The alphanumeric name of the API key, must be unique within the account.
role string required Supported roles are: “account-owner” and “merchant-terminal”. See Auth Permissions API
Request
POST /api/accounts/{accountId}/api-keys
curl -X POST https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \ POST /api/accounts/{accountId}/api-keys
This endpoint allows you to create an API key.
name string required The alphanumeric name of the API key, must be unique within the account.
role string required Supported roles are: “account-owner” and “merchant-terminal”. See Auth Permissions API
Request
POST /api/accounts/{accountId}/api-keys
curl -X POST https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \ -H " X-Api-Key: $api_key " \ -H " Content-Type: application/json " \ -d ' {
-
GET /api/accounts/{accountId}/api-keys
This endpoint allows you to list all API Keys for an Account.
No attributes.
Request
GET /api/accounts/{accountId}/api-keys
curl -X GET https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \ GET /api/accounts/{accountId}/api-keys
This endpoint allows you to list all API Keys for an Account.
No attributes.
Request
GET /api/accounts/{accountId}/api-keys
curl -X GET https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \ -H " X-Api-Key: $api_key "
Copy
@@ -80,7 +80,7 @@
Copy
PUT /api/accounts/{accountId}/api-keys/{apiKeyName}
This endpoint allows you to enable or disable an API key.
enabled boolean required Flag indicating the API Key is usable for authentication.
Request
PUT /api/accounts/{accountId}/api-keys/{apiKeyName}
curl -X PUT https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys/MyAPIkey \ PUT /api/accounts/{accountId}/api-keys/{apiKeyName}
This endpoint allows you to enable or disable an API key.
enabled boolean required Flag indicating the API Key is usable for authentication.
Request
PUT /api/accounts/{accountId}/api-keys/{apiKeyName}
curl -X PUT https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys/MyAPIkey \ -H " X-Api-Key: $api_key " \ -H " Content-Type: application/json " \ -d ' { Reference Learn about core features
Connections For our partners
An asset transfer is an asynchronous exchange of an asset or an amount to a recipient.
+Reference Learn about core features
Connections For our partners
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
message fields are scrubbed to avoid storing PII.
Asset Transfer goes through different lifecycle stages.
@@ -65,9 +65,9 @@
State Description created Asset transfer successfully created sent Asset transfer notification (sms, email) was sent to a new user expired Asset transfer expired as new user didn’t create his account and claimed the asset. This is very short lived state returned Asset transfer expired and was returned to original owner claimed Asset transfer was successfully completed cancelled Asset transfer was cancelled.
Transfer an asset to a recipient. Some assets can be transfered only in whole
+
Transfer an asset to a recipient. Some assets can be transfered only in whole
(eg giftcards or tokens) while others can be transfered only in part (eg money).
Some assets can be transferred without supplying a recipient. A url field will be
-returned in these cases. The url will link to a page to claim the asset.
INSUFFICIENT_WALLET_BALANCE 403 The value of the asset-transfer exceeds the balance on the wallet.
QUOTA_EXCEEDED 403 The transfer exceeds one or more spend quota limits. See Quota Error Response API
ASSET_NOT_ACTIVE 403 The asset is not active and cannot be transferred.
RECIPIENT_MISSING 403 The asset must be transferred with a recipient supplied.
Request
POST /api/assets/asset-transfers
curl -X POST https://service.centrapay.com/api/asset-transfers \ url will link to a page to claim the asset.
INSUFFICIENT_WALLET_BALANCE 403 The value of the asset-transfer exceeds the balance on the wallet.
QUOTA_EXCEEDED 403 The transfer exceeds one or more spend quota limits. See Quota Error Response API
ASSET_NOT_ACTIVE 403 The asset is not active and cannot be transferred.
RECIPIENT_MISSING 403 The asset must be transferred with a recipient supplied.
Request
POST /api/assets/asset-transfers
curl -X POST https://service.centrapay.com/api/asset-transfers \ -H " X-Api-Key: $api_key " \ -H " Content-Type: application/json " \ -d ' {
-
GET /api/asset-transfers/{assetTransferId}
No Attributes.
Request
GET /api/assets/asset-transfers/{assetTransferId}
curl https://service.centrapay.com/api/asset-transfers/M7Kn2stAxNa6ri7h \ GET /api/asset-transfers/{assetTransferId}
No Attributes.
Request
GET /api/assets/asset-transfers/{assetTransferId}
curl https://service.centrapay.com/api/asset-transfers/M7Kn2stAxNa6ri7h \ -H " X-Api-Key: $api_key "
Copy
@@ -120,7 +120,7 @@
Copy
GET /api/asset-transfers/{assetTransferId}/summary
No Attributes.
Request
GET /api/assets/asset-transfers/{assetTransferId}/summary
curl https://service.centrapay.com/api/asset-transfers/M7Kn2stAxNa6ri7h/summary GET /api/asset-transfers/{assetTransferId}/summary
No Attributes.
Request
GET /api/assets/asset-transfers/{assetTransferId}/summary
curl https://service.centrapay.com/api/asset-transfers/M7Kn2stAxNa6ri7h/summary
Copy
Response
{
-
POST /api/asset-transfers/{assetTransferId}/claim
Claim the asset transfer for the caller’s authorised account.
No Attributes.
Request
POST /api/asset-transfers/{assetTransferId}/claim
curl https://service.centrapay.com/api/asset-transfers/M7Kn2stAxNa6ri7h/claim POST /api/asset-transfers/{assetTransferId}/claim
Claim the asset transfer for the caller’s authorised account.
No Attributes.
Request
POST /api/asset-transfers/{assetTransferId}/claim
curl https://service.centrapay.com/api/asset-transfers/M7Kn2stAxNa6ri7h/claim
Copy
Response
{
-
POST /api/me/resolve-claimable-assets
When you send another centrapay user cash or assets, they’re automatically assigned to them.
-However, if they’re not signed up yet then these assets are not immediately assigned.
If unclaimed, asset transfers are returned after 2 weeks.
New accounts should call this endpoint to allocate assets that you’ve been sent.
No Attributes.
Request
POST /api/me/resolve-claimable-assets
curl -X POST https://service.centrapay.com/api/me/resolve-claimable-assets \ POST /api/me/resolve-claimable-assets
When you send another centrapay user cash or assets, they’re automatically assigned to them.
+However, if they’re not signed up yet then these assets are not immediately assigned.
If unclaimed, asset transfers are returned after 2 weeks.
New accounts should call this endpoint to allocate assets that you’ve been sent.
No Attributes.
Request
POST /api/me/resolve-claimable-assets
curl -X POST https://service.centrapay.com/api/me/resolve-claimable-assets \ -H " X-Api-Key: $api_key "
Copy
@@ -168,7 +168,7 @@
Copy
Returns a paginated API
recipientAccountId string The Centrapay Account id of the recipient.
senderAccountId string The Centrapay Account id of the sender.
Request
GET /api/asset-transfers
curl -G https://service.centrapay.com/api/asset-transfers \
Returns a paginated API
recipientAccountId string The Centrapay Account id of the recipient.
senderAccountId string The Centrapay Account id of the sender.
Request
GET /api/asset-transfers
curl -G https://service.centrapay.com/api/asset-transfers \ -H " X-Api-Key: $api_key " \ -d recipientAccountId=oS3Xom2au3Ooy9aihai
@@ -197,7 +197,7 @@
Copy
POST /api/asset-transfers/{assetTransferId}/cancel
No attributes
Request
POST /api/asset-transfers/{assetTransferId}/cancel
curl -X POST https://service.centrapay.com/api/asset-transfers/M7Kn2stAxNa6ri7h/cancel \