API referencePay Out endpointsPayout reporting

List vcards by paypoint

Retrieve a list of vcards (virtual credit cards) issued for an entrypoint. Use filters to limit results.

Path parameters

entrystringRequired

The paypoint’s entrypoint identifier. Learn more

Headers

requestTokenstringRequired

Query parameters

fromRecordintegerOptionalDefaults to 0

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

limitRecordintegerOptionalDefaults to 20

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

parametersmap from strings to optional stringsOptional

Collection of field names, conditions, and values used to filter the query.

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

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 separated by ”|”
  • nin => not inside array separated by ”|”
sortBystringOptional

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.

Response

Success

SummaryobjectOptional
Recordslist of objectsOptional

Errors