Create beneficiaries
POSThttp://localhost:8080/api/v1/beneficiaries
Allows creation of beneficiary information
Request
Header Parameters
ApiKey stringrequired
AccountId stringrequired
- application/json
Body
required
beneficiaries object[]required
Responses
- 201
- 400
- 401
- 403
- 404
- 405
- 415
- 429
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
content object[]
number int32
size int32
totalElements int64
last boolean
totalPages int32
first boolean
sort object
numberOfElements int32
empty boolean
{
"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,
"unsorted": true,
"sorted": true
},
"numberOfElements": 0,
"empty": true
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Method Not Allowed
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Unsupported Media Type
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X POST 'http://localhost:8080/api/v1/beneficiaries' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"beneficiaries": [
{
"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"
}
]
}'
ResponseClear