Initiate Payee Creation

Velo Payments Sandbox for testing

https://api.sandbox.velopayments.com/

POST

/v4/payees

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 Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.sandbox.velopayments.com//v4/payees'

Response Example

201 - Example 1

{
    "batchId": "cb6ff8c6-85e9-45a6-b7d9-d05305db67f3",
    "rejectedCsvRows": [
        {
            "lineNumber": 3,
            "message": "rejected message 1",
            "rejectedContent": "unable,to,process,csv,line"
        },
        {
            "lineNumber": 3,
            "message": "rejected message 1",
            "rejectedContent": "unable,to,process,csv,line"
        }
    ]
}

Request

Body Params multipart/form-data

Responses

🟢201HTTP Created. Body created only on CSV requests

application/json

Body

🟠400Invalid request. See Error message payload for details of failure

🟠401Invalid access token. May be expired or invalid

🟠403The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions

🟠404The resource was not found or is no longer available

Modified at 2022-09-11 21:50:19

Resend Payee Invite

Query Batch Status