Quote a convenience fee (mirrors IFee shape)

POST

/v1/hosted-sessions/{sessionId}/quote-fee

curl --request POST \
  --url https://api.govifi.com/v1/hosted-sessions/example/quote-fee \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "method": "card", "card_type": "visa", "processor_token": "example", "payment_method": { "card": { "last4": "example", "exp_month": 1, "exp_year": 1, "bin": "example", "card_brand": "example" }, "ach": { "bank_name": "example", "routing_number": "example", "account_number_suffix": "example", "account_type": "checking" } } }'

• Production
• Sandbox

Authorizations

• sessionCredential

Parameters

Path Parameters

sessionId

required

string

/^cs_[A-Za-z0-9]+$/

Request Body ^required

Media type application/json

object

method

required

string

Allowed values: card ach apple_pay

card_type

Required when method=card (different cards have different rates)

string

Allowed values: visa mastercard amex discover

processor_token

Proxynized token for the entered details (same token confirm uses). Required for card/ach; omitted for apple_pay.

string

payment_method

Required for card/ach; omitted for apple_pay.

object

card

object

last4

string

exp_month

integer

exp_year

integer

bin

string

card_brand

string

ach

object

bank_name

string

routing_number

string

account_number_suffix

string

account_type

string

Allowed values: checking savings

Responses

200

Fee quote

Media type application/json

Mirrors miViewPointExtreme.SharedCore.Portal.IFee

object

amount

required

Subtotal in cents (IFee.Amount)

integer

convenience_fee

required

Cents (IFee.ConvenienceFee)

integer

developer_fee

Cents (IFee.DeveloperFee), optional

integer

total_amount

required

Cents (IFee.TotalAmount)

integer

method

required

string

Allowed values: card ach

card_type

string

cached_until

string format: date-time

Example

{
  "method": "card"
}