Connect your own rail account
connect_rail_accountKeyed. Connects the business's OWN account at a rail (yellowcard) for reads and sandbox sending; production sending is off unless the deployment enables it, and the default flow is that the business releases payments itself in its own portal with its API key and secret and a required cap per payment. The credentials are proven with a read (no payment is sent), encrypted at rest and never returned: answers show the key's last four characters and the created date. Prefer POST /api/v1/rail-connections from your own software: credentials passed here travel through the agent's context. SwapEazi holds no funds and has no account in the flow.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| env | No | sandbox (default) or production; production sending stays off unless the deployment enables it. | |
| rail | Yes | The rail: yellowcard. | |
| label | No | Optional. Your name for this connection, up to 80 characters. | |
| secret | Yes | Your API secret at the rail. Encrypted at rest; never shown. | |
| sender | No | Optional. The sending business as the rail needs it: { name, country, phone, address, email, idType, idNumber, businessId, businessName }. | |
| api_key | Yes | Your API key at the rail. Encrypted at rest; only its last four characters are ever shown. | |
| access_key | No | A router key (rk_...), if not sent as a Bearer header. | |
| cap_per_payment | Yes | Required. The most any one payment through this connection may be: { value, currency }; a payment in another currency is refused. |