Fetch Fee for Payment

POST /api/payments/get-fee

Get Fees charged for a payment

Header Parameters

• api-key string required
• api-secret string required

application/json

Request Body required

• paymentType string required

  Possible values: [MPESA, PESALINK, RTGS, SWIFT]

  Payment type being

• amount double required

  Amount being sent

• currency string required

  Currency

Responses

• 200
• 401

---

Fees fetched successfully

*/*

Schema

Schema

• status string

  Possible values: [SUCCESS, FAILED, API_KEYS_INVALID, INSUFFICIENT_FUNDS, NOT_FOUND, MALFORMED_URL, INTERNAL_ERROR, NOT_SUPPORTED, CURRENCY_NOT_SUPPORTED, MOBILE_MONEY_NOT_WHOLE_NUMBER, BALANCE_NOT_FOUND, BALANCE_NOT_AUTHORISED, BALANCE_NOT_NUMERIC, WEB_HOOK_NOT_SPECIFIED_FOR_OTP]

• fee object

  paymentType string

  Possible values: [MPESA, PESALINK, RTGS, SWIFT]

  Payment type

  fee double

  Fee chargeable

  currency string

  Currency

Example (from schema)

{
  "status": "SUCCESS",
  "fee": {
    "paymentType": "PESALINK",
    "fee": 12.2,
    "currency": "KES"
  }
}

API keys not valid

*/*

Schema

Schema

• detail string

  Detail of the message.

• status string

  Possible values: [SUCCESS, FAILED, API_KEYS_INVALID, INSUFFICIENT_FUNDS, NOT_FOUND, MALFORMED_URL, INTERNAL_ERROR, NOT_SUPPORTED, CURRENCY_NOT_SUPPORTED, MOBILE_MONEY_NOT_WHOLE_NUMBER, BALANCE_NOT_FOUND, BALANCE_NOT_AUTHORISED, BALANCE_NOT_NUMERIC, WEB_HOOK_NOT_SPECIFIED_FOR_OTP]

Example (from schema)

{
  "detail": "API key not valid or Insufficient funds",
  "status": "SUCCESS"
}

Loading...