GET
/
Query
/
vcards
/
{entry}
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:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20

should become:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
entry
string
required

The paypoint's entrypoint identifier. Learn more

Example:

"8cfec329267"

Query Parameters

​
parameters
object

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
​
limitRecord
integer
default:20

Max number of records to return for the query. Use 0 or negative value to return all records.

Example:

0

​
fromRecord
integer
default:0

The number of records to skip before starting to collect the result set.

Example:

251

​
sortBy
string

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.

Example:

"desc(field_name)"

Response

200 - application/json
Success
​
Summary
object
​
Records
object[]

Was this page helpful?