Skip to content
/
Retrieve Statements

rail API Specification (1.1.2)

Welcome to the rail Developer Guide!

Download OpenAPI description
rail-spec.json
rail-spec.yaml
Languages
Servers
Mock server

https://docs.rail.io/_mock/api-docs/openapi/rail-spec/

Sandbox - Stable API Instance

https://sandbox.layer2financial.com/api/

Production - Stable API Instance

https://platform.layer2financial.com/api/

Applications

Applications represent the onboarding journey for your customers. They are used to collect KYC information and documents required to open accounts on the platform. Visit our guides for a detailed understanding on how to use these APIs.

Operations

Accounts

Accounts are used to hold funds on the platform. Once a customer is onboarded via the application process, you can create accounts for them in various currencies.

Operations

Retrieve Accounts

Request

Retrieves a list of accounts given the filter parameters provided

Security
OAuth2Flow
Query
pageinteger(int32)

Page of records to get (default 0 = first page)

page_sizeinteger(int32)

Records to return per page (default = 20)

customer_idstring

Account holder customer ID

product_typestring
  • CLIENT - Accounts at the Client level for managing client treasury operations
  • DEPOSIT - Accounts at the Customer level account for managing customer funds on platform
  • VIRTUAL - Accounts at the Customer level account for tracking externally managed customer funds

see account concepts for more details.

Enum"CLIENT""DEPOSIT""VIRTUAL"
statusstring
  • OPEN - Account is open and available for use in line with its product configuration
  • CLOSED - Account is permanently closed, no further actions can be performed on the account.
  • PENDING - Account is under additional review prior to moving to the OPEN or CLOSED state. No actions can be performed on the account.
  • FROZEN - Account has been temporarily locked for all actions (deposits, transfers, exchanges and withdrawals).
  • EDD - Account (and/or customer) requires enhanced due diligence to be performed. The accounts will operate as if frozen.
  • DORMANT - No activity has been seen in the last 12 months. The account is available for use.
Enum"OPEN""CLOSED""FROZEN""PENDING""EDD""DORMANT"
Headers
Authorizationstring

OAuth bearer token (see authentication flows)

x-l2f-request-idstring

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

curl -i -X GET \
  'https://docs.rail.io/_mock/api-docs/openapi/rail-spec/v1/accounts/deposits?page=0&page_size=0&customer_id=string&product_type=CLIENT&status=OPEN' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-l2f-request-id: string'

Responses

Success

Bodyapplication/json
dataobject(AccountList)required
data.​accountsArray of objects(Account)required

Account List

data.​accounts[].​idstringrequired

Unique Identifier for the account - defined by the Client during account open

data.​accounts[].​statusstringread-onlyrequired

Account Status - will determine servicing options on the account.

  • OPEN - Account is open and available for use in line with its product configuration
  • CLOSED - Account is permanently closed, no further actions can be performed on the account.
  • PENDING - Account is under additional review prior to moving to the OPEN or CLOSED state. No actions can be performed on the account.
  • FROZEN - Account has been temporarily locked for all actions (deposits, transfers, exchanges and withdrawals).
  • EDD - Account (and/or customer) requires enhanced due diligence to be performed. The accounts will operate as if frozen.
  • DORMANT - No activity has been seen in the last 12 months. The account is available for use.
Enum"OPEN""CLOSED""FROZEN""PENDING""EDD""DORMANT"
data.​accounts[].​asset_type_idstringrequired

Asset type IDs follow a simple structure as follows: {$BLOCKCHAIN}_{$NETWORK}_{$CURRENCY_CODE} Simple asset type to test with include

  • ETHEREUM_SEPOLIA_ETH
  • ETHEREUM_SEPOLIA_USDC
  • SOLANA_DEVNET_SOL
  • BITCOIN_TESTNET_BTC
  • FIAT_TESTNET_USD
  • FIAT_TESTNET_USD
  • FIAT_MAINNET_USD
  • FIAT_TESTNET_EUR
data.​accounts[].​product_typestringread-onlyrequired
  • CLIENT - Accounts at the Client level for managing client treasury operations
  • DEPOSIT - Accounts at the Customer level account for managing customer funds on platform
  • VIRTUAL - Accounts at the Customer level account for tracking externally managed customer funds

See account concepts for additional details on these product types

Enum"CLIENT""DEPOSIT""VIRTUAL"
data.​accounts[].​product_idstringrequired

Client Product configuration this account respects. These are configured in the management portal. Default products include BASIC_DEPOSIT

data.​accounts[].​customer_idstringrequired

Customer ID for whom the account belongs to

data.​accounts[].​current_balancenumberrequired

Full balance on the account including funds on hold

data.​accounts[].​available_balancenumberrequired

Balance available for immediate spending (excludes held funds)

linksobject(Page)required

See the pagination section for additional details on the generic pagination approach.

links.​selfstringrequired

endpoint to the current page of results

links.​firststringrequired

endpoint to the first page of results

links.​prevstringrequired

endpoint to the previous page of results

links.​nextstringrequired

endpoint to the next page of results

links.​laststringrequired

endpoint to the last page of results

Response
application/json
{
  "data": {
    "accounts": [ … ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  }
}

Open Account

Request

Opens a new account for a customer of a given product type

Security
OAuth2Flow
Headers
Authorizationstring

OAuth bearer token (see authentication flows)

x-l2f-request-idstring

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

x-l2f-idempotency-idstring

Unique ID used to safely retry an operation. See idempotency section for more details.

Bodyapplication/jsonrequired
customer_idstringrequired

Customer ID of the customer for whom the account is being opened (see /customers)

account_to_openobject(AccountOpen)required

Details of the account to open for the customer

account_to_open.​account_idstringrequired

The identifier you wish to use to uniquely identify this account. The account id follows the External Identifier pattern.

account_to_open.​product_idstringrequired

Select the type of account being opened. You can customise and/or create new product offerings by visiting the Management Interface

Pre configured products that are available for use are

  • DEPOSIT_BASIC
account_to_open.​asset_type_idstringrequired

Select the asset type of the account being opened. Asset type selection is not open ended, it must be configured per product via the Management Interface.

Asset type IDs follow a simple structure as follows: {$BLOCKCHAIN}_{$NETWORK}_{$CURRENCY_CODE} Simple asset type to test with include

  • ETHEREUM_SEPOLIA_ETH
  • ETHEREUM_SEPOLIA_USDC
  • SOLANA_DEVNET_SOL
  • BITCOIN_TESTNET_BTC
  • FIAT_TESTNET_USD
  • FIAT_TESTNET_USD
  • FIAT_MAINNET_USD
  • FIAT_TESTNET_EUR
curl -i -X POST \
  https://docs.rail.io/_mock/api-docs/openapi/rail-spec/v1/accounts/deposits \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-l2f-idempotency-id: string' \
  -H 'x-l2f-request-id: string' \
  -d '{
    "customer_id": "string",
    "account_to_open": {
      "account_id": "string",
      "product_id": "string",
      "asset_type_id": "string"
    }
  }'

Responses

Success

Bodyapplication/json
dataobject(AccountBase)required
data.​idstringrequired

Unique Identifier for the account - defined by the Client during account open

Response
application/json
{
  "data": {
    "id": "string"
  }
}

Retrieve Account

Request

Retrieves the base set of account details for a given account ID

Security
OAuth2Flow
Path
idstringrequired

Account ID

Headers
Authorizationstring

OAuth bearer token (see authentication flows)

x-l2f-request-idstring

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

curl -i -X GET \
  'https://docs.rail.io/_mock/api-docs/openapi/rail-spec/v1/accounts/deposits/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-l2f-request-id: string'

Responses

Success

Bodyapplication/json
dataobject(Account)required
data.​idstringrequired

Unique Identifier for the account - defined by the Client during account open

data.​statusstringread-onlyrequired

Account Status - will determine servicing options on the account.

  • OPEN - Account is open and available for use in line with its product configuration
  • CLOSED - Account is permanently closed, no further actions can be performed on the account.
  • PENDING - Account is under additional review prior to moving to the OPEN or CLOSED state. No actions can be performed on the account.
  • FROZEN - Account has been temporarily locked for all actions (deposits, transfers, exchanges and withdrawals).
  • EDD - Account (and/or customer) requires enhanced due diligence to be performed. The accounts will operate as if frozen.
  • DORMANT - No activity has been seen in the last 12 months. The account is available for use.
Enum"OPEN""CLOSED""FROZEN""PENDING""EDD""DORMANT"
data.​asset_type_idstringrequired

Asset type IDs follow a simple structure as follows: {$BLOCKCHAIN}_{$NETWORK}_{$CURRENCY_CODE} Simple asset type to test with include

  • ETHEREUM_SEPOLIA_ETH
  • ETHEREUM_SEPOLIA_USDC
  • SOLANA_DEVNET_SOL
  • BITCOIN_TESTNET_BTC
  • FIAT_TESTNET_USD
  • FIAT_TESTNET_USD
  • FIAT_MAINNET_USD
  • FIAT_TESTNET_EUR
data.​product_typestringread-onlyrequired
  • CLIENT - Accounts at the Client level for managing client treasury operations
  • DEPOSIT - Accounts at the Customer level account for managing customer funds on platform
  • VIRTUAL - Accounts at the Customer level account for tracking externally managed customer funds

See account concepts for additional details on these product types

Enum"CLIENT""DEPOSIT""VIRTUAL"
data.​product_idstringrequired

Client Product configuration this account respects. These are configured in the management portal. Default products include BASIC_DEPOSIT

data.​customer_idstringrequired

Customer ID for whom the account belongs to

data.​current_balancenumberrequired

Full balance on the account including funds on hold

data.​available_balancenumberrequired

Balance available for immediate spending (excludes held funds)

Response
application/json
{
  "data": {
    "id": "string",
    "status": "OPEN",
    "asset_type_id": "string",
    "product_type": "CLIENT",
    "product_id": "string",
    "customer_id": "string",
    "current_balance": 0,
    "available_balance": 0
  }
}

Update Account

Request

Update an account details. Currently only the account status can be updated.

Security
OAuth2Flow
Path
idstringrequired

Account ID

Headers
Authorizationstring

OAuth bearer token (see authentication flows)

x-l2f-request-idstring

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

Bodyapplication/jsonrequired
updatesArray of objects(PatchAccount)

Follow standard patch guidance

updated_bystring

Description or reference of the system/person who requested the change

reasonstring

String representing the reason for the change.

curl -i -X PATCH \
  'https://docs.rail.io/_mock/api-docs/openapi/rail-spec/v1/accounts/deposits/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-l2f-request-id: string' \
  -d '{
    "updates": [
      {
        "field": "string",
        "value": "string"
      }
    ],
    "updated_by": "string",
    "reason": "string"
  }'

Responses

Success

Bodyapplication/json
dataobject(AccountBase)required
data.​idstringrequired

Unique Identifier for the account - defined by the Client during account open

Response
application/json
{
  "data": {
    "id": "string"
  }
}

Retrieve Transactions

Request

Retrieves all transactions under the given account

Security
OAuth2Flow
Path
idstringrequired

Account ID

Query
pageinteger(int32)

Page of records to get (default 0 = first page)

page_sizeinteger(int32)

Records to return per page (default = 20)

orderstring

Sort order by transaction date (ASC or DESC)

Enum"ASC""DESC"
start_datestring(date)

Filter for transaction from this date

end_datestring(date)

Filter for transaction to this date

Headers
Authorizationstring

OAuth bearer token (see authentication flows)

x-l2f-request-idstring

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

curl -i -X GET \
  'https://docs.rail.io/_mock/api-docs/openapi/rail-spec/v1/accounts/deposits/{id}/transactions?page=0&page_size=0&order=ASC&start_date=2019-08-24&end_date=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-l2f-request-id: string'

Responses

Success

Bodyapplication/json
dataobject(TransactionList)required
data.​transactionsArray of objects(Transaction)required

Transaction List

data.​transactions[].​idstringrequired

Unique Identifier for the transaction

data.​transactions[].​valuenumberrequired

Value of the transaction in the underlying account currency

data.​transactions[].​transaction_datestring(date-time)required

Date time the transaction was performed

data.​transactions[].​transaction_posted_datestring(date-time)

Date time the transaction was posted

data.​transactions[].​transaction_statusstringrequired

Status of transaction

  • AUTHORIZED - Treat as a temporary hold. This transaction impacts the account available balance but does not impact the current balance. Can and should be cancelled and replaced by a pending/posted pair.
  • PENDING - Transaction waiting final confirmation. This transaction impacts the account available balance but does not impact the current balance. Cannot be cancelled as the underlying transaction is in flight.
  • POSTED - Transaction is final. Both the available balance and current balance are impacted. Cannot be reversed.
  • CANCELLED - Transaction is no longer valid. Reverse any impacts to available balance and current balance.
Enum"AUTHORIZED""PENDING""POSTED""CANCELLED"
data.​transactions[].​transaction_typestringrequired

Transaction type

  • TRANSFER_IN - External deposit of crypto funds into an account.
  • TRANSFER_OUT - Withdrawal of crypto funds from an account to an external location .
  • FIAT_TRANSFER_IN - External deposit of FIAT funds into an account.
  • FIAT_TRANSFER_OUT - Withdrawal of FIAT funds from an account to an external location .
  • FIAT_TRANSFER_IN_RETURN - Clawback of a FIAT deposit (e.g. due to bankiing error).
  • FIAT_TRANSFER_OUT_RETURN - Return of a FIAT withdrawal (e.g. due to the destination account being closed)
  • DEBIT_CORRECTION - Debit account adjustment.
  • CREDIT_CORRECTION - Credit account adjustment.
  • TRADE - Currency exchange transaction (applies to both the debit on the source account or credit on the destination account).
  • FEE - Fee deduction.
  • INTERNAL_TRANSFER - Book (internal) movement of funds between account.
Enum"TRANSFER_IN""TRANSFER_OUT""FEE""DEBIT_CORRECTION""CREDIT_CORRECTION""TRADE""INTERNAL_TRANSFER"
data.​transactions[].​category_typestring

If this transaction related to a core platform feature

  • DEPOSIT - When this transaction was a result of a deposit.
  • EXCHANGE - When this transaction was a result of an exchange.
  • TRANSFER - When this transaction was a result of a transfer.
  • WITHDRAWAL - When this transaction was a result of a withdrawal.
Enum"ADJUSTMENT""DEPOSIT""EXCHANGE""TRANSFER""WITHDRAWAL"
data.​transactions[].​category_idstring

Where the category_type is present, this identifier allows you to lookup the category details using the standard APIs. For example, where a category_type is TRANSFER and the category_id is abc-123, you can lookup the original transfer that this transaction relates to using GET /transfers/abc-123

data.​transactions[].​descriptionstring

Description

data.​transactions[].​originatorobject(TransactionOriginator)

Where the type of transaction is TRANSFER_IN, the available details of the originator of the transaction

data.​transactions[].​rail_informationobject(RailInformation)

Where the type of transaction is TRANSFER_IN, the available details of the originator of the transaction

linksobject(Page)required

See the pagination section for additional details on the generic pagination approach.

links.​selfstringrequired

endpoint to the current page of results

links.​firststringrequired

endpoint to the first page of results

links.​prevstringrequired

endpoint to the previous page of results

links.​nextstringrequired

endpoint to the next page of results

links.​laststringrequired

endpoint to the last page of results

Response
application/json
{
  "data": {
    "transactions": [ … ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  }
}

Retrieve Transaction

Request

Retrieves details of a single transaction under the given account

Security
OAuth2Flow
Path
idstringrequired

Transaction ID

Headers
Authorizationstring

OAuth bearer token (see authentication flows)

x-l2f-request-idstring

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

curl -i -X GET \
  'https://docs.rail.io/_mock/api-docs/openapi/rail-spec/v1/accounts/deposits/{id}/transactions/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-l2f-request-id: string'

Responses

Success

Bodyapplication/json
dataobject(TransactionDetails)required
data.​idstringrequired

Unique Identifier for the transaction

data.​valuenumberrequired

Value of the transaction in the underlying account currency

data.​transaction_datestring(date-time)required

Date time the transaction was performed

data.​transaction_posted_datestring(date-time)

Date time the transaction was posted

data.​transaction_statusstringrequired

Status of transaction

  • AUTHORIZED - Treat as a temporary hold. This transaction impacts the account available balance but does not impact the current balance. Can and should be cancelled and replaced by a pending/posted pair.
  • PENDING - Transaction waiting final confirmation. This transaction impacts the account available balance but does not impact the current balance. Cannot be cancelled as the underlying transaction is in flight.
  • POSTED - Transaction is final. Both the available balance and current balance are impacted. Cannot be reversed.
  • CANCELLED - Transaction is no longer valid. Reverse any impacts to available balance and current balance.
Enum"AUTHORIZED""PENDING""POSTED""CANCELLED"
data.​transaction_typestringrequired

Transaction type

  • TRANSFER_IN - External deposit of crypto funds into an account.
  • TRANSFER_OUT - Withdrawal of crypto funds from an account to an external location .
  • FIAT_TRANSFER_IN - External deposit of FIAT funds into an account.
  • FIAT_TRANSFER_OUT - Withdrawal of FIAT funds from an account to an external location .
  • FIAT_TRANSFER_IN_RETURN - Clawback of a FIAT deposit (e.g. due to bankiing error).
  • FIAT_TRANSFER_OUT_RETURN - Return of a FIAT withdrawal (e.g. due to the destination account being closed)
  • DEBIT_CORRECTION - Debit account adjustment.
  • CREDIT_CORRECTION - Credit account adjustment.
  • TRADE - Currency exchange transaction (applies to both the debit on the source account or credit on the destination account).
  • FEE - Fee deduction.
  • INTERNAL_TRANSFER - Book (internal) movement of funds between account.
Enum"TRANSFER_IN""TRANSFER_OUT""FEE""DEBIT_CORRECTION""CREDIT_CORRECTION""TRADE""INTERNAL_TRANSFER"
data.​category_typestring

If this transaction related to a core platform feature

  • DEPOSIT - When this transaction was a result of a deposit.
  • EXCHANGE - When this transaction was a result of an exchange.
  • TRANSFER - When this transaction was a result of a transfer.
  • WITHDRAWAL - When this transaction was a result of a withdrawal.
Enum"ADJUSTMENT""DEPOSIT""EXCHANGE""TRANSFER""WITHDRAWAL"
data.​category_idstring

Where the category_type is present, this identifier allows you to lookup the category details using the standard APIs. For example, where a category_type is TRANSFER and the category_id is abc-123, you can lookup the original transfer that this transaction relates to using GET /transfers/abc-123

data.​descriptionstring

Description

data.​originatorobject(TransactionOriginator)

Where the type of transaction is TRANSFER_IN, the available details of the originator of the transaction

data.​rail_informationobject(RailInformation)

Where the type of transaction is TRANSFER_IN, the available details of the originator of the transaction

Response
application/json
{
  "data": {
    "id": "string",
    "value": 0,
    "transaction_date": "2019-08-24T14:15:22Z",
    "transaction_posted_date": "2019-08-24T14:15:22Z",
    "transaction_status": "AUTHORIZED",
    "transaction_type": "TRANSFER_IN",
    "category_type": "ADJUSTMENT",
    "category_id": "string",
    "description": "string",
    "originator": { … },
    "rail_information": { … }
  }
}

Retrieve Statements

Request

Retrieves a paginated list of statements for a given account id.

Security
OAuth2Flow
Path
idstringrequired

Account ID

Query
pageinteger(int32)

Page of records to get (default 0 = first page)

page_sizeinteger(int32)

Records to return per page (default = 20)

Headers
Authorizationstring

OAuth bearer token (see authentication flows)

x-l2f-request-idstring

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

curl -i -X GET \
  'https://docs.rail.io/_mock/api-docs/openapi/rail-spec/v1/accounts/deposits/{id}/statements?page=0&page_size=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-l2f-request-id: string'

Responses

Success

Bodyapplication/json
dataobject(StatementList)required
data.​statementsArray of objects(StatementSummary)required

Statement List

data.​statements[].​idstringrequired

Statement identifier

data.​statements[].​yearinteger(int32)required

Statement year

data.​statements[].​monthinteger(int32)required

Statement month

linksobject(Page)required

See the pagination section for additional details on the generic pagination approach.

links.​selfstringrequired

endpoint to the current page of results

links.​firststringrequired

endpoint to the first page of results

links.​prevstringrequired

endpoint to the previous page of results

links.​nextstringrequired

endpoint to the next page of results

links.​laststringrequired

endpoint to the last page of results

Response
application/json
{
  "data": {
    "statements": [ … ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  }
}

Retrieve Statement

Request

Retrieves the statement for a specific month and year for a given account id.

Security
OAuth2Flow
Path
account_idstringrequired

Account ID

statement_idstringrequired

Statement ID

Headers
Authorizationstring

OAuth bearer token (see authentication flows)

x-l2f-request-idstring

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

curl -i -X GET \
  'https://docs.rail.io/_mock/api-docs/openapi/rail-spec/v1/accounts/deposits/{account_id}/statements/{statement_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-l2f-request-id: string'

Responses

Success

Bodyapplication/json
dataobject(Statement)required
data.​account_idstringrequired

Account identifier

data.​asset_type_idstringrequired

Asset type identifier

data.​statement_periodstringrequired

Statement period

data.​opening_balancenumberrequired

Opening balance for the statement period

data.​closing_balancenumberrequired

Closing balance for the statement period

data.​customerobject(StatementCustomer)required

Customer information

data.​customer.​namestringrequired

Customer name

data.​customer.​address1string

Address Line 1

data.​customer.​address2string

Address Line 2

data.​customer.​address3string

Address Line 3

data.​customer.​citystring

City

data.​customer.​statestring

State / Province

data.​customer.​postal_codestring

Postal / Zip Code

data.​customer.​countrystring

Country

data.​transactionsArray of objects(StatementTransaction)required

List of transactions for the statement period

data.​transactions[].​transaction_idstringrequired

Transaction identifier

data.​transactions[].​transaction_typestringrequired

Type of transaction

data.​transactions[].​descriptionstringrequired

Transaction description

data.​transactions[].​transaction_datestring(date-time)required

Date time the transaction was performed

data.​transactions[].​transaction_posted_datestring(date-time)required

Date time the transaction was posted

data.​transactions[].​amountnumberrequired

Transaction amount

data.​transactions[].​balancenumberrequired

Account balance after transaction

Response
application/json
{
  "data": {
    "account_id": "string",
    "asset_type_id": "string",
    "statement_period": "string",
    "opening_balance": 0,
    "closing_balance": 0,
    "customer": { … },
    "transactions": [ … ]
  }
}

Counterparties

Counterparties represent external entities that you may wish to send or receive funds from. All counterparties are verified to ensure compliance with regulatory requirements prior to being available for use for withdrawals.

Operations

Customers

Customers can only be created via the application process. Once created, customers can have multiple accounts associated with them.

Operations

Deposits

Deposits are used to request instructions for funding platform managed accounts from external sources. A given account may have many deposits associated with it depending on the supported rails and configurations.

Operations

Documents

Document uploading and management functions.

Operations

Exchanges

Exchanges are used to convert funds from one currency to another. This is achieved by moving money between 2 platform accounts that are denominated in different currencies. We have eliminated the complexity of traditional currency trading.

Operations

Payments

Payments are used to orchestrate end to end payment flows from external parties or from within the platform.

Operations

Transactions

Transactions are created to record the movement of funds between accounts. The transactions endpoint allows the bulk retrieval of transaction data for reconciliation and reporting purposes.

Operations

Transfers

Transfer are used to move funds between two platform managed accounts that are denominated in the same currency.

Operations

Withdrawals

Move funds from a platform managed account to an external counterparty via supported rails.

Operations

Settlements

Settlement services for funds confirmation and reconciliation. Settlements are a deprecated concept and will be removed in future versions of the API. Please use Payments for all new integrations.

Operations

Subscriptions (Webhooks)

Manage your callback (webhook) subscriptions. Subscriptions allow you to receive real-time notifications of events that occur within your platform instance. Visit the guides for a full breakdown of all available events.

Operations
© 2026 Rail. All Rights Reserved.