List of card payments

Card payments are the payments your company made toward its card balance. A card payment covers the card balance, which combines many transactions.

Use GET /v3/spend/card-payments to get the card payments for your company.

Note: Only Spend & Expense users with the ADMIN user role can access card payment information.

Get card payments

Send a GET /v3/spend/card-payments request to get the card payments for your company.

By default, you get 20 results on one page. Set max to get up to 100 results on one page.

Sample request

curl --request GET \
  --url 'https://gateway.stage.bill.com/connect/v3/spend/card-payments' \
  --header 'apiToken: {api_token}' \
  --header 'Accept: application/json'

Response

In the response, details for each card payment are available. All amounts are in USD.

{
  "results": [
    {
      "id": "UGF5bWVudDI6YXNkZjEyMzQ=",
      "status": "PENDING",
      "submittedDate": "2020-05-05",
      "amount": 7,
      "method": "PAYMENT_PORTAL",
      "accountNumber": "••••••3123"
    },
    {
      "id": "UGF5bWVudDI6YXNkZjEyMzU=",
      "status": "POSTED",
      "submittedDate": "2020-05-05",
      "postedDate": "2020-05-06",
      "amount": 5,
      "method": "WIRE"
    },
    {
      "id": "UGF5bWVudDI6YXNkZjEyMzY=",
      "status": "RETURNED",
      "submittedDate": "2020-05-05",
      "postedDate": "2020-05-06",
      "amount": 3,
      "method": "CREDIT_ACH"
    },
    {
      "id": "UGF5bWVudDI6YXNkZjEyMzc=",
      "status": "RETURNED",
      "submittedDate": "2020-05-05",
      "postedDate": "2020-05-06",
      "amount": 1,
      "method": "UNKNOWN",
      "accountNumber": "••••••3123"
    },
    {
      "id": "UGF5bWVudDI6YXNkZjEyMzg=",
      "status": "POSTED",
      "submittedDate": "2020-05-05",
      "postedDate": "2020-05-06",
      "amount": 1,
      "method": "AUTODRAFT",
      "accountNumber": "••••••3123"
    }
  ]
}

Response parameters

Parameter	Type	Description
`results`	array	List of card payments
`id`	string	ID of the card payment
`status`	string	Status of the card payment. Possible values: `PENDING`, `POSTED`, `RETURNED`.
`submittedDate`	string	Date the payment was submitted, in yyyy-mm-dd format.
`postedDate`	string	Posted date of the payment, in yyyy-mm-dd format.
`amount`	number	Payment amount in `USD`.
`method`	string	Method of payment
`accountNumber`	string	The bank account the card payment was made from.
`network`	string	Card network of the program. Possible values: `VISA`, `MASTERCARD`, `UNDEFINED`.

The /v3/spend/card-payments endpoint supports filtering card payments and pagination. All amounts are in USD.

Filter card payments

Use the filters query parameter to filter card payments. Set multiple filters as a comma-separated list in this format: filters={field_01}:{op}:{value},{field_02}:{op}:{value}.

For example: filters=status:eq:POSTED,submittedDate:gte:2025-01-31

Pagination

Use the nextPage or prevPage query parameter to paginate through results. Do not include nextPage and prevPage together in the same request URL.

For example: GET /v3/spend/card-payments?nextPage=YXJyYXljb25uZWN0aW9uOjM=

Supported payment method values

In the response, the method field (results[].method) displays one of these values:

Value	Description
Autodraft (`AUTODRAFT`)	Scheduled automatic payment from your company's bank account.
Low Balance Auto Pay (`AUTOPAY`)	Automatic payment when the balance drops below your company's threshold.
Payment Portal (`PAYMENT_PORTAL`)	ACH debit that you start manually.
Credit ACH (`CREDIT_ACH`)	Incoming ACH credit sent by your company.
Wire (`WIRE`)	Incoming wire transfer.
Check (`CHECK`)	Paper check received.
Real Time Payment (`REAL_TIME_PAYMENT`)	Payment made through a real-time payment network.
AP Payment (`AP_PAYMENT`)	Payment made through BILL AP.
Transfer (`TRANSFER`)	Security deposit transfer.
Unknown (`UNKNOWN`)	The payment method is unavailable or does not match a defined method as listed here.

See the GET /v3/spend/card-payments API for more information