Payin

Simulate Payin Completion/Cancellation

Changed on

Use this Method in the sandbox to simulate the completion or cancellation of a Payin , i.e., funds deposited, charged to the customer, or cancellation of the Payin.

The Payin must be in a PENDING status to complete or cancel it. Upon successful execution, the Payin status updates to COMPLETED or CANCELLED. If the Payin is not in a PENDING status or if you attempt to complete an already completed or cancelled Payin, a 406 error will be returned.

patch/payin/simulate

Request

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

Request body

amountinteger

Use this to provide transaction amount in case of partial payment. The number of decimal place will be different for each currency according to ISO 4217

currencystring

Transaction currency in case of partial payment

payin_idstring required

Payin reference (payin_*)

status'COMPLETED' | 'CANCELLED' required

COMPLETED or CANCELLED

Example request

{
  "amount": 1,
  "currency": "AUD",
  "payin_id": "payin_3001c52bee6343dc8c91468459b74cbf",
  "status": "COMPLETED"
}

Response

OK

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Changes