HUhub2
Payments

Retrieve fees

Changed on

This endpoint allows you to retrieve the fees associated with a payment intent. Fees are applied per payment and this endpoints will group all the fees in an array.

get/payment-intents/{id}/payment-fees

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: ApiKey, MerchantId, Environment

Path parameters

idstring required

Identifier of the PaymentIntent on which to retrieve PaymentFees.

Query parameters

countrystring required
Example:CI

Two-letter ISO country code. Represents the country where the provider selected by the customer is localized.

providerstring
Example:orange

The name of the provider selected by the customer, in lowercase. The list of supported providers can be found at /data/providers. Required for every method except instant_payment, which has a single provider: for that method the parameter is optional and ignored, and any value (for example PI SPI) is accepted.

paymentMethod'mobile_money' | 'credit_card' | 'bank_transfer' | 'instant_payment' required

The method selected by the customer to make this Payment.

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

idstring required

Unique identifier of the applied Fee object.

ratenumber required

A rate corresponding to the amount (flat or percentage) applied by the fees.

rateType'percent' | 'flat' required

Fees can either be a flat amount of the transaction amount or percentage of the transaction amount.

amountnumber required

Amount applied by this Fees. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency).

currencystring required

Three-letter ISO currency code.

labelstring

An optional label giving information on the reason of this fees.

Example response

[
  {
    "id": "fee_lAe5HnFpvOjwdT9vSIgPA",
    "amount": 5,
    "currency": "XOF",
    "taxes": [
      {
        "id": "tax_lAe5HnFpvOjwdT9vSIgPA",
        "feeId": "fee_lAe5HnFpvOjwdT9vSIgPA",
        "taxType": "tva",
        "type": "percent",
        "value": 3.813559322033896
      }
    ]
  }
]

Changes

  • f6d3f87df5e0Revision changes
    • breaking

      the // response's property type changed from string to object for status

    • info

      the query request parameter provider became optional

    • info

      added the new enum value instant_payment to the query request parameter paymentMethod

    • info

      added the non-success response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status