Simulate a payment action

POST

simulations

payments

{paymentId}

actions

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({action: 'risk-approve'})
};

fetch('https://api.melio.com/v2/simulations/payments/{paymentId}/actions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": {
    "type": "invalid_request_error",
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

api-key

string

header

required

Headers

Idempotency-Key

string

Unique key (UUID recommended) that makes a create request safe to retry by replaying the original response; retained 24h per partner.

Maximum string length: 255

Path Parameters

paymentId

string

required

A payment id (pay_).

Body

application/json

action

enum<string>

required

The payment lifecycle transition to simulate.

Available options:

risk-approve,

risk-decline,

collect,

deliver,

fail-collect,

fail-deliver

metadata

object

Optional metadata echoed to logs; not persisted on the payment.

Response

Action applied.

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({action: 'risk-approve'})
};

fetch('https://api.melio.com/v2/simulations/payments/{paymentId}/actions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": {
    "type": "invalid_request_error",
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "details": {}
  }
}

Entities

Accounts

Attachments

Payments

Tools

Webhooks

Authorizations

Headers

Path Parameters

Body

Response