Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
cards

Create a vendor card

Create a new vendor card.

See Vendor cards in the Guides section for more information, sample requests, and responses.

post/v3/spend/cards

Headers

apiTokenstring nullable

Access token for Spend & Expense API authentication

Example:{{api_token}}

Request body

namestring required

Card name

userIdstring required

BILL-generated ID or UUID of the user linked with the card

budgetIdstring required

BILL-generated ID or UUID of the budget linked with the card

limitnumber nullable

Card spend limit for the current budget period

recurringLimitnumber nullable

Card spend limit for all future budget periods

expirationDatestring date nullable

User-generated expiration date. The value is in the yyyy-MM-dd format. BILL automatically closes the card account on this date.

Note: Use the validThru value in the response as the expiration date in a card payment. Do not use the expirationDate value for this operation.

shareBudgetFundsboolean nullable

Set as true to share all the budget funds with the card. This option enables the card user to spend from unallocated budget funds when the allocation is empty.

Example request

{
  "budgetId": "{{se_budget_uuid}}",
  "limit": "100",
  "name": "Happy Music Supplies card for Clark Spenderson",
  "userId": "{{se_user_uuid}}"
}

Response

Create a vendor card response

idstring

BILL-generated ID of the card

uuidstring

BILL-generated UUID of the card

namestring

Card name

userIdstring

BILL-generated ID of the user linked with the card

userUuidstring

BILL-generated UUID of the user linked with the card

budgetIdstring

BILL-generated ID of the budget linked with the card

budgetUuidstring

BILL-generated UUID of the budget linked with the card

lastFourstring

Last four digits of the card number

validThrustring

BILL-generated card expiration date. The value is in the MM/YY format.

Note: Use the validThru value as the expiration date in a card payment. Do not use the expirationDate value for this operation.

expirationDatestring date

User-generated card expiration date. This value is in the yyyy-MM-dd format. BILL automatically closes the card account on this date.

Note: Use the validThru value as the expiration date in a card payment. Do not use the expirationDate value for this operation.

status'ACTIVATED' | 'NOT_ACTIVATED' | 'FROZEN' | 'DELETED'

Card status.

deletedReason'CANCELLED' | 'LOST' | 'STOLEN' | 'MISPLACED' | 'FRAUD_CONFIRMED'

Delete card reason. This field is available in the response only when status is DELETED.

type'PHYSICAL' | 'VIRTUAL_MEMBER' | 'VIRTUAL_VENDOR' | 'VIRTUAL'

Card type.

shareBudgetFundsboolean

Set as true to share all the budget funds with the card. This option enables the card user to spend from unallocated budget funds when the allocation is empty.

recurringboolean

Set as true to renew the card funds in the next budget period

recurringLimitnumber

Card spend limit for the all future budget periods

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time