v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

funding-accounts

Get card funding purpose

Get a list of card funding purpose values based on the vendor and card brand.

When you create a payment (POST /v3/payments or POST /v3/payments/bulk) with a CARD_ACCOUNT funding account type, BILL requires a vendor industry value for compliance. When BILL cannot identify the vendor industry, the cardFundingPurpose field must be set in your payment request.

Use this endpoint to get the list of card funding purpose values you can set. If you get an empty 200 response, BILL has information about the vendor industry and setting the cardFundingPurpose field is not required in your payment request.

get/v3/funding-accounts/cards/funding-purposes

Query parameters

vendorIdstring required

BILL-generated ID of the vendor to be paid. The value begins with 009.

Example:{{vendor_id}}

brandstring required

Card brand

Example:visa

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}

devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Get card funding purpose response

lastUsedPurposestring

Last used purpose. This value was last used as the cardFundingPurpose value in a payment request.

Note: This field is available only for the AMEX, VISA, and MASTERCARD card brands.