Estimate Payout Amount API

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

API Endpoint

POST https://backend.pay.agency/api/v1/wallet/estimate-payout

Headers

Header Name	Description
`Content-Type`	Specifies the content type. Always set to `application/json`.
`Authorization`	Bearer token for authentication.

Parameters

Parameter	Type	Description	Required
`wallet_id`	String	Wallet ID of the user	Yes
`amount`	Number	Transaction amount in smallest currency unit	Yes
`card_number`	String	Credit/Debit card number	Yes

Payload

The payload should be sent in JSON format. Below is the structure of the payload:

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

Example Responses

Success Response

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

Error Response

{
  "message":"Insufficient wallet balance to complete the transaction."
}