FIfinmo
Payout

Simulate Payout

Changed on

Use this Method in the sandbox to simulate the completion of a Payout i.e. transfer of funds to the beneficiary.

The Payout must be in a PENDING status to complete or cancel it. Upon successful execution, the Payin status updates to COMPLETED, FAILED or RETURNED.

patch/payout/simulate

Request

  • Base URL
    https://api.finmo.net/v1
  • Auth
    HTTP basic

Request body

beneficiary_amountstring

Beneficiary transaction amount

beneficiary_currencystring

Beneficiary transaction currency

payout_idstring required

Payout reference (payout_*)

statusstring required

Final status of the payout. Possible values: COMPLETED, FAILED, RETURNED

Example request

{
  "beneficiary_amount": "1",
  "beneficiary_currency": "AUD",
  "payout_id": "payout_2793cd1ec4404fdab5b2f5efc25d1f85",
  "status": "COMPLETED"
}

Response

OK

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Changes