v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Payees

Update Payee Details

Use v4 instead

Update payee details for the given Payee Id.

post/v3/payees/{payeeId}/payeeDetailsUpdate

Path parameters

payeeIdstring uuid required

Example:2aa5d7e0-2ecb-403f-8494-1865ed0454e9

The UUID of the payee.

Request body

languagestring

An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR> See the /v1/supportedLanguages endpoint to list the available codes for an environment.

payeeType'Individual' | 'Company'

The type of the payee

emailstring email nullable

contactSmsNumberstring

The phone number of a device that the payee wishes to receive sms messages on

Example request

{
  "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": "A",
      "title": "Mr"
    },
    "nationalIdentification": "AB123456C",
    "dateOfBirth": "1985-01-01"
  },
  "challenge": {
    "description": "challenge description",
    "value": "challenge test"
  },
  "company": {
    "taxId": "123123123",
    "name": "ABC Group Plc",
    "operatingName": "ABC Co"
  },
  "language": "en-US",
  "contactSmsNumber": "11235555555",
  "email": "bob@example.com"
}

Response

Request accepted