Wallets

The BTPay Cryptocurrency and FIAT Wallets and their balances.

The Wallet Object

Name	Type	Description
id	Number	Unique identifier for the object
label	String	Wallets description
balanceConfirmed	Number	Confirmed balance
balancePending	Number	Pending balance
balanceBlocked	Number	Blocked balance
currency	String	Three-letter currency code for the payment amount (pricing currency)
status	String	The status of the wallet
createdAt	Date	Time at which the object was created

Wallet Methods

Creates a wallet

POST /api/v2/wallets/create

Creates new wallet

Headers

Name	Type	Description
Accept*	application/json

Request Body

Name	Type	Description
currency*	String	Wallet currency
label	String	Wallet label

200: OK Successful response

401: Unauthorized Unauthenticated response

422: Unprocessable Entity Error response

Lists all Wallets

GET /api/v2/wallets

Returns a list of previously created Wallets. The Wallets are returned in sorted order, with the most recent wallet appearing first. You can optionally provide parameters to filter out the results by time created.

Query Parameters

Name	Type	Description
from	Date	Filter by created time. We use basic ISO 8601 format for mixed date-time: YYYY-MM-DDThh:mm:ss
to	Date	Filter by created time. We use basic ISO 8601 format for mixed date-time: YYYY-MM-DDThh:mm:ss
page	Number	Current page

200: OK Successful response

422: Unprocessable Entity Error Response