Initiate Payee Creation

v1.0.0

Initiate the process of creating 1 to 2000 payees in a batch

Use the batchId in the response to query for status.

In addition to standard semantic validations, a 400 will also result if:

there is a duplicate remote id within the batch
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.

Input

{
  "type": "object",
  "required": [
    "payees",
    "payorId"
  ],
  "properties": {
    "payees": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "address",
          "email",
          "remoteId",
          "type"
        ],
        "properties": {
          "address": {
            "type": "object",
            "required": [
              "city",
              "country",
              "line1"
            ],
            "properties": {
              "city": {
                "type": "string"
              },
              "country": {
                "type": "string",
                "description": "Valid ISO 3166 2 character country code. See the <a href=\"https://www.iso.org/iso-3166-country-codes.html\" target=\"_blank\" a>ISO specification</a> for details."
              },
              "countyOrProvince": {
                "type": "string"
              },
              "line1": {
                "type": "string"
              },
              "line2": {
                "type": "string"
              },
              "line3": {
                "type": "string"
              },
              "line4": {
                "type": "string"
              },
              "zipOrPostcode": {
                "type": "string"
              }
            }
          },
          "challenge": {
            "type": "object",
            "description": "<p>Used to override the default challenge presented to the payee when they onboard</p>\n<p>Not used after the payee has onboarded</p>\n",
            "required": [
              "description",
              "value"
            ],
            "properties": {
              "description": {
                "type": "string"
              },
              "value": {
                "type": "string",
                "description": "The value that the user will be asked to verify when they onboard"
              }
            }
          },
          "company": {
            "type": "object",
            "required": [
              "name"
            ],
            "properties": {
              "name": {
                "type": "string"
              },
              "operatingName": {
                "type": "string"
              },
              "taxId": {
                "type": "string",
                "description": "Company Tax Id must be between 6 and 30 characters long"
              }
            }
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "individual": {
            "type": "object",
            "required": [
              "dateOfBirth",
              "name"
            ],
            "properties": {
              "dateOfBirth": {
                "type": "string",
                "format": "date",
                "description": "Must not be date in future. Example - 1970-05-20"
              },
              "name": {
                "required": [
                  "firstName",
                  "lastName"
                ],
                "properties": {
                  "firstName": {
                    "type": "string"
                  },
                  "lastName": {
                    "type": "string"
                  },
                  "otherNames": {
                    "type": "string"
                  },
                  "title": {
                    "type": "string"
                  }
                }
              },
              "nationalIdentification": {
                "type": "string"
              }
            }
          },
          "language": {
            "type": "string",
            "description": "An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR>\nSee the /v1/supportedLanguages endpoint to list the available codes for an environment.\n"
          },
          "paymentChannel": {
            "type": "object",
            "required": [
              "accountName",
              "countryCode",
              "currency"
            ],
            "properties": {
              "accountName": {
                "type": "string"
              },
              "accountNumber": {
                "type": "string",
                "description": "Either routing number and account number or only iban must be set"
              },
              "countryCode": {
                "type": "string",
                "description": "Valid ISO 3166 2 character country code. See the <a href=\"https://www.iso.org/iso-3166-country-codes.html\" target=\"_blank\" a>ISO specification</a> for details."
              },
              "currency": {
                "type": "string",
                "description": "Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details."
              },
              "iban": {
                "type": "string",
                "description": "Must match the regular expression ```^[A-Za-z0-9]+$```."
              },
              "paymentChannelName": {
                "type": "string"
              },
              "routingNumber": {
                "type": "string",
                "description": "Either routing number and account number or only iban must be set"
              }
            }
          },
          "remoteId": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "description": "The type of the payee",
            "enum": [
              "Individual",
              "Company"
            ]
          }
        }
      }
    },
    "payorId": {
      "type": "string"
    }
  }
}

Output

{
  "type": "object",
  "properties": {
    "batchId": {
      "type": "string",
      "format": "uuid"
    },
    "rejectedCsvRows": {
      "type": "array",
      "items": {
        "properties": {
          "lineNumber": {
            "type": "integer"
          },
          "message": {
            "type": "string"
          },
          "rejectedContent": {
            "type": "string"
          }
        }
      }
    }
  }
}