Create internal recipient

POST /recipients/internal

Bearer auth

Create a recipient for local/internal bank transfers

Headers

Workspace-ID integer Required

The workspace ID - to identify the sub-user

application/json

Body Required

accountCode string Required

Recipient account code/number
alias string

Optional recipient nickname
saved boolean Required

Save recipient for future use

Responses

201 application/json

Recipient created successfully
Hide response attributes Show response 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
400 application/json

Invalid request
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
409

Recipient already exists

POST /recipients/internal

curl \
 --request POST 'https://bank.bank.place/recipients/internal' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "Workspace-ID: 42" \
 --data '{"alias":"Amy","saved":true,"accountCode":"10000010000040"}'

Request example

{
  "alias": "Amy",
  "saved": true,
  "accountCode": "10000010000040"
}

Response examples (201)

{
  "id": 295,
  "name": "My Nguyen",
  "alias": "Amy",
  "edges": {
    "currency": {
      "id": 11,
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  },
  "saved": true,
  "createdAt": "2025-01-06T08:29:15.333949Z",
  "accountCode": "10000010000040"
}

Response examples (400)

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

Response examples (401)

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