endpoints
Payments

Payments

You can find payment endpoints here.

List All Crypto Payments (GET)

Method: GET
https://app.pallapay.com/api/v1/api/payments
Response
{
    "data": [
        {
            "payment_request_id": "fd423e12ff9d4a33a14fcba6a4df54e2",
            "payment_link": "https://dashboard.pallapay.com/payment/fd423e12ff9d4a33a14fcba6a4df54e2",
            "currency_symbol": "AED",
            "amount": "10.00000000000000",
            "note": "My Note",
            "payer_email_address": "[email protected]",
            "payer_first_name": "John",
            "payer_last_name": "Doe",
            "payment_currency": "TRX",
            "payment_amount": "25.00000000000000",
            "receiving_amount": "10.00000000000000",
            "fee_paid_by": "BUYER",
            "payment_fee_amount": "2.40000000000000",
            "paid_amount": "0.00000000000000",
            "ref_id": "49f70172ef8e48189bb3",
            "payment_status": "UNPAID"
        }
    ],
    "pagination": {
        "total_count": 1,
        "page_count": 1,
        "page_size": 10
    },
    "message": "Operation was successful",
    "successful": true
}

Response Body:

NameExample ValueDescription
payment_request_idStringUnique ID of created payment
payment_linkStringPayment link (Redirect user to this address)
currency_symbolStringSelected fiat currency to pay
amountStringPayment amount in selected currency
noteString (Nullable)Custom note that you pass in creation time (You will receive this in your webhook URL too)
payer_email_addressStringPayer email address
payer_first_nameString (Nullable)Payer first name
payer_last_nameString (Nullable)Payer last name
payment_currencyString (Nullable)The cryptocurrency your user selected to pay with
payment_amountString (Nullable)The amount of cryptocurrency that is selected
receiving_amountString (Nullable)The amount of fiat currency you will receive in your account after payment fee (If payer will pay for fees then this amount is same as "amount")
fee_paid_byString ("BUYER" or "MERCHANT") (Nullable)Who paid the fees on this payment (You can choose who pay for fees in dashboard -> merchants)
payment_fee_amountString (Nullable)Payment fee in selected fiat currency
ref_idString (Nullable)User payment reference ID
payment_statusString ("PAID", "UNPAID" or "PENDING")Payment status

Get Crypto Payments by Payment Request ID (GET)

Method: GET
https://app.pallapay.com/api/v1/api/payments/{REQUEST_PAYMENT_ID}
Response
{
    "data": {
        "payment_request_id": "fd423e12ff9d4a33a14fcba6a4df54e2",
        "payment_link": "https://dashboard.pallapay.com/payment/fd423e12ff9d4a33a14fcba6a4df54e2",
        "currency_symbol": "AED",
        "amount": "10.00000000000000",
        "note": "My Note",
        "payer_email_address": "[email protected]",
        "payer_first_name": "John",
        "payer_last_name": "Doe",
        "payment_currency": "TRX",
        "payment_amount": "25.00000000000000",
        "receiving_amount": "10.00000000000000",
        "fee_paid_by": "BUYER",
        "payment_fee_amount": "2.40000000000000",
        "paid_amount": "0.00000000000000",
        "ref_id": "49f70172ef8e48189bb3",
        "payment_status": "UNPAID"
    },
    "pagination": {
        "total_count": 1,
        "page_count": 1,
        "page_size": 10
    },
    "message": "Operation was successful",
    "successful": true
}

Create Crypto Payment Request (POST)

Method: POST
https://app.pallapay.com/api/v1/api/payments
Request Body
{
    "symbol": "AED",
    "amount": "10",
    "ipn_success_url": "https://yourwebsite.com/success",
    "ipn_failed_url": "https://yourwebsite.com/failed",
    "payer_email_address": "[email protected]",
    "payer_first_name": "John",
    "payer_last_name": "Doe",
    "note": "My Note"
}

Request Body:

NameExample ValueRequired or OptionalDescription
symbolStringRequiredFiat currency symbol to pay (Options: "AED", "USD")
amountStringRequiredPayment amount in selected fiat currency
ipn_success_urlStringRequiredThe URL that we redirect the user after successful payment
ipn_failed_urlStringRequiredThe URL that we redirect the user after unsuccessful payment
payer_email_addressStringRequiredPayer email address
payer_first_nameString (Nullable)OptionalPayer first name
payer_last_nameString (Nullable)OptionalPayer last name
noteString (Nullable)OptionalYou can pass any custom note here (You will receive this in your webhook URL too)
Response
{
    "data": {
        "payment_request_id": "fd423e12ff9d4a33a14fcba6a4df54e2",
        "payment_link": "https://dashboard.pallapay.com/payment/fd423e12ff9d4a33a14fcba6a4df54e2",
        "currency_symbol": "AED",
        "amount": "10.00000000000000",
        "note": "My Note",
        "payer_email_address": "[email protected]",
        "payer_first_name": "John",
        "payer_last_name": "Doe",
        "payment_currency": null,
        "payment_amount": null,
        "receiving_amount": null,
        "fee_paid_by": null,
        "payment_fee_amount": null,
        "paid_amount": null,
        "ref_id": null,
        "payment_status": "PENDING"
    },
    "message": "Operation was successful",
    "is_successful": true
}
BalancesWebhook