Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Div | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
Find out how Cipher REST APIs can be integrated into the Card Management System (CMS) or other such systems to trigger updates on Cipher System. Find out Cipher Offering here.
class | method-area aura |
---|
class | method-copy |
---|
class | dynamic-toc |
---|
class | api-panel-expand |
---|
Create Card
class | post-api |
---|
title | Create Card |
---|
This endpoint allows you to enroll cards for authentication using the cardholder’s challengeable identities. The API supports enrollment using the following card schemes:
- 15/16-digit card PAN
- SHA256 of the card
Endpoint URI
div
|
class | api-label post |
---|
| /tenants/tenantId/cards |
Request details
Div | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response details
Div | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Update Card
title | patch |
---|---|
class | patch-api |
title | Update Card |
---|
This endpoint allows you to enable or disable a card using its cardId
.
Endpoint URI
divapi-label post
|
| /tenants/tenantId/cards/{cardId} |
Request details
Div | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Response details
Div | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Get Tenant
class | get-api |
---|
title | Get Tenant |
---|
This endpoint allows you to retrieve details of a tenant. A tenant is an organization or financial institute on-boarded with Zeta.
Endpoint URI
div
|
class | api-label post |
---|
| /tenants/{tenantId} |
Request details
Div | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
|
Response details
Div | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||
|
Error codes
This section explains the various error codes thrown by Cipher APIs.
The sample error response below shows server-side error code and message returned in case of any error:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"code": "ER001",
"message": "Bad request",
"debugId": "9551a715-79d4-4b64-a3d8-11efe7610baf"
} |
The following table lists the error codes, descriptions and possible solutions. If the issue persists, contact Zeta.
Error Code | Error Message | HTTP Status |
ER000 | Unexpected server error occurred | 500 |
ER001 | Bad request | 400 |
ER002 | Conflicting input | 409 |
ER003 | Resource not found | 404 |
ER004 | Unauthorized action | 401 |
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|