Appearance
Platform API
Accounts
Endpoints and schemas for the Accounts API area.
Accounts
Operations
GET/v1/accountsPOST/v1/accountsGET/v1/accounts/{accountUuid}GET/v1/accounts/{accountUuid}/transfersGET/v1/accounts/{accountUuid}/statementPATCH/v1/accounts/{accountUuid}/linked-accountPOST/v1/accounts/{accountUuid}/withdrawalPOST/v1/accounts/{accountUuid}/transferPATCH/v1/accounts/{accountUuid}/transfer/{transferId}PATCH/v1/accounts/{accountUuid}/withdrawal/{transferId}PATCH/v1/accounts/{accountUuid}/status
List accounts
GET
/v1/accounts
Returns accounts matching the given filters, with pagination metadata.
Authorizations
papiHmac
HMAC authentication. Send x-api-key, x-timestamp, x-nonce, and an x-signature computed over the request.
Type
API Key (header: x-api-key)
Parameters
Query Parameters
limit
Type
integer
Default
50Exclusive Minimum
trueMaximum
100offset
Type
integer
Default
0Minimum
0Maximum
9007199254740991search
Type
string
Min Length
1Max Length
255ownerType
Type
string
Valid values
"user""organization"type
Type
string
Min Length
1holder
Type
string
Valid values
"user""organization""investor""project"status
Type
string
Min Length
1withdrawalStatus
Type
string
Valid values
"none""withdrawal_restricted"walletStatus
Type
string
Min Length
1kycStatus
Type
string
Min Length
1country
Type
string
Min Length
1Responses
Successful response
application/json
{
}
Create account
POST
/v1/accounts
Creates a new account. The type is forced to platform for now.
Authorizations
papiHmac
HMAC authentication. Send x-api-key, x-timestamp, x-nonce, and an x-signature computed over the request.
Type
API Key (header: x-api-key)
Request Body
application/json
{
}
Responses
Successful response
application/json
{
}
Get account
GET
/v1/accounts/{accountUuid}
Returns detailed information about a single account, including its owner and current balance.
Authorizations
papiHmac
HMAC authentication. Send x-api-key, x-timestamp, x-nonce, and an x-signature computed over the request.
Type
API Key (header: x-api-key)
Parameters
Path Parameters
accountUuid*
Type
Requiredstring
Format
"uuid"Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
Successful response
application/json
{
}
List account transfers
GET
/v1/accounts/{accountUuid}/transfers
Returns transfers for the given account matching the supplied filters, with pagination metadata.
Authorizations
papiHmac
HMAC authentication. Send x-api-key, x-timestamp, x-nonce, and an x-signature computed over the request.
Type
API Key (header: x-api-key)
Parameters
Path Parameters
accountUuid*
Type
Requiredstring
Format
"uuid"Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Query Parameters
type
Type
string
Valid values
"deposit""withdrawal""transfer"status
Type
string
Valid values
"pending""finished""cancelled"metadata
Type
object
search
Type
string
orderBy
token
limit
Type
integer
Exclusive Minimum
trueMaximum
9007199254740991offset
Type
integer
Minimum
0Maximum
9007199254740991createdAtFrom
Type
string
createdAtTo
Type
string
amountMin
Type
number
Minimum
0Exclusive Minimum
trueamountMax
Type
number
Minimum
0Exclusive Minimum
trueidentifier
Type
string
identifiers
Type
array
operation
Type
string
Valid values
"CREDIT""DEBIT"Responses
Successful response
application/json
{
}
Get account statement
GET
/v1/accounts/{accountUuid}/statement
Returns an account statement for the given date range: opening and closing balances, every transfer in the period, and settled credit/debit totals. Defaults to the last 30 days when no range is given.
Authorizations
papiHmac
HMAC authentication. Send x-api-key, x-timestamp, x-nonce, and an x-signature computed over the request.
Type
API Key (header: x-api-key)
Parameters
Path Parameters
accountUuid*
Type
Requiredstring
Format
"uuid"Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Query Parameters
from
Type
string
Min Length
1to
Type
string
Min Length
1Responses
Successful response
application/json
{
}
Update linked bank account
PATCH
/v1/accounts/{accountUuid}/linked-account
Sets (or replaces) the external bank account linked to the given account and starts validation on it. Returns the linked account in its validating state.
Authorizations
papiHmac
HMAC authentication. Send x-api-key, x-timestamp, x-nonce, and an x-signature computed over the request.
Type
API Key (header: x-api-key)
Parameters
Path Parameters
accountUuid*
Type
Requiredstring
Format
"uuid"Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
application/json
{
}
Responses
Successful response
application/json
{
}
Create withdrawal
POST
/v1/accounts/{accountUuid}/withdrawal
Initiates a withdrawal from the account to its linked external bank account. Requires the account to be active and the linked account to be verified. Creates a pending withdrawal in WAPI.
Authorizations
papiHmac
HMAC authentication. Send x-api-key, x-timestamp, x-nonce, and an x-signature computed over the request.
Type
API Key (header: x-api-key)
Parameters
Path Parameters
accountUuid*
Type
Requiredstring
Format
"uuid"Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
application/json
{
}
Responses
Successful response
application/json
{
}
Create transfer
POST
/v1/accounts/{accountUuid}/transfer
Initiates a pending wallet-to-wallet transfer from the account to another wallet. Both the source account and the destination wallet must be active, known accounts.
Authorizations
papiHmac
HMAC authentication. Send x-api-key, x-timestamp, x-nonce, and an x-signature computed over the request.
Type
API Key (header: x-api-key)
Parameters
Path Parameters
accountUuid*
Type
Requiredstring
Format
"uuid"Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
application/json
{
}
Responses
Successful response
application/json
{
}
Update transfer
PATCH
/v1/accounts/{accountUuid}/transfer/{transferId}
Updates the status of a transfer belonging to the account: mark a pending transfer finished, or cancel it. Returns the updated transfer.
Authorizations
papiHmac
HMAC authentication. Send x-api-key, x-timestamp, x-nonce, and an x-signature computed over the request.
Type
API Key (header: x-api-key)
Parameters
Path Parameters
accountUuid*
Type
Requiredstring
Format
"uuid"Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"transferId*
Type
Requiredstring
Min Length
1Request Body
application/json
{
}
Responses
Successful response
application/json
{
}
Update withdrawal
PATCH
/v1/accounts/{accountUuid}/withdrawal/{transferId}
Cancels a pending withdrawal belonging to the account. Finishing is driven by bank settlement, not the caller. Returns the updated withdrawal.
Authorizations
papiHmac
HMAC authentication. Send x-api-key, x-timestamp, x-nonce, and an x-signature computed over the request.
Type
API Key (header: x-api-key)
Parameters
Path Parameters
accountUuid*
Type
Requiredstring
Format
"uuid"Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"transferId*
Type
Requiredstring
Min Length
1Request Body
application/json
{
}
Responses
Successful response
application/json
{
}
Update account status
PATCH
/v1/accounts/{accountUuid}/status
Blocks (status "disabled") or closes (status "deleted") an account. Returns the updated account.
Authorizations
papiHmac
HMAC authentication. Send x-api-key, x-timestamp, x-nonce, and an x-signature computed over the request.
Type
API Key (header: x-api-key)
Parameters
Path Parameters
accountUuid*
Type
Requiredstring
Format
"uuid"Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
application/json
{
}
Responses
Successful response
application/json
{
}