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"}'{ "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"}This endpoint allows you to list all API Keys for an Account.
curl -X GET \ https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \ -H 'x-api-key: <TOKEN>'[ { "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" }]This endpoint allows you to list all API Keys for an Account.
curl -X GET \ https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/api-keys \ -H 'x-api-key: <TOKEN>'[ { "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" }]This endpoint allows you to enable or disable an API key.
Returns a paginated list of Asset Transactions. This endpoint is currently only supported for quartz asset types.
curl -X GET \ https://service.centrapay.com/api/assets/WRhAxxWpTKb5U7pXyxQjjY/transactions \ -H 'x-api-key: <TOKEN>'{ "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" } ]}Returns a paginated list of Asset Activities.
curl -X GET \ https://service.centrapay.com/api/asset-activities \ -H 'x-api-key: <TOKEN>'{ "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" } ]}curl -X GET \ https://service.centrapay.com/api/asset-activities \ -H 'x-api-key: <TOKEN>'{ "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" } ]}curl -X POST \ https://service.centrapay.com/api/asset-transfer-requests \ -H 'content-type: application/json' \ -H 'x-api-key: <TOKEN>' \ -d '{ "recipientAlias": "12-1234-1234567-123", "senderAccountId": "9EDxUT91TMsUjoqoQeBuLQ", "value": "1000", "assetType": "quartz.nzd.test"}'{ "id": "M7Kn2stAxNa6ri7h", "recipientAlias": "12-1234-1234567-123", "status": "requested", "assetType": "quartz.nzd.main", "description": "request payment", "senderAccountId": "9EDxUT91TMsUjoqoQeBuLQ", "createdAt": "2024-03-01T23:56:21.514Z", "createdBy": "crn:userId:1234", "suppressNotifications": false, "value": "1000", "message": "Payment request"}curl -X POST \ https://service.centrapay.com/api/asset-transfer-requests/M7Kn2stAxNa6ri7h/accept \ -H 'content-type: application/json' \ -H 'x-api-key: <TOKEN>' \ -d '{ "assetId": "YGRo6TYYSxH3js7", "value": "1000", "senderName": "Jane Doe"}'{ "assetTransferId": "M7Kn2stAxNa6ri7h", "status": "accepted", "type": "asset-transfer:accepted", "createdAt": "2020-05-02T01:03:37.222Z", "createdBy": "sdasd98199dadas", "assetId": "YGRo6TYYSxH3js7", "senderName": "Jane Doe", "value": "1000"}curl -X POST \ https://service.centrapay.com/api/asset-transfer-requests/M7Kn2stAxNa6ri7h/accept \ -H 'content-type: application/json' \ -H 'x-api-key: <TOKEN>' \ -d '{ "assetId": "YGRo6TYYSxH3js7", "value": "1000", "senderName": "Jane Doe"}'{ "assetTransferId": "M7Kn2stAxNa6ri7h", "status": "accepted", "type": "asset-transfer:accepted", "createdAt": "2020-05-02T01:03:37.222Z", "createdBy": "sdasd98199dadas", "assetId": "YGRo6TYYSxH3js7", "senderName": "Jane Doe", "value": "1000"}Transfer an asset to a recipient. Some assets can be transfered only in whole (eg 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
diff --git a/api/asset-types/index.html b/api/asset-types/index.html
index 2409ef0da..5d2f17a81 100644
--- a/api/asset-types/index.html
+++ b/api/asset-types/index.html
@@ -15,7 +15,7 @@
curl -X GET \ https://service.centrapay.com/api/assets/L75M3L56N2PtBSt8g7uXLU \ -H 'x-api-key: <TOKEN>'{ "id": "L75M3L56N2PtBSt8g7uXLU", "accountId": "9aFdxZNbqmFhzJFqozreqesEeaoh2f", "category": "token", "type": "centrapay.token.main", "liveness": "main", "createdAt": "2024-04-23T22:11:57.158Z", "status": "active", "activeFrom": "2024-04-23T22:11:56.924Z", "expiresAt": "2024-05-07T22:11:56.924Z", "description": "Centrapay Token", "collectionId": "1234", "issuerImg": "https://static.centrapay.com/assets/brands/centraperk/logo.png", "img": "http://www.centrapay.com/path/to/img.png", "issuer": "Centraperk", "issuerWebsite": "www.centrapay.com", "mediaUploadId": "P9picAvVyA7c7d1GMytWG7"}curl -X GET \ https://service.centrapay.com/api/assets/L75M3L56N2PtBSt8g7uXLU \ -H 'x-api-key: <TOKEN>'{ "id": "L75M3L56N2PtBSt8g7uXLU", "accountId": "9aFdxZNbqmFhzJFqozreqesEeaoh2f", "category": "token", "type": "centrapay.token.main", "liveness": "main", "createdAt": "2024-04-23T22:11:57.158Z", "status": "active", "activeFrom": "2024-04-23T22:11:56.924Z", "expiresAt": "2024-05-07T22:11:56.924Z", "description": "Centrapay Token", "collectionId": "1234", "issuerImg": "https://static.centrapay.com/assets/brands/centraperk/logo.png", "img": "http://www.centrapay.com/path/to/img.png", "issuer": "Centraperk", "issuerWebsite": "www.centrapay.com", "mediaUploadId": "P9picAvVyA7c7d1GMytWG7"}curl -X GET \ https://service.centrapay.com/api/assets/L75M3L56N2PtBSt8g7uXLU/summary{ "id": "L75M3L56N2PtBSt8g7uXLU", "issuer": "Centraperk Cafe", "description": "Free Coffee", "expiresAt": "2020-12-31T00:00:00.000Z", "img": "https://static.centrapay.com/assets/brands/centraperk/cafe-token.png", "liveness": "test"}Returns a paginated list of Assets for an account. This will not return archived assets.
curl -X GET \ https://service.centrapay.com/api/accounts/Te2uDM7xhDLWGVJU3nzwnh/assets \ -H 'x-api-key: <TOKEN>'{ "items": [ { "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": "2000" }, { "id": "Aj7rtHmd7rDeWoJgw9MPHe", "accountId": "Te2uDM7xhDLWGVJU3nzwnh", "type": "cca.coke.main", "description": "Coke™ Token", "category": "token", "value": [ { "currency": "NZD", "amount": "400" } ], "expiresAt": "2020-12-31T00:00:00.000Z", "createdAt": "2020-05-01T12:30:00.000Z" } ]}curl -X GET \ https://service.centrapay.com/api/accounts/Te2uDM7xhDLWGVJU3nzwnh/assets \ -H 'x-api-key: <TOKEN>'{ "items": [ { "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": "2000" }, { "id": "Aj7rtHmd7rDeWoJgw9MPHe", "accountId": "Te2uDM7xhDLWGVJU3nzwnh", "type": "cca.coke.main", "description": "Coke™ Token", "category": "token", "value": [ { "currency": "NZD", "amount": "400" } ], "expiresAt": "2020-12-31T00:00:00.000Z", "createdAt": "2020-05-01T12:30:00.000Z" } ]}Archive supported asset types by asset id. Currently tokens, and quartz.nzd assets may be archived.