API Basics
Pay In Endpoints
- MoneyIn
- Subscription
- TokenStorage
- Invoice
- LineItem
- PaymentLink
- PaymentMethodDomain
- HostedPaymentPages
- Cloud
- Wallet: Apple Pay
Pay Out Endpoints
- MoneyOut
- Bill
Pay Ops Endpoints
- Templates
- Boarding
- Chargebacks and ACH Returns
- Entities
- Organization
- Paypoint
- Customer
- User
- Vendor
- Notification
- Query
- Statistic
- Export
- Import
Object Models
- Object Model References
Get Vendor
Retrieves a vendor’s details.
GET
/
Vendor
/
{idVendor}
curl --request GET \
--url https://api-sandbox.payabli.com/api/Vendor/{idVendor} \
--header 'requestToken: <api-key>'
{
"vendorNumber": "1234",
"name1": "Herman's Coatings",
"name2": "Herman's Coating Supply Company, LLC",
"ein": "123456789",
"phone": "212-555-1234",
"email": "example@email.com",
"address1": "123 Ocean Drive",
"address2": "Suite 400",
"city": "Bristol",
"state": "GA",
"zip": "31113",
"country": "US",
"mcc": "7777",
"locationCode": "LOC123",
"contacts": [
{
"contactName": "Herman Martinez",
"contactEmail": "example@email.com",
"contactTitle": "Owner",
"contactPhone": "3055550000"
}
],
"billingData": {
"id": 123,
"bankName": "Country Bank",
"routingAccount": "123123123",
"accountNumber": "1XXXXXX3123",
"typeAccount": "Checking",
"bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
"bankAccountHolderType": "Business",
"bankAccountFunction": 0
},
"paymentMethod": {
"method": "managed"
},
"vendorStatus": 1,
"vendorId": "1340",
"enrollmentStatus": null,
"summary": {
"pendingBills": 123,
"inTransitBills": 123,
"paidBills": 123,
"overdueBills": 123,
"totalBills": 123,
"pendingBillsAmount": 123,
"inTransitBillsAmount": 123,
"paidBillsAmount": 123,
"overdueBillsAmount": 123,
"totalBillsAmount": 123
},
"paypointLegalname": "Sunshine Services, LLC",
"paypointDbaname": "Sunshine Gutters",
"paypointEntryname": "d193cf9a46",
"parentOrgName": "PropertyManager Pro",
"createdDate": "2022-07-01 15:00:01",
"lastUpdated": "2022-07-01 15:00:01",
"remitAddress1": "123 Walnut Street",
"remitAddress2": "Suite 900",
"remitCity": "Miami",
"remitState": "FL",
"remitZip": "31113",
"remitCountry": "US",
"payeeName1": "<string>",
"payeeName2": "<string>",
"customerVendorAccount": "123-456",
"internalReferenceId": 123,
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"externalPaypointId": "Paypoint-100"
}
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
Vendor ID.
Response
200 - application/json
Success
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api-sandbox.payabli.com/api/Vendor/{idVendor} \
--header 'requestToken: <api-key>'
{
"vendorNumber": "1234",
"name1": "Herman's Coatings",
"name2": "Herman's Coating Supply Company, LLC",
"ein": "123456789",
"phone": "212-555-1234",
"email": "example@email.com",
"address1": "123 Ocean Drive",
"address2": "Suite 400",
"city": "Bristol",
"state": "GA",
"zip": "31113",
"country": "US",
"mcc": "7777",
"locationCode": "LOC123",
"contacts": [
{
"contactName": "Herman Martinez",
"contactEmail": "example@email.com",
"contactTitle": "Owner",
"contactPhone": "3055550000"
}
],
"billingData": {
"id": 123,
"bankName": "Country Bank",
"routingAccount": "123123123",
"accountNumber": "1XXXXXX3123",
"typeAccount": "Checking",
"bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
"bankAccountHolderType": "Business",
"bankAccountFunction": 0
},
"paymentMethod": {
"method": "managed"
},
"vendorStatus": 1,
"vendorId": "1340",
"enrollmentStatus": null,
"summary": {
"pendingBills": 123,
"inTransitBills": 123,
"paidBills": 123,
"overdueBills": 123,
"totalBills": 123,
"pendingBillsAmount": 123,
"inTransitBillsAmount": 123,
"paidBillsAmount": 123,
"overdueBillsAmount": 123,
"totalBillsAmount": 123
},
"paypointLegalname": "Sunshine Services, LLC",
"paypointDbaname": "Sunshine Gutters",
"paypointEntryname": "d193cf9a46",
"parentOrgName": "PropertyManager Pro",
"createdDate": "2022-07-01 15:00:01",
"lastUpdated": "2022-07-01 15:00:01",
"remitAddress1": "123 Walnut Street",
"remitAddress2": "Suite 900",
"remitCity": "Miami",
"remitState": "FL",
"remitZip": "31113",
"remitCountry": "US",
"payeeName1": "<string>",
"payeeName2": "<string>",
"customerVendorAccount": "123-456",
"internalReferenceId": 123,
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"externalPaypointId": "Paypoint-100"
}