action velopayments_get_payor_by_id_v1 { label: "Get Payor" description: "

Get a Single Payor by Id.

\n

deprecated since v2.10 - Use /v2/payors\n" provider: velopayments method: GET path: "/v1/payors/{payorId}" encoding: json input: { type: "object" properties: { payorId: { type: "string" format: "uuid" } } required: ["payorId"] additionalProperties: false } output: { type: "object" required: ["payorName"] 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" } } } allowsLanguageChoice: { type: "boolean" description: "Whether or not the payor allows language choice in the UI." } collectiveAlias: { type: "string" description: "How the payor has chosen to refer to payees." } dbaName: { type: "string" description: "The payor’s 'Doing Business As' name." } fundingAccountAccountName: { type: "string" description: "The funding account name to be used for the payor." } fundingAccountAccountNumber: { type: "string" description: "The funding account number to be used for the payor." } fundingAccountRoutingNumber: { type: "string" description: "The funding account routing number to be used for the payor." } includesReports: { type: "boolean" } kycState: { type: "string" description: "The kyc state of the payor. One of the following values: FAILED_KYC, PASSED_KYC, REQUIRES_KYC" } language: { type: "string" description: "The payor’s language preference. Must be one of [EN, FR]." } manualLockout: { type: "boolean" description: "Whether or not the payor has been manually locked by the backoffice." } maxMasterPayorAdmins: { type: "integer" } payeeGracePeriodDays: { type: "integer" description: "The grace period for paying payees in days." } payeeGracePeriodProcessingEnabled: { type: "boolean" description: "Whether grace period processing is enabled." } payorId: { type: "string" format: "uuid" } payorName: { type: "string" description: "The name of the payor." } primaryContactEmail: { type: "string" format: "email" description: "Primary contact email for the payor." } primaryContactName: { type: "string" description: "Name of primary contact for the payor." } primaryContactPhone: { type: "string" description: "Primary contact phone number for the payor." } reminderEmailsOptOut: { type: "boolean" description: "Whether or not the payor has opted-out of reminder emails being sent." } supportContact: { type: "string" description: "The payor’s support contact email address." } transmissionTypes: { type: "object" required: ["ACH", "SAME_DAY_ACH", "WIRE"] properties: { ACH: { type: "boolean" description: "Whether the Payor is allowed to pay via ACH" } SAME_DAY_ACH: { type: "boolean" description: "Whether the Payor is allowed to pay via same day ACH" } WIRE: { type: "boolean" description: "Whether the Payor is allowed to pay via wire" } } } } } }