Passer au contenu principal
POST
Calculer les frais de transaction
Cette route calcule les frais cote serveur avant de lancer une collection ou un disbursement. Vous pouvez identifier le service avec serviceId, service_id, provider, serviceCode ou service_code. Pour une application API directe, le porteur des frais vient de la configuration de l’application authentifiee ou du header interne X-SP-Fee-Bearer. Pour un plugin, envoyez origin: "PLUGIN" et fournissez feeBearer dans le payload ou dans la query string. Le payload est prioritaire. Lorsque feeBearer vaut CUSTOMER, payableAmount inclut les frais. Lorsque feeBearer vaut MERCHANT, merchantNetAmount indique le montant net marchand apres frais. Envoyez amount en valeur réelle par défaut : 4.01 pour 4,01 USD/EUR. Les clients API qui envoient déjà des centimes peuvent préciser amount_unit: "MINOR" à la racine du corps JSON, au même niveau que amount et currency, et non dans metadata. Les réponses publiques reviennent en valeur réelle même si la requête utilise MINOR. Consultez les montants et devises. baseAmount, feeAmount, payableAmount et merchantNetAmount sont retournés en valeur réelle. Conservez leurs décimales pour les afficher ou les comparer.

Autorisations

x-sp-auth-token
string
header
requis

Token Bearer obtenu avec le client_id et le client_secret de l'application creee dans SoleasPay. Format: Bearer <access_token>.

Paramètres de requête

feeBearer
enum<string>

Prioritaire seulement pour les flux plugin lorsque le payload ne fournit pas feeBearer.

Options disponibles:
CUSTOMER,
MERCHANT

Corps

application/json
amount
number
requis

Montant en valeur réelle par défaut : 4.01 pour 4,01 USD/EUR. Avec amount_unit MINOR à la racine, envoyez des centimes entiers (401).

Exemple:

10000

currency
string
requis
Exemple:

"XAF"

serviceId
integer
Exemple:

1

service_id
integer
Exemple:

1

provider
string
Exemple:

"mtn_cmr"

origin
enum<string>
Options disponibles:
APPLICATION,
PLUGIN
Exemple:

"APPLICATION"

plugin
string
Exemple:

"CHECKOUT"

feeBearer
enum<string>
Options disponibles:
CUSTOMER,
MERCHANT
Exemple:

"CUSTOMER"

customerPaysFees
boolean
obsolète
Exemple:

true

operation
enum<string>
Options disponibles:
COLLECTION,
DISBURSEMENT
Exemple:

"COLLECTION"

amount_unit
enum<string>
défaut:MAJOR

Unité des montants de la requête. Facultatif, MAJOR par défaut. Placez ce champ à la racine du corps JSON, pas dans metadata. MINOR conserve les montants déjà exprimés dans la plus petite unité.

Options disponibles:
MAJOR,
MINOR
Exemple:

"MAJOR"

Réponse

Devis de frais

code
integer
Exemple:

200

success
boolean
Exemple:

true

data
object
locale
string
Exemple:

"fr"

message
string
Exemple:

"fees_quote"