2. Payment Inquiry

Shared Payment Page Inquiry

Shared Payment Page Query

GET {{BaseAddress}}/api/paywall/checkout/inquiry

Important: In order to use the payment initiation service, you need to send the 'apikeypublic' and 'apiclientpublic' 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

apikeypublic

string

Yes

The Public Key obtained from the merchant panel.

apiclientpublic

string

Yes

The Public Client obtained from the merchant panel.

id

int

Yes

The identifier (Id) information of the shared payment page. It is returned at the time of creation.

The response returned from the service:

Parameter
Type
Description

Id

int

The identifier (Id) information of the shared payment page.

Guid

Guid

The unique code of the shared payment page.

UniqueCode

string

It is provided by your side at the time of creation.

LanguageId

int

It is the language identifier provided at the time of creation of the shared payment page.

CurrencyId

int

Currency identifier

CurrencyName

string

The name of the currency.

Amount

decimal

The amount

Installment

int

Installment information

InstallmentSupport

bool

Installment support

InstallmentDynamic

bool

Dynamic installment support

ShowProduct

bool

Are the products displayed on the screen?

ReceiverInfoSupport

bool

Should recipient information be collected on the screen?

ReceiverAddressSupport

bool

Should recipient address information be collected on the screen?

SuccessBackUrl

string

The screen to be redirected to in case of success

CardWallSupport

bool

Is there card storage support?

CardWallExpirationMin

int

The minute that card storage is supported. It is supported for a certain period for security reasons.

ExpiryTime

DateTime

The expiration date of the shared payment page.

AnyPayment

bool

Has any payment been made on the shared payment page?

SuccessPayment

bool

Are there any successful payments?

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Id": 1320,
        "Guid": "399173a2-5b0b-49e5--9bf2e3e661b7",
        "UniqueCode": "A1S2D3F4G5H6J7J7H6G5F4D3S2A1",
        "LanguageId": 1,
        "CurrencyId": 1,
        "CurrencyName": "TRY",
        "Amount": 25.00,
        "InstallmentSupport": true,
        "InstallmentDynamic": true,
        "ShowProduct": true,
        "ReceiverInfoSupport": false,
        "ReceiverAddressSupport": false,
        "SuccessBackUrl": "https://paywall.one/95d9cb18-b6ab-403b-a86a-da0ace185706",
        "FailBackUrl": "https://paywall.one/95d9cb18-b6ab-403b-a86a-da0ace185706",
        "CardWallSupport": true,
        "CardWallExpirationMin": 15,
        "ExpiryTime": "2024-02-06T18:38:03.482921",
        "AnyPayment": true,
        "SuccessPayment": true
    }
}

Last updated