Card Storage
Card storage feature provides a secure and convenient solution for managing payment card information, allowing users to securely save and manage card details for future transactions.
Create User and Card
Using this service, you can create a user and a card linked to that user in iyzico without creating a payment. The parameters that need to be sent to the service are as follows;
Create User and Card Request
POST
https://api.iyzipay.com/cardstorage/card
Request Body
Name | Type | Description |
---|---|---|
cardAlias* | String | The name given to the card. |
email* | String | Card owners email address. |
expireYear* | String | Expire year of the card. |
expireMonth* | String | Expire month of the card. |
cardNumber* | String | PAN of the card. |
cardHoldername* | String | Name of the card holder. |
externalId | String | Idempotency ID to the card to be stored given by the merchant. |
locale | String | Language (default: tr) |
conversationId | String | If set, conversation ID to match request and response. |
Response of Create User and Card
Parameter Name | Type | Description |
---|---|---|
status | string | Service response result (success / failure). |
errorCode | string | Error code if service response status is failure. |
errorMessage | string | Error message if service response status is failure. |
errorGroup | string | Error group if service response status is failure. |
locale | string | Language (default: tr). |
systemTime | integer | Response system timestamp value. |
conversationId | string | If set, conversation ID to match request and response. |
binNumber | string | First 6 digits of the card. |
cardType | string | Valid values are CREDIT_CARD, DEBIT_CARD, PREPAID_CARD |
cardAssociation | string | Valid values are TROY, VISA, MASTER_CARD, AMERICAN_EXPRESS. |
cardFamily | string | Valid values are Bonus, Axess, World, Maximum, Paraf, CardFinans, Advantage. |
cardBankName | string | Name of the issuer bank. |
cardBankCode | integer | Bank code of the issuer bank. |
string | Card owners email address. | |
cardUserKey | string | The value of the encrypted card determined by iyzico. |
cardToken | string | Tokenized card value determined by iyzico for relevant card user. |
cardAlias | string | The name given to the card. |
It is suggested to savecarduserkey
vecardtoken
values.
Creating Another Card Linked to the User
Given service helps to associate a second card with a user who has already been created in iyzico APIs. The required parameters that should be sent to the service are as follows;
Creating Another Card Linked to the User Request
POST
https://api.iyzipay.com/cardstorage/card
Request Body
Name | Type | Description |
---|---|---|
cardAlias* | String | The name given to the card. |
conversationId | String | If set, conversation ID to match request and response. |
locale | String | Language (default: tr). |
cardUserKey* | String | The value of the encrypted card determined by iyzico. |
expireYear* | String | Expire year of the card. |
expireMonth* | String | Expire month of the card. |
cardNumber* | String | PAN of the card. |
cardHoldername* | String | Name of the card holder. |
Creating Another Card Linked to the User Response;
Parameter Name | Type | Description |
---|---|---|
status | string | Service response result (success / failure). |
errorCode | string | Error code if service response status is failure. |
errorMessage | string | Error message if service response status is failure. |
errorGroup | string | Error group if service response status is failure. |
locale | string | Language (default: tr). |
systemTime | integer | Response system timestamp value. |
conversationId | string | If set, conversation ID to match request and response. |
carduserKey | string | The value of the encrypted card determined by iyzico. |
binNumber(carddetails) | string | First 6 digits of the card. |
cardType(carddetails) | string | Valid values are CREDIT_CARD, DEBIT_CARD, PREPAID_CARD |
cardAssociation(carddetails) | string | Valid values are TROY, VISA, MASTER_CARD, AMERICAN_EXPRESS. |
cardFamily(carddetails) | string | Valid values are Bonus, Axess, World, Maximum, Paraf, CardFinans, Advantage. |
cardbankName(carddetails) | string | Name of the issuer bank. |
cardbankCode(carddetails) | integer | Bank code of the issuer bank. |
cardtoken(carddetails) | string | Tokenized card value determined by iyzico for relevant card user. |
cardalias(carddetails) | string | The name given to the card. |
It is advised to storecardToken
values in your database, or you can retrievecardToken
values each time using this service.
Delete Cards
You can delete a card belonging to a user created in iyzico. The parameters that need to be sent to the service are as follows;
Delete Cards Request
DELETE
https://api.iyzipay.com/cardstorage/card
Request Body
Name | Type | Description |
---|---|---|
cardToken* | String | Tokenized card value determined by iyzico for relevant card user. |
conversationId | String | If set, conversation ID to match request and response. |
locale | String | Language (default: tr). |
cardUserKey* | String | The value of the encrypted card determined by iyzico. |
Delete Cards Response;
Parameter Name | Type | Açıklama |
---|---|---|
status | string | Service response result (success / failure). |
errorCode | string | Error code if service response status is failure. |
errorMessage | string | Error message if service response status is failure. |
errorGroup | string | Error group if service response status is failure. |
locale | string | Language (default: tr). |
systemTime | integer | Response system timestamp value. |
conversationId | string | If set, conversation ID to match request and response. |
Last updated