Skip to main content

Outbound Payments

POST Edit Vendor

The POST Edit Vendor method enables merchants to make changes to the information associated with an existing vendor in the AndDone system.

Important: When you edit vendor information the vendor's status is set to Reviewing while the updated information is reviewed by the AndDone administrator. You will not be able to send outbound payments until the vendor's status is set to Approved.

Note: This API is supported in AndDone version 2.3 only.

Request Body Example

API Endpoint
https://api.uat.anddone.com/vendorapi/secure/merchants/vendors/edit
API Data Details
URI vendorapi/secure/merchants/vendors/edit
Method POST
Authorization API Key Authorization
Authorization
x-api-key API key {env_merchantAccessKey}
Request Headers
x-app-key Merchant ID or App Key {env_merchantId}
x-version API version (e.g., 2.3)
Origin URL or IP address provided to AndDone as an allowed origin.
Content-Type application/json

Request Parameters

Field Name Data Type Mandatory Description
vendorId String true Name of the vendor.
vendorName String true Name of the vendor.
vendorAliasName String true Alias name of the vendor.
vendorDbName String true Database name for the vendor.
legalEntityType String true Legal entity type - Corporation, LimitedLiabilityCompany, LimitedLiabilityPartnership, LimitedPartnership.
paymentMethodType String true Payment method type. 'Check' is the only payment method currently supported.
notificationType String true Vendor's preferred method of receiving notifications: Fax, Email.
phoneNumber String true Vendor's contact phone number.
email String true Vendor's contact email address.
url String false URL of vendor's business Website.
isMobileNumber String false Indicates if the phone number is a mobile number.
useSameAsPhysicalAddress Boolean false If set to true, the vendor's physical address will also be used as the remittance address.
remittanceAddress Object true Details of the remittance address.
- attention String true Attention line for the remittance address.
- addressLine1 String true Primary address line.
- addressLine2 String false Secondary address line.
- AddressType Integer true Address type code: 1 - Remittance, 2 - Correspondence, 3 - Physical.
- city String true City for the remittance address.
- state String true State for the remittance address.
- country String false Country for the remittance address.
- postalCode String true Postal code.
- addresssource String true Indicates the source of the remittance address: 1 - manual entry, 2 - Smarty lookup.
physicalAddress Object true Details of the physical address.
- attention String true Attention line for the physical address.
- addressLine1 String true Primary address line.
- addressLine2 String false Secondary address line.
- AddressType Integer true Address type code: 1 - Remittance, 2 - Correspondence, 3 - Physical.
- city String true City of physical address.
- state String true State of physical address.
- country String false Country of physical address.
- postalCode String true Postal code.
- addresssource String true Indicates the source of the physical address: 1 - manual entry, 2 - Smarty lookup.

Body Request Example (JSON)

{
        "vendorId": "dmeidne",
        "vendorName": "Brand-X",
        "vendorAliasName": "BXI",
        "vendorDbName": "VCS",
        "legalEntityType": "LimitedPartnership",
        "paymentMethodType": "Check",
        "notificationType": "Email",
        "phoneNumber": "9167923006",
        "email": "[email protected]",
        "faxNumber": "5555555555",
        "url": "https://example.com",
        "isMobileNumber": "true",
        "useSameAsPhysicalAddress": false,
        "remittanceAddress": {
            "attention": "John Smith",
            "addressLine1": "22 Degroat Rd",
            "addressLine2": "Suite 11",
            "AddressType": 1,
            "city": "Burleigh",
            "state": "WI",
            "country": "US",
            "postalCode": "07827",
            "addresssource": "2"
        },
        "physicalAddress": {
            "attention": "Mark Smith",
            "addressLine1": "142 Park Rd",
            "addressLine2": "Suite 28",
            "city": "Pittsford",
            "state": "NY",
            "AddressType": 3,
            "country": "US",
            "postalCode": "14534",
            "addresssource": "2"
        }
    },

Response Parameters

Body Response Example (JSON)

 {
      "id": "Ky8y1985",
      "paymentBasedId": null,
      "legalEntityType": "LimitedPartnership",
      "merchantId": "1qx7epdP",
      "vendorName": "Brand-X",
      "vendorAliasName": "BXI",
      "vendorDbName": "VCS",
      "paymentMethodType": "Check",
      "notificationType": "Email",
      "VendorNotes": "This is a note about the vendor.", 
      "phoneNumber": "9167923006",
      "isMobileNumber": true,
      "email": "[email protected]",
      "url": "https://example.com",
      "vendorStatus": "Reviewing",
      "useSameAsPhysicalAddress": false,
      "physicalAddress": {
        "attention": "Mark Smith",
        "addressLine1": "142 Park Rd",
        "addressLine2": "Suite 28",
        "city": "Pittsford",
        "state": "NY",
        "AddressType": "Physical",
        "country": "US",
        "postalCode": "14534",
        "addressType": "Physical",
        "addressSource": "Smarty_lookup"
    },
      "remittanceAddress": {
        "attention": "John Smith",
        "addressLine1": "22 Degroat Rd",
        "addressLine2": "Suite 11",
        "AddressType": "Remittance",
        "city": "Burleigh",
        "state": "WI",
        "country": "US",
        "postalCode": "07827",
        "addressType": "Remittance",
        "addressSource": "Smarty_lookup"
    },
      "createdBy": "joeuser",
      "modifiedBy": "joeuser",
      "createdOn": "08-27-2024 06:06:56",
      "modifiedOn": "08-27-2024 06:06:56"
    }