serviceFee

QUERY

This call will allow you to calculate what the fee amount should be if using SERVICE_FEE for a transaction.

Arguments

merchant_uidRequired

String

The Pay Theory unique identifier for the merchant the transaction is for.

amountRequired

Int

The amount of the transaction.

bank_id

String

The first 6 to 8 digits of a card number. An error will be thrown if it is any other length.

payment_type

String

-

is_ach

Boolean

If the transaction is an ACH transaction.

payment_method_id

String

The Pay Theory unique identifier for a tokenized payment method to calculate fees for.

Response

ServiceFeeCalculation

fee_limit_reached

Boolean| null

The fee limit reached.

fee

Int| null

The amount that the service fee should be based on the amount passed in.

total

Int| null

The total amount of the transaction before the service fee. This is what you would want to pass in the amount argument for the createOneTimePayment call.

adjusted_total

Int| null

The total amount of the transaction after the service fee. This is what you would want to show the payor the total amount of the transaction will be.

Examples

Read the service fee for a card

Calculates the service fee for a card using its BIN.

SUCCESS 200

GRAPHQL

query ServiceFee($merchant_uid: String!, $amount: Int!, $bank_id: String) {
  serviceFee(merchant_uid: $merchant_uid, amount: $amount, bank_id: $bank_id) {
    fee
    total
    adjusted_total
  }
}