Create transfer order

POST /accounts/{accountId}/orders

Create a transfer order from an account to a recipient. Requires Ed25519 signature for security. See the 'Ed25519 Signature' topic for implementation details.

Headers

Workspace-ID integer Required

The workspace ID - to identify the sub-user
X-Nonce string Required

Unix timestamp in milliseconds (for deduplication and replay protection)
X-Signature string Required

Ed25519 signature of the request hash See the 'Ed25519 Signature'.

Path parameters

accountId integer Required

Source account ID

application/json

Body Required

Transfer order details

amount string Required

Amount in smallest currency unit (e.g., cents for USD). The 'decimals' field in the Currency model tells you how many decimal places the currency uses. For example, if decimals = 2 for USD, all amounts are stored in cents (the smallest unit), so 2000 means 2000 cents, or $20.00
description string

Optional transfer description (max 512 chars, alphanumeric only)
purposeCode string

Purpose code from /orders/purposes
recipientID integer Required

Recipient ID from /recipients endpoint
repeatUnit string

For recurring transfers

Values are daily, weekly, or monthly.
repeatValue integer

Repeat interval value (for recurring)
startAt string

ISO 8601 timestamp for scheduled/recurring transfers
stopAt string

ISO 8601 timestamp to stop recurring transfers
type string Required

Order type

Values are instant, scheduled, or recurring.

Responses

200 application/json

Order created successfully
Hide response attributes Show response attributes object
- amount string Required
  
  Transfer amount (in smallest unit, e.g. cents for USD)
- createdAt string
  
  Creation timestamp
- description string
  
  Transfer description
- edges object
  
  Hide edges attributes Show edges attributes object
  
  account object
  
  Bank account holding a specific currency with balance tracking
  
  Hide account attributes Show account attributes object
  
  alias string
  
  Account nickname
  
  code string
  
  Core Banking System account code
  
  createdAt string
  
  Creation timestamp
  
  edges object
  
  Hide edges attributes Show edges attributes object
  
  balances array[object] Required
  
  Account balance snapshot at a point in time
  
  Hide balances attributes Show balances attributes object
  
  amount integer Required
  
  Balance amount in smallest currency unit (e.g., cents)
  
  createdAt string
  
  Creation timestamp
  
  id integer Required
  
  Balance ID
  
  updatedAt string
  
  Last update timestamp
  
  currency object Required
  
  Currency information including symbol, code, and decimal places
  
  Hide currency attributes Show currency attributes object
  
  code string Required
  
  ISO currency code (e.g., USD, EUR)
  
  createdAt string
  
  Creation timestamp
  
  decimals integer
  
  Number of decimal places
  
  id integer Required
  
  Currency ID
  
  name string Required
  
  Currency full name
  
  swiftMinimumWithdrawalAmount string
  
  Minimum SWIFT withdrawal amount
  
  symbol string
  
  Currency symbol (e.g., $, €)
  
  updatedAt string
  
  Last update timestamp
  
  product object Required
  
  Banking product (currency account type) available for creation
  
  Hide product attributes Show product attributes object
  
  createdAt string
  
  Creation timestamp
  
  description string
  
  Product description
  
  edges object
  
  Hide edges attribute Show edges attribute object
  
  currency object Required
  
  Currency information including symbol, code, and decimal places
  
  Hide currency attributes Show currency attributes object
  
  code string Required
  
  ISO currency code (e.g., USD, EUR)
  
  createdAt string
  
  Creation timestamp
  
  decimals integer
  
  Number of decimal places
  
  id integer Required
  
  Currency ID
  
  name string Required
  
  Currency full name
  
  swiftMinimumWithdrawalAmount string
  
  Minimum SWIFT withdrawal amount
  
  symbol string
  
  Currency symbol (e.g., $, €)
  
  updatedAt string
  
  Last update timestamp
  
  id integer Required
  
  Product ID
  
  name string Required
  
  Product name
  
  updatedAt string
  
  Last update timestamp
  
  id integer Required
  
  Account ID
  
  name string Required
  
  Account holder name
  
  status string Required
  
  Account status (enabled/disabled)
  
  type string Required
  
  Account type (e.g., CACC)
  
  updatedAt string
  
  Last update timestamp
  
  events array[object]
  
  Event log for order lifecycle tracking
  
  Hide events attributes Show events attributes object
  
  createdAt string
  
  Creation timestamp
  
  id integer Required
  
  Event ID
  
  message string
  
  Event message
  
  type string
  
  Event type
  
  updatedAt string
  
  Last update timestamp
  
  executions array[object]
  
  Execution of a scheduled or recurring order
  
  Hide executions attributes Show executions attributes object
  
  createdAt string
  
  Creation timestamp
  
  edges object
  
  Hide edges attribute Show edges attribute object
  
  transaction object
  
  Transaction represents the execution of a transfer with status tracking
  
  Hide transaction attributes Show transaction attributes object
  
  createdAt string
  
  Creation timestamp
  
  edges object
  
  Hide edges attributes Show edges attributes object
  
  internationalRemittance object
  
  International money transfer details and tracking
  
  Hide internationalRemittance attributes Show internationalRemittance attributes object
  
  createdAt string
  
  Creation timestamp
  
  edges object
  
  Hide edges attribute Show edges attribute object
  
  events array[object]
  
  International transaction event from payment provider
  
  Hide events attributes Show events attributes object
  
  createdAt string
  
  Creation timestamp
  
  id integer Required
  
  Event ID
  
  lastUpdatedAt string
  
  Last update timestamp
  
  message string
  
  Event message or status description
  
  status string Required
  
  Transaction status
  
  id integer Required
  
  International remittance ID
  
  updatedAt string
  
  Last update timestamp
  
  transfers array[object]
  
  Executed transfer moving funds between accounts
  
  Hide transfers attributes Show transfers attributes object
  
  amount string Required
  
  Transfer amount (in smallest unit)
  
  createdAt string
  
  Creation timestamp
  
  description string
  
  Transfer description
  
  direction string
  
  Transfer direction (debit/credit)
  
  edges object
  
  Hide edges attributes Show edges attributes object
  
  account object
  
  Bank account holding a specific currency with balance tracking
  
  Hide account attributes Show account attributes object
  
  alias string
  
  Account nickname
  
  code string
  
  Core Banking System account code
  
  createdAt string
  
  Creation timestamp
  
  edges object
  
  Hide edges attributes Show edges attributes object
  
  balances array[object] Required
  
  Account balance snapshot at a point in time
  
  Hide balances attributes Show balances attributes object
  
  amount integer Required
  
  Balance amount in smallest currency unit (e.g., cents)
  
  createdAt string
  
  Creation timestamp
  
  id integer Required
  
  Balance ID
  
  updatedAt string
  
  Last update timestamp
  
  currency object Required
  
  Currency information including symbol, code, and decimal places
  
  Hide currency attributes Show currency attributes object
  
  code string Required
  
  ISO currency code (e.g., USD, EUR)
  
  createdAt string
  
  Creation timestamp
  
  decimals integer
  
  Number of decimal places
  
  id integer Required
  
  Currency ID
  
  name string Required
  
  Currency full name
  
  swiftMinimumWithdrawalAmount string
  
  Minimum SWIFT withdrawal amount
  
  symbol string
  
  Currency symbol (e.g., $, €)
  
  updatedAt string
  
  Last update timestamp
  
  product object Required
  
  Banking product (currency account type) available for creation
  
  Hide product attributes Show product attributes object
  
  createdAt string
  
  Creation timestamp
  
  description string
  
  Product description
  
  edges object
  
  Hide edges attribute Show edges attribute object
  
  currency object Required
  
  Currency information including symbol, code, and decimal places
  
  Hide currency attributes Show currency attributes object
  
  code string Required
  
  ISO currency code (e.g., USD, EUR)
  
  createdAt string
  
  Creation timestamp
  
  decimals integer
  
  Number of decimal places
  
  id integer Required
  
  Currency ID
  
  name string Required
  
  Currency full name
  
  swiftMinimumWithdrawalAmount string
  
  Minimum SWIFT withdrawal amount
  
  symbol string
  
  Currency symbol (e.g., $, €)
  
  updatedAt string
  
  Last update timestamp
  
  id integer Required
  
  Product ID
  
  name string Required
  
  Product name
  
  updatedAt string
  
  Last update timestamp
  
  id integer Required
  
  Account ID
  
  name string Required
  
  Account holder name
  
  status string Required
  
  Account status (enabled/disabled)
  
  type string Required
  
  Account type (e.g., CACC)
  
  updatedAt string
  
  Last update timestamp
  
  balance object
  
  Account balance snapshot at a point in time
  
  Hide balance attributes Show balance attributes object
  
  amount integer Required
  
  Balance amount in smallest currency unit (e.g., cents)
  
  createdAt string
  
  Creation timestamp
  
  id integer Required
  
  Balance ID
  
  updatedAt string
  
  Last update timestamp
  
  recipient object
  
  Transfer recipient with account details for domestic or international transfers
  
  Hide recipient attributes Show recipient attributes object
  
  accountCode string Required
  
  Recipient account code
  
  alias string
  
  Recipient nickname
  
  createdAt string
  
  Creation timestamp
  
  edges object
  
  Hide edges attributes Show edges attributes object
  
  bank object
  
  Bank information including name and SWIFT code
  
  Hide bank attributes Show bank attributes object
  
  countryCode string
  
  Bank country code (ISO 3166-1 alpha-2)
  
  createdAt string
  
  Creation timestamp
  
  id integer Required
  
  Bank ID
  
  name string Required
  
  Bank name
  
  swiftCode string
  
  Bank SWIFT/BIC code
  
  updatedAt string
  
  Last update timestamp
  
  beneficiary object
  
  Beneficiary information for international transfers
  
  Hide beneficiary attributes Show beneficiary attributes object
  
  createdAt string
  
  Creation timestamp
  
  data object
  
  id integer Required
  
  Beneficiary ID
  
  updatedAt string
  
  Last update timestamp
  
  currency object
  
  Currency information including symbol, code, and decimal places
  
  Hide currency attributes Show currency attributes object
  
  code string Required
  
  ISO currency code (e.g., USD, EUR)
  
  createdAt string
  
  Creation timestamp
  
  decimals integer
  
  Number of decimal places
  
  id integer Required
  
  Currency ID
  
  name string Required
  
  Currency full name
  
  swiftMinimumWithdrawalAmount string
  
  Minimum SWIFT withdrawal amount
  
  symbol string
  
  Currency symbol (e.g., $, €)
  
  updatedAt string
  
  Last update timestamp
  
  id integer Required
  
  Recipient ID
  
  name string Required
  
  Recipient name
  
  saved boolean
  
  Whether recipient is saved
  
  updatedAt string
  
  Last update timestamp
  
  transaction object
  
  Transaction represents the execution of a transfer with status tracking
  
  feeAmount string
  
  Fee amount charged for the transfer
  
  id integer Required
  
  Transfer ID
  
  purpose string
  
  Transfer purpose
  
  type string
  
  Transfer type (spot, etc.)
  
  updatedAt string
  
  Last update timestamp
  
  hash string
  
  Transaction hash
  
  id integer Required
  
  Transaction ID
  
  status string Required
  
  Transaction status (pending/completed/failed)
  
  updatedAt string
  
  Last update timestamp
  
  id integer Required
  
  Execution ID
  
  updatedAt string
  
  Last update timestamp
  
  recipient object
  
  Transfer recipient with account details for domestic or international transfers
  
  Hide recipient attributes Show recipient attributes object
  
  accountCode string Required
  
  Recipient account code
  
  alias string
  
  Recipient nickname
  
  createdAt string
  
  Creation timestamp
  
  edges object
  
  Hide edges attributes Show edges attributes object
  
  bank object
  
  Bank information including name and SWIFT code
  
  Hide bank attributes Show bank attributes object
  
  countryCode string
  
  Bank country code (ISO 3166-1 alpha-2)
  
  createdAt string
  
  Creation timestamp
  
  id integer Required
  
  Bank ID
  
  name string Required
  
  Bank name
  
  swiftCode string
  
  Bank SWIFT/BIC code
  
  updatedAt string
  
  Last update timestamp
  
  beneficiary object
  
  Beneficiary information for international transfers
  
  Hide beneficiary attributes Show beneficiary attributes object
  
  createdAt string
  
  Creation timestamp
  
  data object
  
  id integer Required
  
  Beneficiary ID
  
  updatedAt string
  
  Last update timestamp
  
  currency object
  
  Currency information including symbol, code, and decimal places
  
  Hide currency attributes Show currency attributes object
  
  code string Required
  
  ISO currency code (e.g., USD, EUR)
  
  createdAt string
  
  Creation timestamp
  
  decimals integer
  
  Number of decimal places
  
  id integer Required
  
  Currency ID
  
  name string Required
  
  Currency full name
  
  swiftMinimumWithdrawalAmount string
  
  Minimum SWIFT withdrawal amount
  
  symbol string
  
  Currency symbol (e.g., $, €)
  
  updatedAt string
  
  Last update timestamp
  
  id integer Required
  
  Recipient ID
  
  name string Required
  
  Recipient name
  
  saved boolean
  
  Whether recipient is saved
  
  updatedAt string
  
  Last update timestamp
- id integer Required
  
  Order ID
- purposeCode string
  
  Transfer purpose code
- repeatUnit string
  
  Repeat unit (daily/weekly/monthly)
- repeatValue integer
  
  Repeat interval value
- startAt string
  
  Start timestamp
- status string Required
  
  Order status
- stopAt string
  
  Stop timestamp (for recurring orders)
- type string Required
  
  Order type (instant/scheduled/recurring)
- updatedAt string
  
  Last update timestamp
400 application/json

Invalid request or insufficient funds
Hide response attributes Show response attributes object
- errorCode string Required
  
  Error code
- message string Required
  
  Error message
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- errorCode string Required
  
  Error code
- message string Required
  
  Error message
403 application/json

Invalid signature
Hide response attributes Show response attributes object
- errorCode string Required
  
  Error code
- message string Required
  
  Error message

POST /accounts/{accountId}/orders

curl \
 --request POST 'https://auth.bank.place/accounts/{accountId}/orders' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "Workspace-ID: 42" \
 --header "X-Nonce: 1704528000000" \
 --header "X-Signature: 3iJWNwZfE/tGNgPE8/eU0RN9aMEkJ5IWnhGV1vZ0HXqhpBJ4kZJZrY7wQH2M..." \
 --data '{"type":"instant","amount":"100000","description":"From My","purposeCode":"IR001","recipientID":368}'

Request example

{
  "type": "instant",
  "amount": "100000",
  "description": "From My",
  "purposeCode": "IR001",
  "recipientID": 368
}

Response examples (200)

{
  "amount": "string",
  "createdAt": "string",
  "description": "string",
  "edges": {
    "account": {
      "alias": "string",
      "code": "string",
      "createdAt": "string",
      "edges": {
        "balances": [
          {
            "amount": 42,
            "createdAt": "string",
            "id": 42,
            "updatedAt": "string"
          }
        ],
        "currency": {
          "code": "string",
          "createdAt": "string",
          "decimals": 42,
          "id": 42,
          "name": "string",
          "swiftMinimumWithdrawalAmount": "string",
          "symbol": "string",
          "updatedAt": "string"
        },
        "product": {
          "createdAt": "string",
          "description": "string",
          "edges": {
            "currency": {
              "code": "string",
              "createdAt": "string",
              "decimals": 42,
              "id": 42,
              "name": "string",
              "swiftMinimumWithdrawalAmount": "string",
              "symbol": "string",
              "updatedAt": "string"
            }
          },
          "id": 42,
          "name": "string",
          "updatedAt": "string"
        }
      },
      "id": 42,
      "name": "string",
      "status": "string",
      "type": "string",
      "updatedAt": "string"
    },
    "events": [
      {
        "createdAt": "string",
        "id": 42,
        "message": "string",
        "type": "string",
        "updatedAt": "string"
      }
    ],
    "executions": [
      {
        "createdAt": "string",
        "edges": {
          "transaction": {
            "createdAt": "string",
            "edges": {
              "internationalRemittance": {
                "createdAt": "string",
                "edges": {
                  "events": [
                    {
                      "createdAt": "string",
                      "id": 42,
                      "lastUpdatedAt": "string",
                      "message": "string",
                      "status": "string"
                    }
                  ]
                },
                "id": 42,
                "updatedAt": "string"
              },
              "transfers": [
                {
                  "amount": "string",
                  "createdAt": "string",
                  "description": "string",
                  "direction": "string",
                  "edges": {
                    "account": {
                      "alias": "string",
                      "code": "string",
                      "createdAt": "string",
                      "edges": {
                        "balances": [
                          {
                            "amount": 42,
                            "createdAt": "string",
                            "id": 42,
                            "updatedAt": "string"
                          }
                        ],
                        "currency": {
                          "code": "string",
                          "createdAt": "string",
                          "decimals": 42,
                          "id": 42,
                          "name": "string",
                          "swiftMinimumWithdrawalAmount": "string",
                          "symbol": "string",
                          "updatedAt": "string"
                        },
                        "product": {
                          "createdAt": "string",
                          "description": "string",
                          "edges": {
                            "currency": {
                              "code": "string",
                              "createdAt": "string",
                              "decimals": 42,
                              "id": 42,
                              "name": "string",
                              "swiftMinimumWithdrawalAmount": "string",
                              "symbol": "string",
                              "updatedAt": "string"
                            }
                          },
                          "id": 42,
                          "name": "string",
                          "updatedAt": "string"
                        }
                      },
                      "id": 42,
                      "name": "string",
                      "status": "string",
                      "type": "string",
                      "updatedAt": "string"
                    },
                    "balance": {
                      "amount": 42,
                      "createdAt": "string",
                      "id": 42,
                      "updatedAt": "string"
                    },
                    "recipient": {
                      "accountCode": "string",
                      "alias": "string",
                      "createdAt": "string",
                      "edges": {
                        "bank": {
                          "countryCode": "string",
                          "createdAt": "string",
                          "id": 42,
                          "name": "string",
                          "swiftCode": "string",
                          "updatedAt": "string"
                        },
                        "beneficiary": {
                          "createdAt": "string",
                          "data": {},
                          "id": 42,
                          "updatedAt": "string"
                        },
                        "currency": {
                          "code": "string",
                          "createdAt": "string",
                          "decimals": 42,
                          "id": 42,
                          "name": "string",
                          "swiftMinimumWithdrawalAmount": "string",
                          "symbol": "string",
                          "updatedAt": "string"
                        }
                      },
                      "id": 42,
                      "name": "string",
                      "saved": true,
                      "updatedAt": "string"
                    },
                    "transaction": {}
                  },
                  "feeAmount": "string",
                  "id": 42,
                  "purpose": "string",
                  "type": "string",
                  "updatedAt": "string"
                }
              ]
            },
            "hash": "string",
            "id": 42,
            "status": "string",
            "updatedAt": "string"
          }
        },
        "id": 42,
        "updatedAt": "string"
      }
    ],
    "recipient": {
      "accountCode": "string",
      "alias": "string",
      "createdAt": "string",
      "edges": {
        "bank": {
          "countryCode": "string",
          "createdAt": "string",
          "id": 42,
          "name": "string",
          "swiftCode": "string",
          "updatedAt": "string"
        },
        "beneficiary": {
          "createdAt": "string",
          "data": {},
          "id": 42,
          "updatedAt": "string"
        },
        "currency": {
          "code": "string",
          "createdAt": "string",
          "decimals": 42,
          "id": 42,
          "name": "string",
          "swiftMinimumWithdrawalAmount": "string",
          "symbol": "string",
          "updatedAt": "string"
        }
      },
      "id": 42,
      "name": "string",
      "saved": true,
      "updatedAt": "string"
    }
  },
  "id": 42,
  "purposeCode": "string",
  "repeatUnit": "string",
  "repeatValue": 42,
  "startAt": "string",
  "status": "string",
  "stopAt": "string",
  "type": "string",
  "updatedAt": "string"
}

Response examples (400)

{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}

Response examples (401)

{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}

Response examples (403)

{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}