Create beneficiaries

POST 
/v1/beneficiaries

Allows creation of beneficiary information

Request

Header Parameters

ApiKey stringrequired
AccountId stringrequired

application/json

Body

required

beneficiaries object[]required
List of beneficiary properties for creating beneficiaries
Array [
externalId stringrequired
Unique ID from an external system
type stringrequired
Possible values: [INDIVIDUAL, BUSINESS]
Type of Beneficiary
name stringrequired
Full name of the beneficiary
currency stringrequired
Possible values: Value must match regular expression [A-Z]{3}
Currency used for transactions with the beneficiary
beneficiaryAddress object
Details of the Beneficiary's physical address
addressLine1 stringrequired
Possible values: <= 35 characters
First line of the address
addressLine2 string
Possible values: <= 35 characters
Second line of the address (if any)
city string
Possible values: <= 35 characters
City of the address
countryIso2 stringrequired
Country of the address
postalCode string
Possible values: <= 35 characters
Postal code of the address
accountNumber string
Account number of the beneficiary in the bank
bankCode string
Code of the beneficiary's bank
iban string
International Bank Account Number of the beneficiary
bic string
Bank Identifier Code of the beneficiary's bank
intermediaryBankIdentifier string
Identifier of the intermediary bank, if any
bankCountry stringrequired
Country where the beneficiary's bank is located
]

Responses

201

Created

application/json

Schema

Schema

content object[]
Array [
id uuidrequired
Unique identifier for the beneficiary
shortId stringrequired
Short, human-readable ID for the beneficiary
externalId stringrequired
Unique ID from an external system
type stringrequired
Possible values: [INDIVIDUAL, BUSINESS]
Type of Beneficiary
name stringrequired
Full name of the beneficiary
currency stringrequired
Possible values: Value must match regular expression [A-Z]{3}
Currency used for transactions with the beneficiary
beneficiaryAddress object
Details of the Beneficiary's physical address
addressLine1 stringrequired
Possible values: <= 35 characters
First line of the address
addressLine2 string
Possible values: <= 35 characters
Second line of the address (if any)
city string
Possible values: <= 35 characters
City of the address
countryIso2 stringrequired
Country of the address
postalCode string
Possible values: <= 35 characters
Postal code of the address
accountNumber string
Account number of the beneficiary in the bank
bankCode string
Code of the beneficiary's bank
iban string
International Bank Account Number of the beneficiary
bic string
Bank Identifier Code of the beneficiary's bank
intermediaryBankIdentifier string
Identifier of the intermediary bank, if any
bankCountry stringrequired
Country where the beneficiary's bank is located
]
number int32
size int32
totalElements int64
last boolean
totalPages int32
first boolean
sort object
empty boolean
sorted boolean
unsorted boolean
numberOfElements int32
empty boolean

Example (from schema)

{
  "content": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "shortId": "BEN123",
      "externalId": "EXT123",
      "type": "INDIVIDUAL",
      "name": "John Doe",
      "currency": "USD",
      "beneficiaryAddress": {
        "addressLine1": "123 Main St",
        "addressLine2": "Apt 4B",
        "city": "Berlin",
        "countryIso2": "GB",
        "postalCode": "10115"
      },
      "accountNumber": "123456789",
      "bankCode": "BANK123",
      "iban": "GB82WEST12345698765432",
      "bic": "DEUTDEFF",
      "intermediaryBankIdentifier": "IMB123",
      "bankCountry": "Germany"
    }
  ],
  "number": 0,
  "size": 0,
  "totalElements": 0,
  "last": true,
  "totalPages": 0,
  "first": true,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "numberOfElements": 0,
  "empty": true
}

400

Bad Request

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

401

Unauthorized

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

403

Forbidden

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

404

Not Found

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

405

Method Not Allowed

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

415

Unsupported Media Type

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

429

Too Many Requests

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

500

Internal Server Error

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

Loading...