Planbok V2 API

Schemas

Wallet

id

string · pattern: ^[0-9a-fA-F]{24}$

type

string · enum

Enum values:

eoa

sca

address

string

customer

string · pattern: ^[0-9a-fA-F]{24}$

walletSet

string · pattern: ^[0-9a-fA-F]{24}$

organization

string · pattern: ^[0-9a-fA-F]{24}$

blockchain

string · enum

The blockchain identifier.

Enum values:

ARB

ARB-SEPOLIA

AVAX-C

AVAX-C-FUJI

BASE

BASE-SEPOLIA

BSC

BSC-TESTNET

controller

string · enum

Enum values:

organization

customer

name

string

refId

string

state

string · enum

Enum values:

active

frozen

publicKey

string

Customer

id

string · pattern: ^[0-9a-fA-F]{24}$

name

string

refId

string

custodyType

string · enum

Enum values:

organization

customer

status

string

hasPin

boolean

hasRecovery

boolean

createdAt

string · date-time

updatedAt

string · date-time

WalletSet

id

string · pattern: ^[0-9a-fA-F]{24}$

name

string

controller

string · enum

Enum values:

organization

customer

organization

string · pattern: ^[0-9a-fA-F]{24}$

createdAt

string · date-time

updatedAt

string · date-time

BaseResponse

success

boolean

status

integer

PaginationResponse

success

boolean

status

integer

object

WalletSetListResponse

success

boolean

status

integer

object

object[]

WalletListResponse

success

boolean

status

integer

object

message

string

object[]

TokenBalanceListResponse

success

boolean

status

integer

object

message

string

object[]

TokenListResponse

success

boolean

status

integer

object

object[]

TransactionListResponse

success

boolean

status

integer

object

message

string

object[]

CustomerListResponse

success

boolean

status

integer

object

message

string

object[]

ChallengeListResponse

success

boolean

status

integer

object

message

string

object[]

Transaction

id

string · pattern: ^[0-9a-fA-F]{24}$

txHash

string

txExplorerUrl

string

blockchain

string · enum

The blockchain identifier.

Enum values:

ARB

ARB-SEPOLIA

AVAX-C

AVAX-C-FUJI

BASE

BASE-SEPOLIA

BSC

BSC-TESTNET

chainType

string

controller

string · enum

Enum values:

organization

customer

status

string · enum

Enum values:

pending

signed

broadcast

broadcasted

confirmed

failed

cancelled

operation

string

refId

string

object

error

string

object

createdAt

string · date-time

updatedAt

string · date-time

TokenBalance

amount

string

object

WalletType

string · enum

Enum values:

eoa

sca

CustodyType

string · enum

Enum values:

organization

customer

StateType

string · enum

Enum values:

active

frozen

Blockchain

string · enum

Enum values:

ARB

ARB-SEPOLIA

AVAX-C

AVAX-C-FUJI

BASE

BASE-SEPOLIA

BSC

BSC-TESTNET

The blockchain identifier.

TokenStandard

string · enum

Enum values:

native

erc20

fungible

fungible-asset

credit_alphanum4

credit_alphanum12

sep41

cw20

The token standard.

Pagination

total

integer

page

integer

pages

integer

Challenge

challengeId

string

redirectUrl

string · uri

URL to redirect to after challenge completion.

status

string · enum

Enum values:

pending

verified

expired

failed

expiresAt

string · date-time

ChallengeRecord

id

string · pattern: ^[0-9a-fA-F]{24}$

operation

string

task

string

status

string

expiresAt

string · date-time

attempts

integer

maxAttempts

integer

redirectUrl

string · uri

metadata

object

createdAt

string · date-time

updatedAt

string · date-time

FeeEstimate

object

TransactionResult

id

string

transactionHash

string

signedTransaction

string

object

status

string

Signature

signature

string

r

string

s

string

v

integer

TransactionData

signedTransaction

string

object

memo

string

FeeLevel

estimatedFee

string

estimatedFeeFormatted

string

currency

string

object

error

string

ErrorResponse

success

boolean

object

HolderDetails

firstName

string · required

lastName

string · required

phoneNumber

string · required

email

string · required

address

string · required

dateOfBirth

string · date · pattern: ^\d{4}-\d{2}-\d{2}$ · required

bvn

string · pattern: ^\d{11}$ · required

nin

string · pattern: ^\d{11}$ · required

CreateOrganizationVirtualAccountsRequest

idempotencyKey

string · required

count

integer · required

object[] · required

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext. Use context verify

CreateVirtualAccountsResponse

success

boolean

message

string

object

VirtualAccount

id

string

name

string

refId

string

controller

string · enum

Enum values:

organization

customer

currency

string

fundingMethod

string

accountNumber

string

accountName

string

bankName

string

bankCode

string

status

string

providerCustomerId

string

providerWalletId

string

createdAt

string · date-time

VirtualAccountListResponse

success

boolean

object

VirtualAccountResponse

success

boolean

object

Bank

id

string

code

string

name

string

BankListResponse

success

boolean

object

BalanceResponse

success

boolean

object

CustomerDetailsResponse

success

boolean

data

object

VATransactionListItem

id

string

amount

string

currency

string

transType

string

entry

string

reference

string

CustomerReference

string |

source

string

destination

string

narration

string

status

string

recipientDetails

string |

senderDetails

string |

senderBank

string

recipientBank

string

provider

string

sessionId

string

accountProvider

string

createdAt

string · date-time

updatedAt

string · date-time

VATransaction

id

string

amount

string

currency

string

transType

string

entry

string

reference

string

narration

string

status

string

recipientDetails

string |

senderDetails

string |

senderBank

string

recipientBank

string

accountProvider

string

createdAt

string · date-time

updatedAt

string · date-time

VATransactionListResponse

success

boolean

object

VATransactionResponse

success

boolean

object

NameEnquiryResponse

success

boolean

object

LomaNameEnquiryResponse

success

boolean

object

TransferRequest

idempotencyKey

string · required

amount

string · required

destinationType

string · enum · required

Enum values:

other-banks

same-bank

object · required

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext. Use context verify

narration

string

TransferResponse

success

boolean

message

string

object

TransferChallengeRequest

redirectUrl

string · required

amount

string · required

destinationType

string · enum · required

Enum values:

other-banks

same-bank

object · required

narration

string

CreateCustomerVirtualAccountChallengeRequest

redirectUrl

string · required

currencies

string[] · required

object · required

ChallengeResponse

success

boolean

message

string

object

VAErrorResponse

success

boolean

object

Planbok V2 API

Schemas

Wallet

id

string · pattern: ^[0-9a-fA-F]{24}$

type

string · enum

Enum values:

eoa

sca

address

string

customer

string · pattern: ^[0-9a-fA-F]{24}$

walletSet

string · pattern: ^[0-9a-fA-F]{24}$

organization

string · pattern: ^[0-9a-fA-F]{24}$

blockchain

string · enum

The blockchain identifier.

Enum values:

ARB

ARB-SEPOLIA

AVAX-C

AVAX-C-FUJI

BASE

BASE-SEPOLIA

BSC

BSC-TESTNET

controller

string · enum

Enum values:

organization

customer

name

string

refId

string

state

string · enum

Enum values:

active

frozen

publicKey

string

Customer

id

string · pattern: ^[0-9a-fA-F]{24}$

name

string

refId

string

custodyType

string · enum

Enum values:

organization

customer

status

string

hasPin

boolean

hasRecovery

boolean

createdAt

string · date-time

updatedAt

string · date-time

WalletSet

id

string · pattern: ^[0-9a-fA-F]{24}$

name

string

controller

string · enum

Enum values:

organization

customer

organization

string · pattern: ^[0-9a-fA-F]{24}$

createdAt

string · date-time

updatedAt

string · date-time

BaseResponse

success

boolean

status

integer

PaginationResponse

success

boolean

status

integer

object

WalletSetListResponse

success

boolean

status

integer

object

object[]

WalletListResponse

success

boolean

status

integer

object

message

string

object[]

TokenBalanceListResponse

success

boolean

status

integer

object

message

string

object[]

TokenListResponse

success

boolean

status

integer

object

object[]

TransactionListResponse

success

boolean

status

integer

object

message

string

object[]

CustomerListResponse

success

boolean

status

integer

object

message

string

object[]

ChallengeListResponse

success

boolean

status

integer

object

message

string

object[]

Transaction

id

string · pattern: ^[0-9a-fA-F]{24}$

txHash

string

txExplorerUrl

string

blockchain

string · enum

The blockchain identifier.

Enum values:

ARB

ARB-SEPOLIA

AVAX-C

AVAX-C-FUJI

BASE

BASE-SEPOLIA

BSC

BSC-TESTNET

chainType

string

controller

string · enum

Enum values:

organization

customer

status

string · enum

Enum values:

pending

signed

broadcast

broadcasted

confirmed

failed

cancelled

operation

string

refId

string

object

error

string

object

createdAt

string · date-time

updatedAt

string · date-time

TokenBalance

amount

string

object

WalletType

string · enum

Enum values:

eoa

sca

CustodyType

string · enum

Enum values:

organization

customer

StateType

string · enum

Enum values:

active

frozen

Blockchain

string · enum

Enum values:

ARB

ARB-SEPOLIA

AVAX-C

AVAX-C-FUJI

BASE

BASE-SEPOLIA

BSC

BSC-TESTNET

The blockchain identifier.

TokenStandard

string · enum

Enum values:

native

erc20

fungible

fungible-asset

credit_alphanum4

credit_alphanum12

sep41

cw20

The token standard.

Pagination

total

integer

page

integer

pages

integer

Challenge

challengeId

string

redirectUrl

string · uri

URL to redirect to after challenge completion.

status

string · enum

Enum values:

pending

verified

expired

failed

expiresAt

string · date-time

ChallengeRecord

id

string · pattern: ^[0-9a-fA-F]{24}$

operation

string

task

string

status

string

expiresAt

string · date-time

attempts

integer

maxAttempts

integer

redirectUrl

string · uri

metadata

object

createdAt

string · date-time

updatedAt

string · date-time

FeeEstimate

object

TransactionResult

id

string

transactionHash

string

signedTransaction

string

object

status

string

Signature

signature

string

r

string

s

string

v

integer

TransactionData

signedTransaction

string

object

memo

string

FeeLevel

estimatedFee

string

estimatedFeeFormatted

string

currency

string

object

error

string

ErrorResponse

success

boolean

object

HolderDetails

firstName

string · required

lastName

string · required

phoneNumber

string · required

email

string · required

address

string · required

dateOfBirth

string · date · pattern: ^\d{4}-\d{2}-\d{2}$ · required

bvn

string · pattern: ^\d{11}$ · required

nin

string · pattern: ^\d{11}$ · required

CreateOrganizationVirtualAccountsRequest

idempotencyKey

string · required

count

integer · required

object[] · required

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext. Use context verify

CreateVirtualAccountsResponse

success

boolean

message

string

object

VirtualAccount

id

string

name

string

refId

string

controller

string · enum

Enum values:

organization

customer

currency

string

fundingMethod

string

accountNumber

string

accountName

string

bankName

string

bankCode

string

status

string

providerCustomerId

string

providerWalletId

string

createdAt

string · date-time

VirtualAccountListResponse

success

boolean

object

VirtualAccountResponse

success

boolean

object

Bank

id

string

code

string

name

string

BankListResponse

success

boolean

object

BalanceResponse

success

boolean

object

CustomerDetailsResponse

success

boolean

data

object

VATransactionListItem

id

string

amount

string

currency

string

transType

string

entry

string

reference

string

CustomerReference

string |

source

string

destination

string

narration

string

status

string

recipientDetails

string |

senderDetails

string |

senderBank

string

recipientBank

string

provider

string

sessionId

string

accountProvider

string

createdAt

string · date-time

updatedAt

string · date-time

VATransaction

id

string

amount

string

currency

string

transType

string

entry

string

reference

string

narration

string

status

string

recipientDetails

string |

senderDetails

string |

senderBank

string

recipientBank

string

accountProvider

string

createdAt

string · date-time

updatedAt

string · date-time

VATransactionListResponse

success

boolean

object

VATransactionResponse

success

boolean

object

NameEnquiryResponse

success

boolean

object

LomaNameEnquiryResponse

success

boolean

object

TransferRequest

idempotencyKey

string · required

amount

string · required

destinationType

string · enum · required

Enum values:

other-banks

same-bank

object · required

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext. Use context verify

narration

string

TransferResponse

success

boolean

message

string

object

TransferChallengeRequest

redirectUrl

string · required

amount

string · required

destinationType

string · enum · required

Enum values:

other-banks

same-bank

object · required

narration

string

CreateCustomerVirtualAccountChallengeRequest

redirectUrl

string · required

currencies

string[] · required

object · required

ChallengeResponse

success

boolean

message

string

object

VAErrorResponse

success

boolean

object