2. Card List

You can use this service to list your users' cards on Masterpass.

Card Listing

GET {{Base Address}}/api/paywall/masterpass/card/list

It will be sufficient to send a request to the address provided above. You can use the 'Base Address' for both the Test environment and the Production environment as you wish.

Important: To use the Masterpass - Card Listing service, you must include the parameters 'apikeyprivate' and 'apiclientprivate' in the 'Header' field. PaymentAPI Address

Parameter	Type	Mandatory	Description
apikeyprivate	string	Yes	The Private Key obtained from the merchant panel.
apiclientprivate	string	Yes	The Private Client obtained from the merchant panel.
sessionid	Guid	Yes	This is the identifier of the session created specifically for the payment. You can create it through the Create Session service.

Response returned from the service:

Parameter	Type	Description
Body	object	JSON containing payment details (optional)
ErrorCode	int	Error code. Returns '0' if the transaction is successful.
Result	bool	Returns either true or false. If the transaction is successful, it returns true.
Message	string	If the transaction fails, this is the error message provided, with language support based on the locale parameter.

Successful ✅

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Session": {
            "SessionRenewed": false,
            "SessionId": "9b27433e-f36b-1410-80e5-004205aa382d"
        },
        "Masterpass": {
            "Result": {
                "AccountKey": "905123456710",
                "AccountState": "Activated",
                "Cards": [
                    {
                        "CardAlias": "55daa93d-4a99-45de-9431-bb93d0bbf92e",
                        "CardAuthorityUrl": "./assets/icon/Mastercard.svg",
                        "CardBin": "552879",
                        "CardId": 713633,
                        "CardIssuerIcaNumber": "3039",
                        "CardState": "Activated",
                        "CardType": "Credit",
                        "CardValidationType": "OTP",
                        "EftCode": null,
                        "ExpireDate": null,
                        "ExpireSoon": false,
                        "IsCardCreditOrSupportedDebit": true,
                        "IsDefaultCard": true,
                        "IsDefaultMoneySendCard": false,
                        "IsEightDigit": false,
                        "IsExpired": false,
                        "IsIssuerOtpSupported": true,
                        "IsMasterpassMember": true,
                        "MaskedCardNumber": "552879********08",
                        "ProductName": "YIKK",
                        "SourceMerchantId": 0,
                        "SourceMerchantName": null,
                        "SystemEntryDatetime": null,
                        "UniqueCardNumber": "07A7B67D915463CE5D8F14764334F7709FDAC68CE2381AD629E1EA6BA4B493AB"
                    },
                    {
                        "CardAlias": "f1eb4ddf-f0fd-4f16-a8bf-e19d0c7cfa33",
                        "CardAuthorityUrl": "./assets/icon/Maestro.svg",
                        "CardBin": "589004",
                        "CardId": 718546,
                        "CardIssuerIcaNumber": "2110",
                        "CardState": "Activated",
                        "CardType": "Debit",
                        "CardValidationType": "OTP",
                        "EftCode": "0046",
                        "ExpireDate": null,
                        "ExpireSoon": false,
                        "IsCardCreditOrSupportedDebit": false,
                        "IsDefaultCard": false,
                        "IsDefaultMoneySendCard": false,
                        "IsEightDigit": false,
                        "IsExpired": false,
                        "IsIssuerOtpSupported": true,
                        "IsMasterpassMember": true,
                        "MaskedCardNumber": "589004********16",
                        "ProductName": "Neo Maestro",
                        "SourceMerchantId": 0,
                        "SourceMerchantName": null,
                        "SystemEntryDatetime": null,
                        "UniqueCardNumber": "66BFD3745EEAE052A90FF9B427BA1CECB5F3573AB0E621FEF6F63604AA6810DC"
                    }
                ],
                "AccountInformation": {
                    "IsAccountLinked": true
                }
            },
            "BuildId": "83",
            "CorrelationId": "d5ac3ba9-bb68-419f-8dbd-6a5561e0353f",
            "Exception": null,
            "Message": "OK",
            "RequestId": null,
            "StatusCode": 200,
            "Version": null
        }
    }
}

Failed (User Not Found) ❌

• User Not Found

This situation occurs when the relevant user is not registered in Masterpass. To resolve this, you can direct the user to the card addition step. If the process is completed successfully, the user will be created automatically.

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Session": {
            "SessionRenewed": false,
            "SessionId": "9d27433e-f36b-1410-80e5-004205aa382d"
        },
        "Masterpass": {
            "Result": null,
            "BuildId": "83",
            "CorrelationId": null,
            "Exception": {
                "Level": "Http403",
                "Code": "USER_NOT_FOUND",
                "Message": "Kullanıcı bulunamadı."
            },
            "Message": "Forbidden",
            "RequestId": null,
            "StatusCode": 403,
            "Version": null
        }
    }
}

Failed (Authorization) ❌

• Account Not Linked to Merchant

This situation occurs when the relevant user has not granted your company authorization for Masterpass flows. To resolve the issue, the authorization service must be called.

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Session": {
            "SessionRenewed": false,
            "SessionId": "b827433e-f36b-1410-80e5-004205aa382d"
        },
        "Masterpass": {
            "Result": null,
            "BuildId": "83",
            "CorrelationId": null,
            "Exception": {
                "Level": "NotFound",
                "Code": "ACCOUNT_NOT_LINKED_TO_MERCHANT",
                "Message": "Hesap iş yerine bağlı değil."
            },
            "Message": "NotFound",
            "RequestId": null,
            "StatusCode": 404,
            "Version": null
        }
    }
}