Initiate Payee Creation
Changed onUse v4 instead
Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
Request
- Base URLhttps://api.sandbox.velopayments.com
- AuthOAuth 2Client credentialsToken URL: https://api.sandbox.velopayments.com/v1/login
Request body
Example request
{
"payees": [
{
"payorRefs": [
{
"payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
"invitationStatusTimestamp": "2019-01-20T09:00:00Z",
"payableStatus": true,
"invitationStatus": "invitationStatus",
"payableIssues": [
{
"code": "3",
"message": "payee-disabled"
},
{
"code": "3",
"message": "payee-disabled"
}
],
"remoteId": "uniqueIdForRemoteEntity",
"paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
},
{
"payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
"invitationStatusTimestamp": "2019-01-20T09:00:00Z",
"payableStatus": true,
"invitationStatus": "invitationStatus",
"payableIssues": [
{
"code": "3",
"message": "payee-disabled"
},
{
"code": "3",
"message": "payee-disabled"
}
],
"remoteId": "uniqueIdForRemoteEntity",
"paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
}
],
"address": {
"country": "US",
"countyOrProvince": "FL",
"line4": "line4",
"city": "Key West",
"line3": "line3",
"line2": "line2",
"line1": "500 Duval St",
"zipOrPostcode": "33945"
},
"individual": {
"name": {
"firstName": "Bob",
"lastName": "Smith",
"otherNames": "H",
"title": "Mr"
},
"nationalIdentification": "SA211123K",
"dateOfBirth": "1970-05-20T00:00:00.000+0000"
},
"challenge": {
"description": "challenge description",
"value": "challenge test"
},
"language": "en-US",
"company": {
"taxId": "123123123",
"name": "ABC Group Plc",
"operatingName": "ABC Co"
},
"payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
"type": "type",
"email": "bob@example.com",
"remoteId": "Remote ID",
"paymentChannel": {
"paymentChannelName": "My Payment Channel",
"routingNumber": "XXXXX6789",
"accountName": "My account",
"countryCode": "US",
"iban": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234",
"currency": "USD",
"accountNumber": "XXXXXX5678"
}
},
{
"payorRefs": [
{
"payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
"invitationStatusTimestamp": "2019-01-20T09:00:00Z",
"payableStatus": true,
"invitationStatus": "invitationStatus",
"payableIssues": [
{
"code": "3",
"message": "payee-disabled"
},
{
"code": "3",
"message": "payee-disabled"
}
],
"remoteId": "uniqueIdForRemoteEntity",
"paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
},
{
"payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
"invitationStatusTimestamp": "2019-01-20T09:00:00Z",
"payableStatus": true,
"invitationStatus": "invitationStatus",
"payableIssues": [
{
"code": "3",
"message": "payee-disabled"
},
{
"code": "3",
"message": "payee-disabled"
}
],
"remoteId": "uniqueIdForRemoteEntity",
"paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
}
],
"address": {
"country": "US",
"countyOrProvince": "FL",
"line4": "line4",
"city": "Key West",
"line3": "line3",
"line2": "line2",
"line1": "500 Duval St",
"zipOrPostcode": "33945"
},
"individual": {
"name": {
"firstName": "Bob",
"lastName": "Smith",
"otherNames": "H",
"title": "Mr"
},
"nationalIdentification": "SA211123K",
"dateOfBirth": "1970-05-20T00:00:00.000+0000"
},
"challenge": {
"description": "challenge description",
"value": "challenge test"
},
"language": "en-US",
"company": {
"taxId": "123123123",
"name": "ABC Group Plc",
"operatingName": "ABC Co"
},
"payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
"type": "type",
"email": "bob@example.com",
"remoteId": "Remote ID",
"paymentChannel": {
"paymentChannelName": "My Payment Channel",
"routingNumber": "XXXXX6789",
"accountName": "My account",
"countryCode": "US",
"iban": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234",
"currency": "USD",
"accountNumber": "XXXXXX5678"
}
}
],
"payorId": "9ac75325-5dcd-42d5-b992-175d7e0a035e"
}Response
HTTP Created. Body created only on CSV requests
Example response
{
"batchId": "cb6ff8c6-85e9-45a6-b7d9-d05305db67f3",
"rejectedCsvRows": [
{
"rejectedContent": "unable,to,process,csv,line",
"lineNumber": 3,
"message": "rejected message 1"
},
{
"rejectedContent": "unable,to,process,csv,line",
"lineNumber": 3,
"message": "rejected message 1"
}
]
}Changes
- breaking
the
//request property's maxLength was decreased to20(media type: multipart/form-data) - breaking
the
///request property's maxLength was decreased to20(media type: application/json) - breaking
the
//request property's minLength was increased from1to2(media type: multipart/form-data) - info
the request property
//became optional (media type: multipart/form-data) - info
the
//request property's minLength was decreased from6to4(media type: multipart/form-data) - info
the
///request property's minLength was decreased from6to4(media type: application/json) - info
the
///request property's minLength was decreased from6to4(media type: application/json)
- breaking
- breaking
removed the enum value
ACCEPTEDof the request property////(media type: application/json) - breaking
removed the enum value
ADof the request property///(media type: application/json) - breaking
removed the enum value
AEof the request property///(media type: application/json) - breaking
removed the enum value
AFof the request property///(media type: application/json) - breaking
removed the enum value
AGof the request property///(media type: application/json) - breaking
removed the enum value
AIof the request property///(media type: application/json) - breaking
removed the enum value
ALof the request property///(media type: application/json) - breaking
removed the enum value
AMof the request property///(media type: application/json) - breaking
removed the enum value
AOof the request property///(media type: application/json) - breaking
removed the enum value
AQof the request property///(media type: application/json) - breaking
removed the enum value
ARof the request property///(media type: application/json) - breaking
removed the enum value
ASof the request property///(media type: application/json) - breaking
removed the enum value
ATof the request property///(media type: application/json) - breaking
removed the enum value
AUof the request property///(media type: application/json) - breaking
removed the enum value
AWof the request property///(media type: application/json) - breaking
removed the enum value
AXof the request property///(media type: application/json) - breaking
removed the enum value
AZof the request property///(media type: application/json) - breaking
removed the enum value
BAof the request property///(media type: application/json) - breaking
removed the enum value
BBof the request property///(media type: application/json) - breaking
removed the enum value
BDof the request property///(media type: application/json) - breaking
removed the enum value
BEof the request property///(media type: application/json) - breaking
removed the enum value
BFof the request property///(media type: application/json) - breaking
removed the enum value
BGof the request property///(media type: application/json) - breaking
removed the enum value
BHof the request property///(media type: application/json) - breaking
removed the enum value
BIof the request property///(media type: application/json) - breaking
removed the enum value
BJof the request property///(media type: application/json) - breaking
removed the enum value
BLof the request property///(media type: application/json) - breaking
removed the enum value
BMof the request property///(media type: application/json) - breaking
removed the enum value
BNof the request property///(media type: application/json) - breaking
removed the enum value
BOof the request property///(media type: application/json) - breaking
removed the enum value
BQof the request property///(media type: application/json) - breaking
removed the enum value
BRof the request property///(media type: application/json) - breaking
removed the enum value
BSof the request property///(media type: application/json) - breaking
removed the enum value
BTof the request property///(media type: application/json) - breaking
removed the enum value
BVof the request property///(media type: application/json) - breaking
removed the enum value
BWof the request property///(media type: application/json) - breaking
removed the enum value
BYof the request property///(media type: application/json) - breaking
removed the enum value
BZof the request property///(media type: application/json) - breaking
removed the enum value
CAof the request property///(media type: application/json) - breaking
removed the enum value
CCof the request property///(media type: application/json) - breaking
removed the enum value
CDof the request property///(media type: application/json) - breaking
removed the enum value
CFof the request property///(media type: application/json) - breaking
removed the enum value
CGof the request property///(media type: application/json) - breaking
removed the enum value
CHof the request property///(media type: application/json) - breaking
removed the enum value
CIof the request property///(media type: application/json) - breaking
removed the enum value
CKof the request property///(media type: application/json) - breaking
removed the enum value
CLof the request property///(media type: application/json) - breaking
removed the enum value
CMof the request property///(media type: application/json) - breaking
removed the enum value
CNof the request property///(media type: application/json) - breaking
removed the enum value
COof the request property///(media type: application/json) - breaking
removed the enum value
CRof the request property///(media type: application/json) - breaking
removed the enum value
CUof the request property///(media type: application/json) - breaking
removed the enum value
CVof the request property///(media type: application/json) - breaking
removed the enum value
CWof the request property///(media type: application/json) - breaking
removed the enum value
CXof the request property///(media type: application/json) - breaking
removed the enum value
CYof the request property///(media type: application/json) - breaking
removed the enum value
CZof the request property///(media type: application/json) - breaking
removed the enum value
Companyof the request property//(media type: application/json) - breaking
removed the enum value
DEof the request property///(media type: application/json) - breaking
removed the enum value
DECLINEDof the request property////(media type: application/json) - breaking
removed the enum value
DJof the request property///(media type: application/json) - breaking
removed the enum value
DKof the request property///(media type: application/json) - breaking
removed the enum value
DMof the request property///(media type: application/json) - breaking
removed the enum value
DOof the request property///(media type: application/json) - breaking
removed the enum value
DZof the request property///(media type: application/json) - breaking
removed the enum value
ECof the request property///(media type: application/json) - breaking
removed the enum value
EEof the request property///(media type: application/json) - breaking
removed the enum value
EGof the request property///(media type: application/json) - breaking
removed the enum value
EHof the request property///(media type: application/json) - breaking
removed the enum value
ERof the request property///(media type: application/json) - breaking
removed the enum value
ESof the request property///(media type: application/json) - breaking
removed the enum value
ETof the request property///(media type: application/json) - breaking
removed the enum value
EURof the request property//(media type: multipart/form-data) - breaking
removed the enum value
FIof the request property///(media type: application/json) - breaking
removed the enum value
FJof the request property///(media type: application/json) - breaking
removed the enum value
FKof the request property///(media type: application/json) - breaking
removed the enum value
FMof the request property///(media type: application/json) - breaking
removed the enum value
FOof the request property///(media type: application/json) - breaking
removed the enum value
FRof the request property///(media type: application/json) - breaking
removed the enum value
GAof the request property///(media type: application/json) - breaking
removed the enum value
GBof the request property///(media type: application/json) - breaking
removed the enum value
GBPof the request property//(media type: multipart/form-data) - breaking
removed the enum value
GDof the request property///(media type: application/json) - breaking
removed the enum value
GEof the request property///(media type: application/json) - breaking
removed the enum value
GFof the request property///(media type: application/json) - breaking
removed the enum value
GGof the request property///(media type: application/json) - breaking
removed the enum value
GHof the request property///(media type: application/json) - breaking
removed the enum value
GIof the request property///(media type: application/json) - breaking
removed the enum value
GLof the request property///(media type: application/json) - breaking
removed the enum value
GMof the request property///(media type: application/json) - breaking
removed the enum value
GNof the request property///(media type: application/json) - breaking
removed the enum value
GPof the request property///(media type: application/json) - breaking
removed the enum value
GQof the request property///(media type: application/json) - breaking
removed the enum value
GRof the request property///(media type: application/json) - breaking
removed the enum value
GSof the request property///(media type: application/json) - breaking
removed the enum value
GTof the request property///(media type: application/json) - breaking
removed the enum value
GUof the request property///(media type: application/json) - breaking
removed the enum value
GWof the request property///(media type: application/json) - breaking
removed the enum value
GYof the request property///(media type: application/json) - breaking
removed the enum value
HKof the request property///(media type: application/json) - breaking
removed the enum value
HMof the request property///(media type: application/json) - breaking
removed the enum value
HNof the request property///(media type: application/json) - breaking
removed the enum value
HRof the request property///(media type: application/json) - breaking
removed the enum value
HTof the request property///(media type: application/json) - breaking
removed the enum value
HUof the request property///(media type: application/json) - breaking
removed the enum value
IDof the request property///(media type: application/json) - breaking
removed the enum value
IEof the request property///(media type: application/json) - breaking
removed the enum value
ILof the request property///(media type: application/json) - breaking
removed the enum value
IMof the request property///(media type: application/json) - breaking
removed the enum value
INof the request property///(media type: application/json) - breaking
removed the enum value
IOof the request property///(media type: application/json) - breaking
removed the enum value
IQof the request property///(media type: application/json) - breaking
removed the enum value
IRof the request property///(media type: application/json) - breaking
removed the enum value
ISof the request property///(media type: application/json) - breaking
removed the enum value
ITof the request property///(media type: application/json) - breaking
removed the enum value
Individualof the request property//(media type: application/json) - breaking
removed the enum value
JEof the request property///(media type: application/json) - breaking
removed the enum value
JMof the request property///(media type: application/json) - breaking
removed the enum value
JOof the request property///(media type: application/json) - breaking
removed the enum value
JPof the request property///(media type: application/json) - breaking
removed the enum value
KEof the request property///(media type: application/json) - breaking
removed the enum value
KGof the request property///(media type: application/json) - breaking
removed the enum value
KHof the request property///(media type: application/json) - breaking
removed the enum value
KIof the request property///(media type: application/json) - breaking
removed the enum value
KMof the request property///(media type: application/json) - breaking
removed the enum value
KNof the request property///(media type: application/json) - breaking
removed the enum value
KPof the request property///(media type: application/json) - breaking
removed the enum value
KRof the request property///(media type: application/json) - breaking
removed the enum value
KWof the request property///(media type: application/json) - breaking
removed the enum value
KYof the request property///(media type: application/json) - breaking
removed the enum value
KZof the request property///(media type: application/json) - breaking
removed the enum value
LAof the request property///(media type: application/json) - breaking
removed the enum value
LBof the request property///(media type: application/json) - breaking
removed the enum value
LCof the request property///(media type: application/json) - breaking
removed the enum value
LIof the request property///(media type: application/json) - breaking
removed the enum value
LKof the request property///(media type: application/json) - breaking
removed the enum value
LRof the request property///(media type: application/json) - breaking
removed the enum value
LSof the request property///(media type: application/json) - breaking
removed the enum value
LTof the request property///(media type: application/json) - breaking
removed the enum value
LUof the request property///(media type: application/json) - breaking
removed the enum value
LVof the request property///(media type: application/json) - breaking
removed the enum value
LYof the request property///(media type: application/json) - breaking
removed the enum value
MAof the request property///(media type: application/json) - breaking
removed the enum value
MCof the request property///(media type: application/json) - breaking
removed the enum value
MDof the request property///(media type: application/json) - breaking
removed the enum value
MEof the request property///(media type: application/json) - breaking
removed the enum value
MFof the request property///(media type: application/json) - breaking
removed the enum value
MGof the request property///(media type: application/json) - breaking
removed the enum value
MHof the request property///(media type: application/json) - breaking
removed the enum value
MKof the request property///(media type: application/json) - breaking
removed the enum value
MLof the request property///(media type: application/json) - breaking
removed the enum value
MMof the request property///(media type: application/json) - breaking
removed the enum value
MNof the request property///(media type: application/json) - breaking
removed the enum value
MOof the request property///(media type: application/json) - breaking
removed the enum value
MPof the request property///(media type: application/json) - breaking
removed the enum value
MQof the request property///(media type: application/json) - breaking
removed the enum value
MRof the request property///(media type: application/json) - breaking
removed the enum value
MSof the request property///(media type: application/json) - breaking
removed the enum value
MTof the request property///(media type: application/json) - breaking
removed the enum value
MUof the request property///(media type: application/json) - breaking
removed the enum value
MVof the request property///(media type: application/json) - breaking
removed the enum value
MWof the request property///(media type: application/json) - breaking
removed the enum value
MXof the request property///(media type: application/json) - breaking
removed the enum value
MYof the request property///(media type: application/json) - breaking
removed the enum value
MZof the request property///(media type: application/json) - breaking
removed the enum value
NAof the request property///(media type: application/json) - breaking
removed the enum value
NCof the request property///(media type: application/json) - breaking
removed the enum value
NEof the request property///(media type: application/json) - breaking
removed the enum value
NFof the request property///(media type: application/json) - breaking
removed the enum value
NGof the request property///(media type: application/json) - breaking
removed the enum value
NIof the request property///(media type: application/json) - breaking
removed the enum value
NLof the request property///(media type: application/json) - breaking
removed the enum value
NOof the request property///(media type: application/json) - breaking
removed the enum value
NPof the request property///(media type: application/json) - breaking
removed the enum value
NRof the request property///(media type: application/json) - breaking
removed the enum value
NUof the request property///(media type: application/json) - breaking
removed the enum value
NZof the request property///(media type: application/json) - breaking
removed the enum value
OMof the request property///(media type: application/json) - breaking
removed the enum value
PAof the request property///(media type: application/json) - breaking
removed the enum value
PEof the request property///(media type: application/json) - breaking
removed the enum value
PENDINGof the request property////(media type: application/json) - breaking
removed the enum value
PFof the request property///(media type: application/json) - breaking
removed the enum value
PGof the request property///(media type: application/json) - breaking
removed the enum value
PHof the request property///(media type: application/json) - breaking
removed the enum value
PKof the request property///(media type: application/json) - breaking
removed the enum value
PLof the request property///(media type: application/json) - breaking
removed the enum value
PMof the request property///(media type: application/json) - breaking
removed the enum value
PNof the request property///(media type: application/json) - breaking
removed the enum value
PRof the request property///(media type: application/json) - breaking
removed the enum value
PSof the request property///(media type: application/json) - breaking
removed the enum value
PTof the request property///(media type: application/json) - breaking
removed the enum value
PWof the request property///(media type: application/json) - breaking
removed the enum value
PYof the request property///(media type: application/json) - breaking
removed the enum value
QAof the request property///(media type: application/json) - breaking
removed the enum value
REof the request property///(media type: application/json) - breaking
removed the enum value
ROof the request property///(media type: application/json) - breaking
removed the enum value
RSof the request property///(media type: application/json) - breaking
removed the enum value
RUof the request property///(media type: application/json) - breaking
removed the enum value
RWof the request property///(media type: application/json) - breaking
removed the enum value
SAof the request property///(media type: application/json) - breaking
removed the enum value
SBof the request property///(media type: application/json) - breaking
removed the enum value
SCof the request property///(media type: application/json) - breaking
removed the enum value
SDof the request property///(media type: application/json) - breaking
removed the enum value
SEof the request property///(media type: application/json) - breaking
removed the enum value
SGof the request property///(media type: application/json) - breaking
removed the enum value
SHof the request property///(media type: application/json) - breaking
removed the enum value
SIof the request property///(media type: application/json) - breaking
removed the enum value
SJof the request property///(media type: application/json) - breaking
removed the enum value
SKof the request property///(media type: application/json) - breaking
removed the enum value
SLof the request property///(media type: application/json) - breaking
removed the enum value
SMof the request property///(media type: application/json) - breaking
removed the enum value
SNof the request property///(media type: application/json) - breaking
removed the enum value
SOof the request property///(media type: application/json) - breaking
removed the enum value
SRof the request property///(media type: application/json) - breaking
removed the enum value
SSof the request property///(media type: application/json) - breaking
removed the enum value
STof the request property///(media type: application/json) - breaking
removed the enum value
SVof the request property///(media type: application/json) - breaking
removed the enum value
SXof the request property///(media type: application/json) - breaking
removed the enum value
SYof the request property///(media type: application/json) - breaking
removed the enum value
SZof the request property///(media type: application/json) - breaking
removed the enum value
TCof the request property///(media type: application/json) - breaking
removed the enum value
TDof the request property///(media type: application/json) - breaking
removed the enum value
TFof the request property///(media type: application/json) - breaking
removed the enum value
TGof the request property///(media type: application/json) - breaking
removed the enum value
THof the request property///(media type: application/json) - breaking
removed the enum value
TJof the request property///(media type: application/json) - breaking
removed the enum value
TKof the request property///(media type: application/json) - breaking
removed the enum value
TLof the request property///(media type: application/json) - breaking
removed the enum value
TMof the request property///(media type: application/json) - breaking
removed the enum value
TNof the request property///(media type: application/json) - breaking
removed the enum value
TOof the request property///(media type: application/json) - breaking
removed the enum value
TRof the request property///(media type: application/json) - breaking
removed the enum value
TTof the request property///(media type: application/json) - breaking
removed the enum value
TVof the request property///(media type: application/json) - breaking
removed the enum value
TWof the request property///(media type: application/json) - breaking
removed the enum value
TZof the request property///(media type: application/json) - breaking
removed the enum value
UAof the request property///(media type: application/json) - breaking
removed the enum value
UGof the request property///(media type: application/json) - breaking
removed the enum value
UMof the request property///(media type: application/json) - breaking
removed the enum value
USof the request property///(media type: application/json) - breaking
removed the enum value
USDof the request property//(media type: multipart/form-data) - breaking
removed the enum value
UYof the request property///(media type: application/json) - breaking
removed the enum value
UZof the request property///(media type: application/json) - breaking
removed the enum value
VAof the request property///(media type: application/json) - breaking
removed the enum value
VCof the request property///(media type: application/json) - breaking
removed the enum value
VEof the request property///(media type: application/json) - breaking
removed the enum value
VGof the request property///(media type: application/json) - breaking
removed the enum value
VIof the request property///(media type: application/json) - breaking
removed the enum value
VNof the request property///(media type: application/json) - breaking
removed the enum value
VUof the request property///(media type: application/json) - breaking
removed the enum value
WFof the request property///(media type: application/json) - breaking
removed the enum value
WSof the request property///(media type: application/json) - breaking
removed the enum value
YEof the request property///(media type: application/json) - breaking
removed the enum value
YTof the request property///(media type: application/json) - breaking
removed the enum value
ZAof the request property///(media type: application/json) - breaking
removed the enum value
ZMof the request property///(media type: application/json) - breaking
removed the enum value
ZWof the request property///(media type: application/json) - breaking
the
//request property's minLength was increased from0to3(media type: multipart/form-data) - warning
the
//request property's maxLength was set to3(media type: multipart/form-data)
- breaking