21. Campaign Query

You can query the campaigns defined for the card used by the user on your payment screen (registered/unregistered) via the associated campaign-enabled POS provider.

Campaign Query

POST {{Base Adres}}/api/paywall/campaign/vpos/inquiry

Important: To use the campaign query service, you must include the apikeypublic and apiclientpublic parameters in the Header. PaymentAPI Address

Sent Header Information:

Parameter	Type	Compulsory	Description
apikeypublic	string	Yes	The Public Key obtained from the merchant panel.
apiclientpublic	string	Yes	The Public Client obtained from the merchant panel.

You can send a query request to the campaign query service either with a saved card (IsSavedCard + UniqueCode) or manually using unsaved card details.

Sent Body Information:

JSON

{
    "CurrencyId": 1,
    "Amount": 1,
    "Card": {
        "Partner": {
            "PartnerBased": false,
            "PartnerIdentity": ""
        },
        "IsSavedCard": false,
        "UniqueCode": "",
        "Number": "4799174799173828",
        "ExpireMonth": "12",
        "ExpireYear": "2028"
    }
}

Parameters Returned from the Service

Parameter	Type	Description
CurrencyId	short	Currency of the campaign See: Currency
Amount	decimal	Amount within the scope of the campaign Note: The value returned is the same as the amount sent during the query.
CampaignIndex	string	Order of the campaign on the queried provider side
CampaignCode	string	Campaign code on the queried provider side Note: This value must be sent during the payment initiation.
CampaignDescription	string	Campaign description on the queried provider side

JSON

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "Campaign Inquiry Successful",
    "Body": {
        "Campaigns": [
            {
                "CurrencyId": 1,
                "Amount": 1.0,
                "CampaignIndex": "1",
                "CampaignCode": "00000000",
                "CampaignDescription": "Kampanya Kullanma"
            },
            {
                "CurrencyId": 1,
                "Amount": 1.0,
                "CampaignIndex": "0",
                "CampaignCode": "00000001",
                "CampaignDescription": "+4 Taksit Imkani"
            }
        ]
    }
}