createBeneficialOwnerRequest
ApiScope: payment.ach.create.customer
API Scope Level: DepartmentScope
Path Parameters
departmentUuid string required
application/json
Request Body required
firstName string
lastName string
dateOfBirth string
ssn string
address1 string
city string
state string
country string
postalCode string
customerReference string
Responses
- 200
- 400
- 401
- 500
OK
application/json
Schema
Example (from schema)
Schema
beneficialOwnerReference string
errors object[]
warnings object[]
{
"beneficialOwnerReference": "string",
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
]
}
Bad Request
*/*
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
]
}
Unauthorized
*/*
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
]
}
Internal Server Error
*/*
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string",
"errorDescription": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string",
"warningDescription": "string"
}
]
}
POST /kpayment/v1/:departmentUuid/beneficialOwner/create
Request
Request
curl / cURL
curl -L -X POST '/payment/kpayment/v1/:departmentUuid/beneficialOwner/create' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"ssn": "string",
"address1": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"customerReference": "string"
}'
python / requests
curl -L -X POST '/payment/kpayment/v1/:departmentUuid/beneficialOwner/create' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"ssn": "string",
"address1": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"customerReference": "string"
}'
go / native
curl -L -X POST '/payment/kpayment/v1/:departmentUuid/beneficialOwner/create' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"ssn": "string",
"address1": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"customerReference": "string"
}'
nodejs / axios
curl -L -X POST '/payment/kpayment/v1/:departmentUuid/beneficialOwner/create' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"ssn": "string",
"address1": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"customerReference": "string"
}'
ruby / Net::HTTP
curl -L -X POST '/payment/kpayment/v1/:departmentUuid/beneficialOwner/create' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"ssn": "string",
"address1": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"customerReference": "string"
}'
csharp / RestSharp
curl -L -X POST '/payment/kpayment/v1/:departmentUuid/beneficialOwner/create' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"ssn": "string",
"address1": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"customerReference": "string"
}'
php / cURL
curl -L -X POST '/payment/kpayment/v1/:departmentUuid/beneficialOwner/create' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"ssn": "string",
"address1": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"customerReference": "string"
}'
java / OkHttp
curl -L -X POST '/payment/kpayment/v1/:departmentUuid/beneficialOwner/create' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"ssn": "string",
"address1": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"customerReference": "string"
}'
powershell / RestMethod
curl -L -X POST '/payment/kpayment/v1/:departmentUuid/beneficialOwner/create' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"ssn": "string",
"address1": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"customerReference": "string"
}'