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
- Notification
- Query
- GETList Transactions for Paypoint
- GETList Transactions for Org
- GETList Batches for Paypoint
- GETList Batches for Org
- GETList Batch Details for Paypoint
- GETList Batch Details for Org
- GETList MoneyOut Batches for Paypoint
- GETList MoneyOut Batches for Org
- GETList Subscriptions for Paypoint
- GETList Subscriptions for Org
- GETList Settled Transactions for Paypoint
- GETList Settled Transactions for Org
- GETGet Transfer Details
- GETList Transfers for Paypoint
- GETList Chargebacks for Paypoint
- GETList Chargebacks for Org
- GETList Customers for Paypoint
- GETList Customers for Org
- GETList Users for Paypoint
- GETList Users for Org
- GETList Suborganizations
- GETList Paypoints for Org
- GETList Notifications for Paypoint
- GETList Notifications for Org
- GETList Reports for Paypoint
- GETList Reports for Org
- GETList Vendors for Paypoint
- GETList Vendors for Org
- GETList vCards for Paypoint
- GETList vCards for Org
- GETList MoneyOut Transactions for Paypoint
- GETList MoneyOut Transactions for Org
- GETList Items for Paypoint
- GETList Invoices for Paypoint
- GETList Invoices for Org
- GETList Bills for Paypoint
- GETList Bills for Org
- GET
- Statistic
- Export
- Import
Object Models
- Object Model References
Get List of vCards for Paypoint
Retrieve a list of vcards (virtual credit cards) issued for an entrypoint. Use filters to limit results.
curl --request GET \
--url https://api-sandbox.payabli.com/api/Query/vcards/{entry} \
--header 'requestToken: <api-key>'
{
"Summary": {
"totalPages": 1,
"totalRecords": 1,
"totalAmount": 100,
"totalactive": 1,
"totalamountactive": 100,
"totalbalanceactive": 100
},
"Records": [
{
"vcardSent": false,
"cardToken": "20240306214229780012",
"cardNumber": null,
"cvc": null,
"expirationDate": "11/27",
"status": "Active",
"amount": 100,
"currentBalance": 100,
"expenseLimit": 0,
"expenseLimitPeriod": "",
"maxNumberOfUses": 1,
"currentNumberOfUses": 0,
"exactAmount": true,
"mcc": null,
"tcc": "",
"misc1": null,
"misc2": null,
"dateCreated": "2024-03-06T22:42:17.85",
"dateModified": "2024-03-06T19:00:00",
"associatedVendor": {
"VendorNumber": "QA-vendor-1234567890",
"Name1": "Pappas Industries",
"Name2": "Alexandros",
"EIN": "XXXX6789",
"Phone": "212-555-1234",
"Email": "alex.pappas@example.com",
"Address1": "789 5th Ave",
"Address2": "Suite 10B",
"City": "New York",
"State": "NY",
"Zip": "10022",
"Country": "USA",
"Mcc": "hi",
"LocationCode": "177.0954",
"Contacts": [
{
"ContactName": "Sophia Pappas",
"ContactEmail": "sophia.pappas@example.com",
"ContactTitle": "Operations Manager",
"ContactPhone": "212-555-5678"
}
],
"BillingData": {
"id": 0,
"bankName": "Olympus Bank",
"routingAccount": "021000021",
"accountNumber": "12345XXXX",
"typeAccount": "Checking",
"bankAccountHolderName": "",
"bankAccountHolderType": "Business",
"bankAccountFunction": 0
},
"PaymentMethod": "card",
"VendorStatus": 1,
"VendorId": 339,
"EnrollmentStatus": null,
"Summary": {
"ActiveBills": null,
"PendingBills": 1,
"InTransitBills": 0,
"PaidBills": 0,
"OverdueBills": 1,
"ApprovedBills": null,
"DisapprovedBills": null,
"TotalBills": 1,
"ActiveBillsAmount": null,
"PendingBillsAmount": 100,
"InTransitBillsAmount": 0,
"PaidBillsAmount": 0,
"OverdueBillsAmount": 100,
"ApprovedBillsAmount": null,
"DisapprovedBillsAmount": null,
"TotalBillsAmount": 100
},
"PaypointLegalname": "Pappas Industries LLC",
"PaypointDbaname": "Pappas Industries LLC",
"PaypointEntryname": "478saec23",
"ParentOrgName": "",
"CreatedDate": "2022-01-01T00:00:00",
"LastUpdated": "2022-01-01T00:00:00",
"remitAddress1": null,
"remitAddress2": null,
"remitCity": null,
"remitState": null,
"remitZip": null,
"remitCountry": null,
"payeeName1": null,
"payeeName2": null,
"customField1": null,
"customField2": null,
"customerVendorAccount": null,
"InternalReferenceId": 27,
"additionalData": null,
"externalPaypointID": null
},
"associatedCustomer": null,
"ParentOrgName": "Pappas Holdings",
"PaypointDbaname": "Pappas Industries LLC",
"PaypointLegalname": "Pappas Industries LLC",
"PaypointEntryname": "478saec23",
"externalPaypointID": "pappas01-001"
}
]
}
You must remove parameters=
from the request before you send it, otherwise Payabli will ignore the filters.
Because of a technical limitation, you can’t make a request that includes filters from the API console on this page. The response won’t be filtered. Instead, copy the request, remove parameters=
and run the request in a different client.
For example:
should become:
—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
The paypoint's entrypoint identifier. Learn more
"8cfec329267"
Query Parameters
Collection of field names, conditions, and values used to filter the query
List of field names accepted:
- status (in, nin, eq, ne)
- createdAt (gt, ge, lt, le, eq, ne)
- cardToken (ct, nct,eq, ne)
- lastFour (ct, nct,eq, ne)
- expirationDate (ct, nct, eq, ne)
- mcc (ct, nct, eq, ne)
- payoutId (ct, nct, eq, ne, in, nin)
- customerId (ct, nct, eq, ne, in, nin)
- vendorId (ct, nct, eq, ne, in, nin)
- miscData1 (ct, nct, eq, ne)
- miscData2 (ct, nct, eq, ne)
- currentUses (gt, ge, lt, le, eq, ne)
- amount (gt, ge, lt, le, eq, ne)
- balance (gt, ge, lt, le, eq, ne)
- paypointLegal (ne, eq, ct, nct)
- paypointDba (ne, eq, ct, nct)
- orgName (ne, eq, ct, nct)
- externalPaypointId (ct, nct, eq, ne)
- paypointId (in, nin, eq, ne)
List of comparison accepted - enclosed between parentheses:
- eq or empty => equal
- gt => greater than
- ge => greater or equal
- lt => less than
- le => less or equal
- ne => not equal
- ct => contains
- nct => not contains
- in => inside array
- nin => not inside array
Max number of records to return for the query. Use 0
or negative value to return all records.
0
The number of records to skip before starting to collect the result set.
251
The field name to use for sorting results. Use desc(field_name)
to sort descending by field_name
, and use asc(field_name)
to sort ascending by field_name
.
"desc(field_name)"
Response
Total number of records in response.
2
Total number of records in response.
2
Total amount for the records.
7127.22
Total number of active vCards.
50
Total amount of active vCards.
7127.22
Total balance of active vCards.
7127.22
When true
, the vCard has been sent.
true
ID for a vCard.
"20230403315245421165"
The vCard number.
20
"4111111111111111"
The vCard CVC number.
4
"123"
Expiration date in format YYYY-MM-DD. The minimum time to expire is 3 months, maximum is 3 years. If not provided, the default is 6 months.
5
"02/25"
Amount loaded on the vCard.
9734.23
The vCard's current balance.
Amount allowed to expend in the expenseLimitPeriod
provided. This field is not currently in use.
Period for the expenseLimit
. This is the period for which the expense limit amount applies. This field is not currently in use.
daily
, weekly
, every2weeks
, every6months
, monthly
, every3months
, annually
Number of uses allowed for the card. Default is 9999.
1
Flag indicating if the card holder needs to use the full amount of the card. When this field is 'true', then maxNumberOfUses
= 1
true
MCC assigned to vCard.
"7777"
TCC assigned to vCard.
Custom field 1.
Custom field 2.
Timestamp of when record was created, in UTC.
"2022-07-01 15:00:01"
Timestamp of when record was last updated, in UTC.
"2022-07-01 15:00:01"
Custom number identifying the vendor. Must be unique in paypoint.
"1234"
Primary name for vendor.
"Herman's Coatings"
Secondary name for vendor.
"Herman's Coating Supply Company, LLC"
Business EIN or tax ID. This value is masked in API responses, for example XXXX6789
.
"123456789"
Vendor's phone number.
"212-555-1234"
Vendor's email address.
320
"example@email.com"
Vendor's address.
"123 Maple Ave"
Additional line for vendor's address.
"STE 900"
Vendor's city.
"Bristol"
Vendor's state.
"VA"
Vendor's zip code.
"12345"
Vendor's country.
"US"
Business Merchant Category Code (MCC). This resource lists MCC codes.
"7777"
Additional location code used to identify the vendor.
"MIA123"
Array of objects describing the vendor's contacts.
The bank's ID in Payabli.
Name of bank for account.
"Country Bank"
Routing number of bank account.
"123123123"
Masked account number for bank account.
"1XXXXXX3123"
Type of bank account: Checking or Savings.
Checking
, Savings
"Checking"
The accountholder's name.
"Gruzya Adventure Outfitters LLC"
Describes whether the bank is a personal or business account.
Personal
, Business
"Business"
Describes whether the bank account is used for deposits or withdrawals in Payabli:
0
: Deposit1
: Withdrawal2
: Deposit and withdrawal
0
Vendor's status. Allowed status:
-
0 Inactive
-
1 Active
1
Enrollment status of vendor in payables program.
null
The paypoint's legal name.
"Sunshine Services, LLC"
The paypoint's DBA name.
"Sunshine Gutters"
Paypoint's entryname.
50
"d193cf9a46"
The name of the parent organization.
"PropertyManager Pro"
Timestamp of when record was created, in UTC.
"2022-07-01 15:00:01"
Timestamp of when record was last updated, in UTC.
"2022-07-01 15:00:01"
Remittance address. Used for mailing paper checks.
"123 Walnut Street"
Remittance address additional line. Used for mailing paper checks.
"Suite 900"
Remittance address city. Used for mailing paper checks.
"Miami"
Remittance address state. Used for mailing paper checks.
"FL"
Remittance address ZIP code. Used for mailing paper checks.
"31113"
Remittance address country. Used for mailing paper checks.
"US"
Alternative name used to receive paper check.
Alternative name used to receive paper check.
Internal identifier for global vendor account.
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
Data pertaining to single customer. See customerData Object Model for a complete reference.
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250
"3456-7645A"
Customer username for customer portal
"myusername"
Customer password for customer portal
"mypassword"
Customer Status. Possible values:
-99
Deleted0
Inactive1
Active85
Locked (typically due to multiple failed login attempts)
1
Company name
"Sunshine LLC"
Customer first name
"John"
Customer last name
"Smith"
Customer phone number
"1234567890"
Customer email address.
320
"example@email.com"
Customer address
"777 Main St"
Additional customer address
"Apt 6"
Customer city
"Miami"
Customer State
"FL"
Customer zip code
"33000"
Customer country in ISO-3166-1 alpha 2 format
See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
"US"
The shipping address.
250
"123 Walnut St"
Additional line for shipping address.
100
"STE 900"
Shipping city.
250
"Johnson City"
Shipping state or province.
"TN"
Shipping ZIP code.
50
"37619"
Shipping address country.
"US"
Customer balance.
988.44
Timezone, in UTC offset. For example, -5 is Eastern time.
-5
Additional Custom fields in format "key":"value".
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
["email"]
Timestamp of when record was created, in UTC.
"2022-07-01 15:00:01"
The name of the parent organization.
"PropertyManager Pro"
The paypoint's DBA name.
"Sunshine Gutters"
The paypoint's legal name.
"Sunshine Services, LLC"
The paypoint's entry name (entrypoint).
50
"d193cf9a46"
A custom identifier for the paypoint, if applicable. Like entrypoint
is the Payabli identifier for the merchant, externalPaypointId
is a custom field you can use to include the merchant's ID from your own systems.
"Paypoint-100"
Was this page helpful?
curl --request GET \
--url https://api-sandbox.payabli.com/api/Query/vcards/{entry} \
--header 'requestToken: <api-key>'
{
"Summary": {
"totalPages": 1,
"totalRecords": 1,
"totalAmount": 100,
"totalactive": 1,
"totalamountactive": 100,
"totalbalanceactive": 100
},
"Records": [
{
"vcardSent": false,
"cardToken": "20240306214229780012",
"cardNumber": null,
"cvc": null,
"expirationDate": "11/27",
"status": "Active",
"amount": 100,
"currentBalance": 100,
"expenseLimit": 0,
"expenseLimitPeriod": "",
"maxNumberOfUses": 1,
"currentNumberOfUses": 0,
"exactAmount": true,
"mcc": null,
"tcc": "",
"misc1": null,
"misc2": null,
"dateCreated": "2024-03-06T22:42:17.85",
"dateModified": "2024-03-06T19:00:00",
"associatedVendor": {
"VendorNumber": "QA-vendor-1234567890",
"Name1": "Pappas Industries",
"Name2": "Alexandros",
"EIN": "XXXX6789",
"Phone": "212-555-1234",
"Email": "alex.pappas@example.com",
"Address1": "789 5th Ave",
"Address2": "Suite 10B",
"City": "New York",
"State": "NY",
"Zip": "10022",
"Country": "USA",
"Mcc": "hi",
"LocationCode": "177.0954",
"Contacts": [
{
"ContactName": "Sophia Pappas",
"ContactEmail": "sophia.pappas@example.com",
"ContactTitle": "Operations Manager",
"ContactPhone": "212-555-5678"
}
],
"BillingData": {
"id": 0,
"bankName": "Olympus Bank",
"routingAccount": "021000021",
"accountNumber": "12345XXXX",
"typeAccount": "Checking",
"bankAccountHolderName": "",
"bankAccountHolderType": "Business",
"bankAccountFunction": 0
},
"PaymentMethod": "card",
"VendorStatus": 1,
"VendorId": 339,
"EnrollmentStatus": null,
"Summary": {
"ActiveBills": null,
"PendingBills": 1,
"InTransitBills": 0,
"PaidBills": 0,
"OverdueBills": 1,
"ApprovedBills": null,
"DisapprovedBills": null,
"TotalBills": 1,
"ActiveBillsAmount": null,
"PendingBillsAmount": 100,
"InTransitBillsAmount": 0,
"PaidBillsAmount": 0,
"OverdueBillsAmount": 100,
"ApprovedBillsAmount": null,
"DisapprovedBillsAmount": null,
"TotalBillsAmount": 100
},
"PaypointLegalname": "Pappas Industries LLC",
"PaypointDbaname": "Pappas Industries LLC",
"PaypointEntryname": "478saec23",
"ParentOrgName": "",
"CreatedDate": "2022-01-01T00:00:00",
"LastUpdated": "2022-01-01T00:00:00",
"remitAddress1": null,
"remitAddress2": null,
"remitCity": null,
"remitState": null,
"remitZip": null,
"remitCountry": null,
"payeeName1": null,
"payeeName2": null,
"customField1": null,
"customField2": null,
"customerVendorAccount": null,
"InternalReferenceId": 27,
"additionalData": null,
"externalPaypointID": null
},
"associatedCustomer": null,
"ParentOrgName": "Pappas Holdings",
"PaypointDbaname": "Pappas Industries LLC",
"PaypointLegalname": "Pappas Industries LLC",
"PaypointEntryname": "478saec23",
"externalPaypointID": "pappas01-001"
}
]
}