cash-craft-initiate

POST {{BASE_URL}}/payment/cash-craft/initiate

This HTTP POST request is used to initiate a cash craft payment. The request should be sent to the endpoint {{BASE_URL}}/payment/cash-craft/initiate.

The response received from the last execution of this request had a status code of 422. The response body included the following properties:

• status: The status of the payment initiation.
• reason: The reason for any failure or error in the payment initiation.
• err: Any additional error information related to the payment initiation.

Here is an example of a successful response for this request:

{
  "status": "success",
  "msg": "Payment initiation successful",
  "data": {
    "status": "initiated",
    "message": "Payment initiation successful",
    "accountNumber": "1234567890",
    "reference": "PAY1234567890",
    "amountInNaira": 1000,
    "bank": "ABC Bank",
    "validityTime": 3600,
    "txId": "TX1234567890",
    "link": "https://example.com/payment/1234567890",
    "name": "John Doe",
    "amount": 10,
    "channel": "web",
    "fee": 0.5,
    "feeInNaira": 50,
    "type": "cash",
    "method": "craft",
    "date": "2022-01-01T12:00:00Z",
    "description": "Payment for order #12345",
    "metadata": [
      {
        "email": "john.doe@example.com"
      }
    ],
    "isCashCraft": true,
    "beneficiaries": [
      {
        "bankCode": "ABC",
        "accountNumber": "0987654321",
        "amount": 10,
        "transactionId": null,
        "resolved": true,
        "status": "success",
        "reason": null,
        "fee": 0.5
      }
    ]
  }
}

Please note that the values in the response are examples and may not reflect the actual values returned by the API. The response may contain additional properties not mentioned above.

To use this endpoint, send an HTTP POST request to {{BASE_URL}}/payment/cash-craft/initiate with the required parameters. The response will provide information about the status of the payment initiation and other relevant details.

Request Body

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

HEADERS

RESPONSES

status: OK

{"status":"success","msg":"cash craft instantiated successfully","data":{"status":"pending","message":"Successful","accountNumber":"4700010047","reference":"FIGO-IJ6QELZqlGVb3G4VK","amountInNaira":500,"bank":"VFD Microfinance Bank","validityTime":30,"txId":"FR-TS5LQJELYGLVA0FB","link":"eleos_technology","name":"figo technologies limitedlink","amount":50000,"channel":"API","fee":10500,"feeInNaira":105,"type":"primary","method":"Payment Link","date":"Thu, 16 Nov 2023 13:02:40 GMT","description":"cash craft payment demo","metadata":[{"email":"testing@figopayment.com"}],"isCashCraft":true,"beneficiaries":[{"bankCode":"999999","accountNumber":"1012659143","amount":10000,"transactionId":null,"resolved":false,"status":"pending","reason":null,"fee":5000},{"bankCode":"090267","accountNumber":"2004550097","amount":20000,"transactionId":null,"resolved":false,"status":"pending","reason":null,"fee":5000}]}}