2. Payment-Based Debt

Retrieve payment-based debt information

GET {{PaymentBaseAddress}}/api/paywall/marketplace/report/debt/payment

Important: To use the Payment-Based Debt service, you need to send the 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' field.

ParameterTypeMandatoryDescription

apikeypublic

string

Yes

Public Key obtained from the merchant dashboard

apiclientpublic

string

Yes

Public Client obtained from the merchant dashboard

paymentid

int

Yes

Payment's PayWall ID information

Response from the service:

ParameterTypeDescription

ErrorCode

int

Returns '0' if the operation is successful

Result

bool

Returns 'true' if the operation is successful

Message

string

If the operation is unsuccessful, it provides an error message specific to that error, offering language support based on the 'locale' parameter.

Body

object

Operation details

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": [
        {
            "DebtId": 947,
            "Type": 2,
            "TypeName": "Cargo",
            "MemberId": 148,
            "MemberName": "test",
            "CurrencyId": 1,
            "Currency": "TRY",
            "ProductId": 2114065,
            "ProductAmount": 100.00,
            "DebtAmount": 120.00,
            "DebtStatusId": 1,
            "DebtTransactionId": 0,
            "Cargo": {
                "CargoId": 466722,
                "CargoOwnerType": 1,
                "CargoCost": 120.00
            },
            "Discount": null,
            "CalculationDateTime": "2023-09-15T14:53:58.5074"
        },
        {
            "DebtId": 948,
            "Type": 1,
            "TypeName": "Discount",
            "MemberId": 148,
            "MemberName": "test",
            "CurrencyId": 1,
            "Currency": "TRY",
            "ProductId": 2114065,
            "ProductAmount": 100.00,
            "DebtAmount": 9.90,
            "DebtStatusId": 1,
            "DebtTransactionId": 0,
            "Cargo": null,
            "Discount": {
                "DiscountId": 465176,
                "DiscountOwnerType": 1,
                "DiscountType": 1,
                "Discount": 10.00
            },
            "CalculationDateTime": "2023-09-15T14:53:58.530093"
        }
    ]
}

Last updated