The Payment Company Logo

Payout

Payout Estimate

This endpoint calculates the estimated total payout amount, including MDR (Merchant Discount Rate) and transaction fees, based on the supplied amount, wallet ID, and card number.

SectionPayout
Topics05
Pathpayout / 03-estimateApi

API Endpoint

POSThttps://api.thepayment.company/api/v1/wallet/estimate-payout

Headers

Header NameDescription
Content-TypeDefines the content type. Always use application/json.
AuthorizationBearer token used for authentication.

Request Fields

ParameterTypeDescriptionRequired
wallet_idStringUser wallet IDYes
amountNumberTransaction amount in the smallest currency unitYes
card_numberStringCredit or debit card numberYes

Payload

Send the request payload as JSON. The sample structure is shown below:

{
  "wallet_id": "WAL7825818519632620",
  "amount": 200,
  "card_number": "4111111111111111"
}

Sample Responses

{
"data": {
  "amount_requried": 211.5,
  "wallet_balance": 1000,
  "total_fee": 11.5
}
}

On this page