8. Card List

You can list your cards. The listing method supports different parameter supports depending on the data you have, allowing you to list accordingly.

Card - List

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

Simply sending a request to the address provided above will suffice. You can use the 'Base Address' as you wish for both the Testing Environment and the Production Environment.

Important: In order to use the 'Card - List' service, you need to send the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' field.

PaymentAPI Address

The header information that needs to be sent to the service is as follows:

Parameter	Type	Compulsory	Description
apikeyprivate	string	Yes	The Private Key obtained from the merchant panel.
apiclientprivate	string	Yes	The Private Client obtained from the merchant panel.
start	int	Yes	Starting point of the listing.
length	int	Yes	The length of the list.
cardid	int	Yes	The Id information of the card in Paywall. Returned during creation.
cardnumber	string	No	The known data inside the card. Contains works
phone	string	No	The phone number associated with the card. Contains works
externalid	string	No	The identifier given at the creation of the card. Contains works

The response returned from the service:

Parameter	Type	Description
Body	object	The detailed information related to the card.
ErrorCode	int	Error code. If the operation is successful, it returns '0'.
Result	bool	It returns a true or false value. If the operation is successful, it returns 'true'.
Message	string	If the operation is unsuccessful, this message indicates the error, providing language support based on the locale parameter.

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Data": [
            {
                "Id": 1145543,
                "CardProductionName": "Papara",
                "CardExternalId": 66696,
                "ExternalId": null,
                "InsertDateTime": "2023-08-28T12:28:26.64394",
                "Phone": "5554443322",
                "CardNumber": "529799******0986",
                "ExpiryMonth": "8",
                "ExpiryYear": "27",
                "LastActivityTypeId": 2,
                "IsActive": true,
                "IsDelete": false
            }
        ],
        "TotalRecord": 14
    }
}