Banki
Pay
v3.3
Getting Started
Introduction
Core Concepts
Architecture
Fee Structure & Revenue
Fund Flow
Access Credentials
Signature & Encryption
Authentication
User Management
POST
Create User
GET
Get User Info
POST
Verify User
POST
Verify Recipient
GET
Merchant Users
POST
Update User
POST
Freeze User
POST
Unfreeze User
User Wallet Management
POST
Create Wallet
GET
User Wallet List
GET
User Wallet by Chain
POST
Collect to Pool
POST
Distribute TRX
Transfers
POST
Create Transfer
GET
Transfer Status
GET
Transfer List
GET
Debits
GET
Credits
Fund Pool & Fees
GET
Pool Overview
GET
Pool Balance
GET
Fee Detail
POST
Pool Withdraw
GET
Pool Ledger
Blockchain Settlement
GET
Blockchain Transfers
GET
Transfer Detail
Webhooks & More
Webhook Overview
Debit Notification
Credit Notification
Wallet Deposit
Webhook Security
Error Codes
Best Practices
Overview
Introduction
API Credentials
Signature Algorithm
Error Handling
API Modules
Repayment
POST
RP1 Create Repayment
POST
RP2 Repayment + Credit Deduction
Customers
POST
CU1-1 Create Customer
POST
CU1-3 Upload Document
POST
CU3-1 Update Official ID
POST
CU5-1 Update Address
POST
CU7-1 Update Phone
POST
CU9-1 Update Email
GET
CU10 Search Customer by Reference
GET
CU11 Get Customer Info
GET
CU13 Get Customer Offering
POST
CU14 Update Customer Name
GET
CU15 Search Customer Numbers
GET
CU16 Decrypt ID Number
GET
CU17 List Customer Cards
POST
CU18 Collect Handling Fee
POST
CU21 Consume VIAP Activation Code
GET
CU22 Get VIAP Activation Codes
Cards
POST
CA2 Adjust Credit Limit
GET
CA3 List Customer Cards
GET
CA3-1 Get Card by Card Number
POST
CA4-1 Get Card Secure Info (Encrypted)
POST
CA5 Activate Card
POST
CA5-1 Update to Shipped Status
POST
CA6N Invalidate (Terminate) Card
POST
CA7 Block Card
GET
CA8 List Card Blocks
POST
CA9 Release Card Block
GET
CA11 Query Card Profiles
POST
CA12-1 Set Card PIN (RSA)
GET
CA13-1 Get RSA Public Key for PIN
GET
CA14 Get Card Security Control
GET
CA14-1 Get Program Security Control
POST
CA15 Set Card Security Control
Data Query
GET
DT1 Query Customer Account
GET
DT5 Query Pre-created Cards
GET
DT6 Query Card Transactions
OOB Authentication
POST
OOB4 Accept/Decline Auth Request
GET
OOB5 Get Auth Request
GET
OOB6 Get Expiring Auth Requests
Webhook
POST
MC1 Credit Adjustment Status
POST
MC2 Repayment Status
POST
MC3 Authorization Notification
POST
MC4 Authorization Error
POST
MC5 OOB Auth Request
POST
MC6 VIAP Activation Code
POST
MC7 External Card Token Updated
Q&A
Integration Guide & Q&A
Enums
Enums Reference
Overview
简介
Authentication
Base URL
Common Response
Virtual Card Flow
Flow Overview
POST
Upload Document
POST
Create Holder (Virtual)
GET
Query Holder Status
POST
Apply Card (Virtual)
Physical Card Flow
Flow Overview
POST
Physical Card Entry
POST
Create Holder (Physical)
POST
Apply Card (Physical)
POST
Activate Card
Card Management
GET
Card List
POST
Card Secure Info
GET
Card Detail
GET
Transactions
POST
Top Up
POST
Withdraw
PUT
Freeze Card
PUT
Unfreeze Card
PUT
Update PIN
POST
Activation Code
Webhook
Webhook Events
Appendix
Occupation Codes
Compliance Fields
Country Codes
API Reference
/
Introduction
BankiPay
Banki HK Card
Banki US Card
EN
中文
☰