action velopayments_payee_details_update_v4 { label: "Update Payee Details" description: "

Update payee details for the given Payee Id.

\n

Payors may only update the payee details if the payee has not yet onboarded

\n" provider: velopayments method: POST path: "/v4/payees/{payeeId}/payeeDetailsUpdate" encoding: json input: { type: "object" properties: { address: { type: "object" required: ["city", "country", "line1"] properties: { city: { type: "string" } country: { type: "string" } countyOrProvince: { type: "string" } line1: { type: "string" } line2: { type: "string" } line3: { type: "string" } line4: { type: "string" } zipOrPostcode: { type: "string" } } } challenge: { type: "object" description: "

Used to override the default challenge presented to the payee when they onboard

\n

Not used after the payee has onboarded

\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" } } } contactSmsNumber: { type: "string" description: "The phone number of a device that the payee wishes to receive sms messages on\n" } email: { type: "string" format: "email" } individual: { type: "object" required: ["dateOfBirth", "name"] properties: { dateOfBirth: { type: "string" description: "If not authorized to view, value will be masked. Example: - XXXX-XX-XX" } name: { required: ["firstName", "lastName"] properties: { firstName: { type: "string" } lastName: { type: "string" } otherNames: { type: "string" } title: { type: "string" } } } nationalIdentification: { type: "string" description: "If not authorized to view, value will be masked. Example: XXXXX1234" } } } language: { type: "string" description: "An IETF BCP 47 language code which has been configured for use within this Velo environment.
\nSee the /v1/supportedLanguages endpoint to list the available codes for an environment.\n" } payeeId: { type: "string" format: "uuid" } payeeType: { type: "string" description: "The type of the payee" enum: ["Individual", "Company"] } } required: ["payeeId"] additionalProperties: false } output: { type: "object" additionalProperties: true } }