cash-craft-confirm-fee

POST https://api.figopayment.com/api/v1/service/payment/cash-craft/fee

This API endpoint allows you to calculate the fees associated with a cash craft payment service. It is an HTTP POST request to the following URL: https://api.figopayment.com/api/v1/service/payment/cash-craft/fee.

Request Parameters

This endpoint does not require any request parameters.

Response

The response will have a status code of 200 if the request is successful. The response body will be in JSON format and will contain the following fields:

  • status: A string indicating the status of the request.
  • msg: A string containing any additional message related to the request.
  • data: An object containing the fee details for the cash craft payment service. The fields within the data object are as follows:
    • payoutFee: The fee associated with the payout.
    • collectionFee: The fee associated with the collection.
    • totalFee: The total fee for the cash craft payment service.
    • payoutFeeInNaira: The payout fee in Nigerian Naira.
    • collectionFeeInNaira: The collection fee in Nigerian Naira.
    • totalFeeInNaira: The total fee in Nigerian Naira.

Examples

Here are some examples of the response for this request:

{
  "status": "",
  "msg": "",
  "data": {
    "payoutFee": 0,
    "collectionFee": 0,
    "totalFee": 0,
    "payoutFeeInNaira": 0,
    "collectionFeeInNaira": 0,
    "totalFeeInNaira": 0
  }
}

Please note that the actual values of the fields may vary based on the specific request and the configuration of the cash craft payment service.

Request Body

{"amount"=>50000, "email"=>"testing@figopayment.com", "isNaira"=>false, "validityTime"=>30, "description"=>"cash craft payment demo", "beneficiaries"=>[{"bankCode"=>"999999", "accountNumber"=>"101039143", "amount"=>10000}, {"bankCode"=>"090267", "accountNumber"=>"2001290097", "amount"=>20000}]}

HEADERS

KeyDatatypeRequiredDescription
api-keystring
public-keystring
reference-idstring

RESPONSES

status: OK

{"status":"success","msg":"cash craft instantiated successfully","data":{"payoutFee":10000,"collectionFee":500,"totalFee":10500,"payoutFeeInNaira":100,"collectionFeeInNaira":5,"totalFeeInNaira":105}}