# payment_endpoints.register

## What it does

Register a payment instruction and its supported rails. A URI is a payto or CAIP-10 identifier; account-level card collection methods omit URI. Fees for account routes come from the linked provider contract. Does not move money.

## Before you send it

An authorized OAuth connection may call it, including a headless client. Effective membership, application grant and token permissions still apply. Describe `payment_endpoints.register` through `GET /v1/catalog/commands/{name}` before acting.

This command does not accept `source_document_id` in its envelope. Any input evidence requirements remain as documented below.

## Inputs

Put these fields inside the envelope's `input` object. The outer envelope names the command, a stable `idempotency_key` and `effective_at`; [request and recovery rules](/docs/api/) explain those separately. Use exact minor-unit integer strings for monetary fields. Take existing IDs from prior reads or command results; choose a new identity only where the command asks for one.

Required means required within its containing object; an optional parent can be omitted.

| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
| `paymentEndpointId` | string | Yes |  Minimum length: `1`. Example: `"vendor-ach"`. |
| `financialAccountId` | string | No |  Minimum length: `1`. |
| `partyId` | string | No |  Minimum length: `1`. Example: `"vendor"`. |
| `uri` | string | No |  Example: `"payto://ach/110000000/123456789"`. |
| `label` | string | No |   |
| `active` | boolean | No |   |
| `methods` | array | Yes |  Items: object. Minimum items: `1`. Maximum items: `20`. |
| `methods[].direction` | string | Yes |  Choose `"in"`, `"out"`. Example: `"in"`. |
| `methods[].rail` | string | Yes |  Choose `"ach"`, `"ach_same_day"`, `"fedwire"`, `"rtp"`, `"sepa"`, `"sepa_instant"`, `"swift"`, `"onchain"`, `"internal"`, `"card"`. Example: `"ach"`. |
| `methods[].asset` | string | Yes |  Minimum length: `1`. Example: `"USD"`. |
| `methods[].enabled` | boolean | No |   |
| `methods[].etaSeconds` | integer | No |  Minimum: `0`. |
| `methods[].minAmountMinor` | string | No |  Pattern: `"^(0\|[1-9][0-9]*)$"`. |
| `methods[].maxAmountMinor` | string | No |  Pattern: `"^(0\|[1-9][0-9]*)$"`. |

## After acceptance

When the command emits events, its documented effects and receipt are recorded in the command transaction. The response returns `commandId`, `replayed`, the command-specific `result` below and emitted `events` with their IDs and CIDs. A command is not automatically a cash movement or revenue recognition: use the behavior above to determine what this command records.

Inspect `result` and the affected records or reports before continuing. Save returned identifiers for later calls. Fetch `GET /v1/commands/{id}` with `commandId` to recover the accepted receipt; retry the same intent with the same idempotency key if the response was lost. Some commands can succeed with `events: []` and return a transient result and `commandId` without persisting a receipt. A lookup of that ID can return null; retain the returned result and verify the affected record. Retrying can re-evaluate the current state rather than replay a stored result. A domain `no_change` is a separate success outcome with no persisted receipt.

### Result fields

See the exact schema below for the accepted shape.


[All commands](/docs/command-reference/) · [Operation and errors](/docs/api-reference/operations/commands-execute/) · [Reusable schemas](/docs/api-reference/components/)

Keep credentials out of prompts; rehearse writes only in a disposable sandbox.

## Exact request schema


```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "const": "payment_endpoints.register"
    },
    "input": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "paymentEndpointId": {
          "type": "string",
          "minLength": 1
        },
        "financialAccountId": {
          "type": "string",
          "minLength": 1
        },
        "partyId": {
          "type": "string",
          "minLength": 1
        },
        "uri": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "active": {
          "type": "boolean"
        },
        "methods": {
          "type": "array",
          "minItems": 1,
          "maxItems": 20,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "direction": {
                "enum": [
                  "in",
                  "out"
                ]
              },
              "rail": {
                "enum": [
                  "ach",
                  "ach_same_day",
                  "fedwire",
                  "rtp",
                  "sepa",
                  "sepa_instant",
                  "swift",
                  "onchain",
                  "internal",
                  "card"
                ]
              },
              "asset": {
                "type": "string",
                "minLength": 1
              },
              "enabled": {
                "type": "boolean"
              },
              "etaSeconds": {
                "type": "integer",
                "minimum": 0
              },
              "minAmountMinor": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]*)$"
              },
              "maxAmountMinor": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]*)$"
              }
            },
            "required": [
              "direction",
              "rail",
              "asset"
            ]
          }
        }
      },
      "required": [
        "paymentEndpointId",
        "methods"
      ]
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "effective_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    }
  },
  "required": [
    "name",
    "input",
    "idempotency_key",
    "effective_at"
  ],
  "additionalProperties": false
}
```

## Accepted command receipt


```json
{
  "type": "object",
  "required": [
    "commandId",
    "replayed",
    "result",
    "events"
  ],
  "properties": {
    "commandId": {
      "type": "string"
    },
    "replayed": {
      "type": "boolean"
    },
    "imported": {
      "const": true,
      "description": "The command's events are history from before the business joined Economico, recorded as an import: free of monthly events."
    },
    "result": {
      "type": "object"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

## Example request


```json
{
  "name": "payment_endpoints.register",
  "input": {
    "paymentEndpointId": "vendor-ach",
    "partyId": "vendor",
    "uri": "payto://ach/110000000/123456789",
    "methods": [
      {
        "direction": "in",
        "rail": "ach",
        "asset": "USD"
      }
    ]
  },
  "effective_at": "2026-09-01T00:00:00Z",
  "idempotency_key": "payment_endpoints.register-example-0"
}
```