Sign in

v1

latestOpenAPI 3.0.12026-07-264182324.3 KB
Orders

Retrieves the convenience fees associated with a <code>pnm_order_identifier</code> or a <code>site_order_identifier</code>. Results can be filtered by <code>payment_amount</code>, <code>payment_method_identifier</code>, <code>payment_type</code>, and <code>site_channel</code>.

post/get_fees

Request body

OR

Example request

{
  "pnm_order_identifier": "84338052224"
}

Response

Successful Operation

type'ach' | 'ach_push' | 'apple_pay_credit' | 'apple_pay_debit' | 'cash_app' | 'credit' | 'debit' | 'gpay' | 'paypal' | 'paypal_push' | 'push_debit' | 'venmo' | 'venmo_push'

The types of payment methods that can be used for this order. Payment methods prefixed or suffixed with <code>push</code> only display for disbursement orders.

consumer_fee_amountnumber

The default convenience fee amount that's paid to PayNearme for each transaction.

consumer_fee_currencystring

USD

merchant_fee_amountnumber

The default convenience fee amount paid to the client for each transaction.

merchant_fee_currencystring

USD

total_fee_amountnumber

The total amount of the default convenience fee paid by the consumer for each transaction.

total_fee_currencystring

USD

fee_amountnumber

The convenience fee required to use this payment method.

fee_currencystring

USD

Example response

{
  "consumer_fee_amount": 10,
  "consumer_fee_currency": "USD",
  "merchant_fee_currency": "USD",
  "total_fee_amount": 10,
  "total_fee_currency": "USD",
  "fee_amount": 3.99,
  "fee_currency": "USD",
  "accounts": [
    {
      "payment_method_identifier": "f9d5c9076006b",
      "name": "John Smith",
      "description": "Debit Card",
      "pull-enabled": "true",
      "push_enabled": "true",
      "number": "6666",
      "fee_amount": 3,
      "fee_currency": "USD",
      "expiration_date": "12/2025",
      "card_brand": "Visa",
      "pay_pal_account_id": "YB6935G4PHS92",
      "pay_pal_account_email": "buyer@paynearme.com"
    }
  ]
}