Linkpay public API (1.0.0)

Download OpenAPI specification:

Public API for Linkpay services. Global rate limits apply to all endpoints unless specified otherwise.

User

Get user data.

header Parameters
api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "username": "string",
  • "firstName": { },
  • "logoUrl": { },
  • "lastName": { },
  • "email": { },
  • "emailVerified": true,
  • "twofaEnabled": true,
  • "apiKeysCount": 0
}

Team

Get user teams data.

Retrieves a list of teams where user is an active member.

header Parameters
api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create team

Create new team

header Parameters
api-key
required
string
Request Body schema: application/json
required
ownerName
required
string
teamName
required
string

Responses

Request samples

Content type
application/json
{
  • "ownerName": "string",
  • "teamName": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "isOwner": true,
  • "logoUrl": { }
}

Get team members

Retrieves a list of team members for a specific team. Supports pagination.

header Parameters
api-key
required
string
Request Body schema: application/json
required
teamUUID
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "teamUUID": "string",
  • "search": {
    }
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "members": [
    ]
}

Get team member summary

Retrieves a summary of team member for a specific team.

header Parameters
api-key
required
string
Request Body schema: application/json
required
memberUUID
required
string
teamUUID
required
string

Responses

Request samples

Content type
application/json
{
  • "memberUUID": "string",
  • "teamUUID": "string"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "teamUsername": "string",
  • "cardsCount": 0,
  • "freeCardsCount": 0,
  • "operationsCount": 1,
  • "allTimeCardsCount": 0
}

Get team summary

Retrieves a summary of team for a specific team.

header Parameters
api-key
required
string
Request Body schema: application/json
required
teamUUID
required
string

Responses

Request samples

Content type
application/json
{
  • "teamUUID": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "logoUrl": { },
  • "isOwner": true,
  • "cardsCount": 0,
  • "freeCardsCount": 0,
  • "membersCount": 1,
  • "operationsCount": 0,
  • "allTimeCardsCount": 0
}

Balances

Get balances data

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.

header Parameters
api-key
required
string
Request Body schema: application/json
required
teamUUID
string
memberUUID
string
target
required
any
Enum: "user" "team" "teamMember"

Responses

Request samples

Content type
application/json
{
  • "teamUUID": "string",
  • "memberUUID": "string",
  • "target": "user"
}

Response samples

Content type
application/json
{
  • "userUUID": "string",
  • "accountsBalanceUsd": 0,
  • "accounts": [
    ],
  • "cardsBalanceUsd": 0,
  • "totalBalanceUsd": 0
}

Create internal transfer

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.

header Parameters
api-key
required
string
Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "type": "OWN_ACCOUNT_TO_OWN_ACCOUNT",
  • "fromUUID": "string",
  • "toUUID": "string",
  • "teamUUID": "string",
  • "memberUUID": "string",
  • "toAnotherUserEmail": "string",
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "operationUUID": "string"
}

Mass cards balances change

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.

header Parameters
api-key
required
string
Request Body schema: application/json
required
accountUUID
required
string
cardsUUIDs
Array of strings
amount
required
number
teamUUID
string
memberUUID
string
target
required
any
Enum: "user" "team" "teamMember"

Responses

Request samples

Content type
application/json
{
  • "accountUUID": "string",
  • "cardsUUIDs": [
    ],
  • "amount": 0,
  • "teamUUID": "string",
  • "memberUUID": "string",
  • "target": "user"
}

Response samples

Content type
application/json
{
  • "operationsUUIDs": [
    ],
  • "cardsUUIDs": [
    ]
}

Cards

Get cards data

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.

header Parameters
api-key
required
string
Request Body schema: application/json
required
teamUUID
string
memberUUID
string
target
required
any
Enum: "user" "team" "teamMember"
required
object

Responses

Request samples

Content type
application/json
{
  • "teamUUID": "string",
  • "memberUUID": "string",
  • "target": "user",
  • "search": {
    }
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "cards": [
    ]
}

Get card credentials

Get card credentials for user's, team's or team member's card.

header Parameters
api-key
required
string
Request Body schema: application/json
required
cardUUID
required
string

Responses

Request samples

Content type
application/json
{
  • "cardUUID": "string"
}

Response samples

Content type
application/json
{
  • "cardNumber": "string",
  • "cvv": "string",
  • "staticPassword": { },
  • "expiresMonth": "string",
  • "expiresYear": "string",
  • "holderAddress": "string",
  • "holderName": "string"
}

Get card types

Receives a list of active card types with linked bins.

header Parameters
api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Issue card

Issue card for user's, team's or team member's account.

header Parameters
api-key
required
string
Request Body schema: application/json
required
teamUUID
required
string
memberUUID
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "teamUUID": "string",
  • "memberUUID": "string",
  • "input": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "currency": "BTC",
  • "isFree": true,
  • "color": { },
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "expiresMonth": "st",
  • "expiresYear": "stri",
  • "network": "mastercard",
  • "balance": 0
}

Withdraw

Get withdraw requests

Retrieves a list of withdraw requests for a user. Supporting filtering and pagination.

header Parameters
api-key
required
string
Request Body schema: application/json
required
offset
integer
limit
required
integer [ 1 .. 50 ]
status
any
Enum: "failed" "pending" "success"

Responses

Request samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 1,
  • "status": "failed"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create withdraw request

Creates withdraw request from selected crypto account with pending status. Withdraw requests are processed manually.

header Parameters
api-key
required
string
Request Body schema: application/json
required
accountUUID
required
string
addressToWithdraw
required
string
amount
required
number

Responses

Request samples

Content type
application/json
{
  • "accountUUID": "string",
  • "addressToWithdraw": "string",
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "amountRequested": 0,
  • "amount": 0,
  • "fee": 0,
  • "currency": "BTC",
  • "status": "failed",
  • "externalAddress": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Plans

Get plan data

Get plan data for user or team by its owner if teamUUID is provided.

header Parameters
api-key
required
string
Request Body schema: application/json
optional
teamUUID
string

Responses

Request samples

Content type
application/json
{
  • "teamUUID": "string"
}

Response samples

Content type
application/json
{
  • "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
}

Operations

Get operations

Retrieves a list of operations for a user, team or team member. Supporting filtering and pagination.

header Parameters
api-key
required
string
Request Body schema: application/json
required
required
object
target
required
any
Enum: "user" "team" "teamMember"
teamUUID
string
memberUUID
string

Responses

Request samples

Content type
application/json
{
  • "searchObject": {
    },
  • "target": "user",
  • "teamUUID": "string",
  • "memberUUID": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]