10. Update Description

You can update the descriptions of your cards

Card - Update Description

PUT {{Base Address}}/api/paywall/card/production/description

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

Important: In order to use the 'Card - Update Description' 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.

The parameters that need to be sent to the service are as follows:

Parameter
Type
Compulsory
Description

CardId

int

Yes

The Id information of the Card in the Paywall. Returned at the creation moment.

Description

string

Yes

The person or description to which the Card will be associated.

{
    "CardId": 1254333,
    "Description": "Card Holder"
}

The response returned from the service:

Parameter
Type
Description

Body

object

It returns null. It doesn't provide any details.

ErrorCode

int

Error code. Returns '0' if the operation is successful.

Result

bool

It returns a value of true or false. Returns 'true' if the operation is successful.

Message

string

If the operation is unsuccessful, this is the specified error message, providing language support according to the locale parameter.

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": null
}

Last updated