Skip to main content
POST
/
api
/
v1
/
customers
/
{customerId}
/
beneficiaries
Create a beneficiary
curl --request POST \
  --url http://localhost:45000/api/v1/customers/{customerId}/beneficiaries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "customerId": "<string>",
  "country": "<string>",
  "companyName": "<string>",
  "address": "<string>",
  "zipCode": "<string>",
  "currencyCode": "<string>",
  "bankBic": "<string>",
  "iban": "<string>",
  "accountNumber": "<string>",
  "wireRoutingNumber": "<string>",
  "achRoutingNumber": "<string>",
  "intermediaryBank": "<string>"
}
'
{
  "id": "<string>",
  "customerId": "<string>",
  "country": "<string>",
  "companyName": "<string>",
  "address": "<string>",
  "zipCode": "<string>",
  "currencyCode": "<string>",
  "bankName": "<string>",
  "bankBic": "<string>",
  "bankCountryCode": "<string>",
  "bankAddress": "<string>",
  "accountNumber": "<string>",
  "iban": "<string>",
  "wireRoutingNumber": "<string>",
  "achRoutingNumber": "<string>",
  "intermediaryBank": "<string>",
  "status": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "screening": {
    "screeningSubjectId": "<string>",
    "paymentHold": true,
    "openMatchCount": 0,
    "lastScreenedAt": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Nuvera API application secret key

Authorization
string
header
required

RS256 per-request signed JWT

Path Parameters

customerId
string
required

Body

application/json
customerId
string
required

ID of the customer this beneficiary belongs to

country
string
required

Beneficiary country

Minimum string length: 1
companyName
string
required

Beneficiary company name

Required string length: 1 - 200
address
string
required

Company address

Minimum string length: 1
zipCode
string
required

ZIP/Postal code

Minimum string length: 1
currencyCode
string
required

Currency code

Allowed value: "USD"
bankBic
string
required

Bank SWIFT/BIC code

iban
string

IBAN (if applicable)

accountNumber
string

Bank account number

wireRoutingNumber
string

Wire routing number (if applicable)

achRoutingNumber
string

ACH routing number (if applicable)

intermediaryBank
string

Intermediary bank (if applicable)

Response

default - application/json
id
string
required
customerId
string
required
country
string
required
companyName
string
required
address
string
required
zipCode
string
required
currencyCode
string
required
bankName
string
required
bankBic
string
required
bankCountryCode
string
required
bankAddress
string
required
accountNumber
string | null
required
iban
string | null
required
wireRoutingNumber
string | null
required
achRoutingNumber
string | null
required
intermediaryBank
string | null
required
status
string
required
createdAt
string
required
updatedAt
string
required
screening
object