POST
/
api
/
v2.1
/
wallet-transfers
/
beneficiaries
/
{customerId}
curl --request POST \
  --url https://sandbox.finhub.cloud/api/v2.1/wallet-transfers/beneficiaries/{customerId} \
  --header 'Content-Type: application/json' \
  --header 'X-Forwarded-For: <x-forwarded-for>' \
  --data '{
  "name": "John Doe",
  "type": "INDIVIDUAL",
  "network": {
    "networkId": "SWIFT",
    "name": "SWIFT Network",
    "description": "Society for Worldwide Interbank Financial Telecommunication"
  },
  "networkAddresses": [
    {
      "addressId": "addr123",
      "address": "GB29NWBK60161331926819",
      "type": "IBAN",
      "primary": true
    },
    {
      "addressId": "addr124",
      "address": "CHASUS33",
      "type": "BIC",
      "primary": false
    }
  ],
  "description": "International bank account",
  "metadata": {
    "bankName": "Chase Bank"
  }
}'
{
  "code": 200,
  "message": "Beneficiary created successfully",
  "data": {
    "beneficiaryId": "ben123",
    "customerId": "cust456",
    "tenantId": "tenant123",
    "lineOfBusiness": "retail",
    "name": "John Doe",
    "description": "International bank account",
    "assetAddress": "GB29NWBK60161331926819",
    "network": {
      "networkId": "SWIFT",
      "name": "SWIFT Network",
      "description": "Society for Worldwide Interbank Financial Telecommunication",
      "addresses": [
        {
          "addressId": "addr123",
          "address": "GB29NWBK60161331926819",
          "type": "IBAN",
          "primary": true
        },
        {
          "addressId": "addr124",
          "address": "CHASUS33",
          "type": "BIC",
          "primary": false
        }
      ]
    }
  }
}

Headers

​
X-Forwarded-For
string
required

Forwarded client IP address

​
User-Agent
string

Client user agent information

​
X-Tenant-ID
string

Tenant identifier for multi-tenant operations

Path Parameters

​
customerId
string
required

Customer identifier

Query Parameters

​
businessArea
string

Business area

​
capability
string

Capability type

​
lineOfBusiness
string

Line of business context

​
organizationId
string

Organization identifier

​
service
string

Service type

Body

application/json

Beneficiary request for SWIFT network transfers

​
name
string
required
​
type
string
required
​
bic
string
required
​
iban
string
required
Required string length: 15 - 34
​
bankName
string
required
​
description
string
​
metadata
object
​
commonFields
object
​
accountNumber
string
​
bankAddress
string
​
intermediaryBankBic
string
​
intermediaryBankName
string
​
network
object

Network information for wallet transfers

​
networkAddresses
object[]
​
networkId
string
deprecated
​
valid
boolean

Response

Beneficiary created successfully

​
customerId
string
required
​
tenantId
string
required
​
lineOfBusiness
string
required
​
assetAddress
string
required
​
network
object
required

Network information for wallet transfers

​
beneficiaryId
string
​
name
string
​
description
string
​
networkAddresses
object[]
​
assetAddressWithNetwork
object

Asset address with network information