Download OpenAPI specification:
Public API for Linkpay services. Global rate limits apply to all endpoints unless specified otherwise.
Create new team
api-key required | string |
ownerName required | string |
teamName required | string |
{- "ownerName": "string",
- "teamName": "string"
}
{- "uuid": "string",
- "name": "string",
- "isOwner": true,
- "logoUrl": { }
}
Retrieves a list of team members for a specific team. Supports pagination.
api-key required | string |
teamUUID required | string |
required | object |
{- "teamUUID": "string",
- "search": {
- "cardsBalanceMin": 1,
- "cardsBalanceMax": 1,
- "spendMin": 0,
- "spendMax": 0,
- "isOwner": true,
- "searchText": "string",
- "orderDirection": "spend",
- "orderBy": "asc",
- "offset": 0,
- "limit": 1
}
}
{- "count": 1,
- "members": [
- {
- "memberUUID": "string",
- "name": "string",
- "isOwner": true,
- "cardsBalanceUsd": 0,
- "accountsBalanceUsd": 0,
- "spend": 0,
- "email": { },
- "logoUrl": { }
}
]
}
Retrieves a summary of team member for a specific team.
api-key required | string |
memberUUID required | string |
teamUUID required | string |
{- "memberUUID": "string",
- "teamUUID": "string"
}
{- "email": "string",
- "teamUsername": "string",
- "cardsCount": 0,
- "freeCardsCount": 0,
- "operationsCount": 1,
- "allTimeCardsCount": 0
}
Retrieves a summary of team for a specific team.
api-key required | string |
teamUUID required | string |
{- "teamUUID": "string"
}
{- "uuid": "string",
- "name": "string",
- "logoUrl": { },
- "isOwner": true,
- "cardsCount": 0,
- "freeCardsCount": 0,
- "membersCount": 1,
- "operationsCount": 0,
- "allTimeCardsCount": 0
}
Retrieves detailed information about a user’s, team’s, or team member’s accounts and their respective balances. The endpoint returns the total balance in USD, the aggregated balance of accounts and cards in USD, and a detailed list of accounts with their individual balances in both native currency and USD equivalent.
api-key required | string |
teamUUID | string |
memberUUID | string |
target required | any Enum: "user" "team" "teamMember" |
{- "teamUUID": "string",
- "memberUUID": "string",
- "target": "user"
}
{- "userUUID": "string",
- "accountsBalanceUsd": 0,
- "accounts": [
- {
- "uuid": "string",
- "currency": "BTC",
- "address": { },
- "balance": 0,
- "usdBalance": 0
}
], - "cardsBalanceUsd": 0,
- "totalBalanceUsd": 0
}
Creates internal transfer between users, teams or team members. For transfer with team you need teamUUID, for transfer with team member you need memberUUID, for transfer to another user you need anotherUserEmail instead of toUUID. toUUID is UUID of recieving account/card.
api-key required | string |
type required | any Enum: "OWN_ACCOUNT_TO_OWN_ACCOUNT" "OWN_ACCOUNT_TO_OWN_CARD" "OWN_ACCOUNT_TO_USER_ACCOUNT" "OWN_CARD_TO_OWN_ACCOUNT" "OWN_CARD_TO_OWN_CARD" "OWN_ACCOUNT_TO_TEAM_ACCOUNT" "TEAM_ACCOUNT_TO_TEAM_ACCOUNT" "TEAM_ACCOUNT_TO_TEAM_CARD" "TEAM_ACCOUNT_TO_TEAM_MEMBER_ACCOUNT" "TEAM_ACCOUNT_TO_TEAM_MEMBER_CARD" "TEAM_CARD_TO_TEAM_MEMBER_ACCOUNT" "TEAM_CARD_TO_TEAM_MEMBER_CARD" "TEAM_MEMBER_ACCOUNT_TO_TEAM_ACCOUNT" "TEAM_MEMBER_ACCOUNT_TO_TEAM_CARD" "TEAM_MEMBER_ACCOUNT_TO_TEAM_MEMBER_CARD" "TEAM_MEMBER_CARD_TO_TEAM_ACCOUNT" "TEAM_MEMBER_CARD_TO_TEAM_CARD" "TEAM_MEMBER_CARD_TO_TEAM_MEMBER_ACCOUNT" "TEAM_MEMBER_ACCOUNT_TO_TEAM_MEMBER_ACCOUNT" "TEAM_MEMBER_CARD_TO_TEAM_MEMBER_CARD" |
fromUUID required | string |
toUUID | string |
teamUUID | string |
memberUUID | string |
toAnotherUserEmail | string |
amount required | number |
{- "type": "OWN_ACCOUNT_TO_OWN_ACCOUNT",
- "fromUUID": "string",
- "toUUID": "string",
- "teamUUID": "string",
- "memberUUID": "string",
- "toAnotherUserEmail": "string",
- "amount": 0
}
{- "operationUUID": "string"
}
Provide array of cards and new balance you want to set on them. If array is empty, all cards will be updated. Returns array of operations UUIDs.
api-key required | string |
accountUUID required | string |
cardsUUIDs | Array of strings |
amount required | number |
teamUUID | string |
memberUUID | string |
target required | any Enum: "user" "team" "teamMember" |
{- "accountUUID": "string",
- "cardsUUIDs": [
- "string"
], - "amount": 0,
- "teamUUID": "string",
- "memberUUID": "string",
- "target": "user"
}
{- "operationsUUIDs": [
- "string"
], - "cardsUUIDs": [
- "string"
]
}
Retrieves a list of cards for a user, team, or team member, including details such as balance, currency, and status. Supports filtering, sorting, and pagination for flexible querying.
api-key required | string |
teamUUID | string |
memberUUID | string |
target required | any Enum: "user" "team" "teamMember" |
required | object |
{- "teamUUID": "string",
- "memberUUID": "string",
- "target": "user",
- "search": {
- "searchText": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "isActive": "active",
- "offset": 0,
- "limit": 1,
- "isOwner": true,
- "activeFirst": true,
- "latestFirst": true,
- "membersUUIDs": [
- "string"
]
}
}
{- "count": 0,
- "cards": [
- {
- "uuid": "string",
- "isActive": true,
- "isFavorite": true,
- "currency": "BTC",
- "balance": 0,
- "pending": 0,
- "spend": 0,
- "color": { },
- "name": { },
- "lastDigits": { },
- "expiresAt": "2019-08-24T14:15:22Z",
- "is3ds": true,
- "slug": { },
- "activatedAt": { },
- "network": "mastercard"
}
]
}
Get card credentials for user's, team's or team member's card.
api-key required | string |
cardUUID required | string |
{- "cardUUID": "string"
}
{- "cardNumber": "string",
- "cvv": "string",
- "staticPassword": { },
- "expiresMonth": "string",
- "expiresYear": "string",
- "holderAddress": "string",
- "holderName": "string"
}
Receives a list of active card types with linked bins.
api-key required | string |
[- {
- "name": "string",
- "slug": "string",
- "text": "string",
- "uuid": "string",
- "color": "string",
- "groupName": { },
- "bins": [
- {
- "network": "mastercard",
- "bin": "string",
- "type": "credit",
- "is3ds": true,
- "currency": "BTC"
}
]
}
]
Issue card for user's, team's or team member's account.
api-key required | string |
teamUUID required | string |
memberUUID required | string |
required | object |
{- "teamUUID": "string",
- "memberUUID": "string",
- "input": {
- "name": "string",
- "initialBalance": 0,
- "binUUID": "string",
- "cardTypeUUID": "string",
- "accountUUID": "string",
- "autoTopUp": {
- "balanceLess": 0,
- "balanceLessTopUp": 0
}
}
}
{- "uuid": "string",
- "name": "string",
- "currency": "BTC",
- "isFree": true,
- "color": { },
- "expiresAt": "2019-08-24T14:15:22Z",
- "expiresMonth": "st",
- "expiresYear": "stri",
- "network": "mastercard",
- "balance": 0
}
Retrieves a list of withdraw requests for a user. Supporting filtering and pagination.
api-key required | string |
offset | integer |
limit required | integer [ 1 .. 50 ] |
status | any Enum: "failed" "pending" "success" |
{- "offset": 0,
- "limit": 1,
- "status": "failed"
}
[- {
- "uuid": "string",
- "amountRequested": 0,
- "amount": 0,
- "fee": 0,
- "currency": "BTC",
- "status": "failed",
- "externalAddress": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "transactionHash": { }
}
]
Creates withdraw request from selected crypto account with pending status. Withdraw requests are processed manually.
api-key required | string |
accountUUID required | string |
addressToWithdraw required | string |
amount required | number |
{- "accountUUID": "string",
- "addressToWithdraw": "string",
- "amount": 0
}
{- "uuid": "string",
- "amountRequested": 0,
- "amount": 0,
- "fee": 0,
- "currency": "BTC",
- "status": "failed",
- "externalAddress": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
Get plan data for user or team by its owner if teamUUID is provided.
api-key required | string |
teamUUID | string |
{- "teamUUID": "string"
}
{- "name": "string",
- "cardTopUpFeePercent": 0,
- "depositFeePercent": 0,
- "depositFeeMinimum": 0,
- "declineTransactionFeePercent": 0,
- "freeCardsAvailable": 0,
- "overLimitCardPurchasePrice": 0,
- "overLimitCardReorderPrice": 0,
- "cardTransactionFeePercent": 0,
- "cardTransactionFeeMinimum": 0,
- "cardCashbackPercent": 0,
- "exchangeFeePercent": 0,
- "p2pTransferFeePercent": 0,
- "processingFeePercent": 0,
- "merchantsAvailable": 0,
- "vrcsFeePercent": 0,
- "businessWithdrawalFeePercent": 0,
- "businessWithdrawalFeeMinimum": 0,
- "personalWithdrawalFeePercent": 0,
- "personalWithdrawalFeeMinimum": 0,
- "maxTeamMembers": 0
}
Retrieves a list of operations for a user, team or team member. Supporting filtering and pagination.
api-key required | string |
required | object |
target required | any Enum: "user" "team" "teamMember" |
teamUUID | string |
memberUUID | string |
{- "searchObject": {
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "status": [
- "failed"
], - "searchText": "string",
- "accountCurrencies": [
- "BTC"
], - "cardUUIDs": [
- "string"
], - "offset": 0,
- "limit": 1,
- "memberUUIDs": [
- "string"
], - "direction": [
- "income"
], - "type": [
- "ACCOUNT_DEPOSIT"
]
}, - "target": "user",
- "teamUUID": "string",
- "memberUUID": "string"
}
[- {
- "uuid": "string",
- "description": { },
- "type": "ACCOUNT_DEPOSIT",
- "status": "failed",
- "amountRaw": 0,
- "amount": 0,
- "fee": 0,
- "cashback": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "direction": "income",
- "currency": "BTC",
- "declinedReason": { },
- "userUUID": "string",
- "bankMessage": { },
- "externalWalletAddress": { },
- "transactions": [
- {
- "uuid": "string",
- "amountFrom": 0,
- "amountTo": 0,
- "currencyFrom": "BTC",
- "currencyTo": "BTC",
- "conversionRate": 0,
- "status": "failed",
- "direction": "income",
- "type": "cashback",
- "entityType": "account",
- "entityUUID": "string",
- "isReverted": true,
- "feeType": { }
}
]
}
]