Skip to content
Paybob

Payment

Verify Payment

Look up a payment by its pp_id and check its status before you deliver the order.

POST{base_url}/api/verify-payment

Returns a payment's details and current status. Call it with the pp_id from Create Payment when the customer comes back to your return_url, or when your webhook receives an update.

Before you deliver the order, check the status, and that amount and currency match what you charged. Amounts are decimal strings: compare them as decimals, not as text.

Authentication

Send your API key in the MHS-PIPRAPAY-API-KEY header: MHS-PIPRAPAY-API-KEY: YOUR_API_KEY. Create keys in System Settings → API Settings.

The key needs the payment:verify ability, otherwise the request fails with INSUFFICIENT_ABILITY.

Body parameters

  • pp_idstringrequired

    The pp_id returned by Create Payment.

Response fields

  • pp_idstring

    The payment's ID.

  • full_namestring

    Customer's full name.

  • email_addressstring

    Customer's email address.

  • mobile_numberstring

    Customer's mobile number.

  • gatewaystring

    Name of the payment method the customer used, e.g. Bkash Personal.

  • amountstring

    Amount charged, as a decimal string with 8 decimal places.

  • feestring

    Fee added to the payment, as a decimal string.

  • discount_amountstring

    Discount applied, as a decimal string.

  • net_totalnumber

    Total after fee and discount, as a number.

  • currencystring

    Currency code, upper case, e.g. BDT.

  • metadataobject

    The metadata you sent with Create Payment, returned unchanged.

  • senderstring

    The account the customer paid from, e.g. their wallet number.

  • transaction_idstring

    The payment method's transaction ID.

  • statusstring

    Payment status, e.g. refunded.

  • datestring

    When the payment was made, e.g. Sep 7, 2026 08:28 PM.

Responses

  • SuccessPayment found.
  • PAYMENT_NOT_FOUNDNo payment has this pp_id.
  • INVALID_API_KEYThe API key is missing, wrong or revoked.
  • INSUFFICIENT_ABILITYThe API key exists but doesn't have the payment:verify ability.