Skip to main content
POST
/
api
/
agent
/
actions
/
{action}
Run an agent action
curl --request POST \
  --url https://dash.getopenrails.com/api/agent/actions/{action} \
  --header 'Content-Type: application/json' \
  --data '
{
  "product": "<string>",
  "amount": 123,
  "customer": "jsmith@example.com",
  "redirectUrl": "<string>",
  "metadata": {},
  "environment": "sandbox",
  "idempotencyKey": "<string>",
  "clientReferenceId": "<string>"
}
'
{
  "result": {
    "id": "<string>",
    "merchant": "<string>",
    "product": "<string>",
    "amount": 123,
    "customer": "jsmith@example.com",
    "route": {
      "id": "<string>",
      "label": "<string>",
      "integrationId": "<string>",
      "integrationLabel": "<string>",
      "network": "<string>",
      "asset": "<string>",
      "score": 123,
      "payerLabel": "<string>",
      "eta": "<string>",
      "buyerFeeRate": 123,
      "gatewayFeeRate": 123,
      "providerCostRate": 123,
      "kycPolicy": "<string>"
    },
    "feeSplit": {
      "buyerFee": 123,
      "gatewayFee": 123,
      "merchantNet": 123,
      "total": 123
    },
    "checkoutUrl": "<string>",
    "redirectUrl": "<string>",
    "environment": "sandbox",
    "dryRun": true,
    "idempotencyKey": "<string>",
    "clientReferenceId": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getopenrails.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

action
enum<string>
required
Available options:
checkout.preview,
checkout.create,
fees.estimate,
webhook.example,
webhook.verify_sample

Body

application/json
product
string
required
Required string length: 1 - 120
amount
number
required
Required range: x <= 10000
customer
string<email>
required
preferredRoute
enum<string>
Available options:
card,
wallet,
local
redirectUrl
string<uri>
metadata
object
environment
enum<string>
default:sandbox
Available options:
sandbox,
production
idempotencyKey
string
Required string length: 8 - 120
clientReferenceId
string
Required string length: 3 - 120

Response

Action succeeded

ok
enum<boolean>
required
Available options:
true
action
enum<string>
required
Available options:
checkout.preview,
checkout.create
result
object
required