- Getting Started
- Onboarding & Prerequisites
- Use Case
- API Reference
- KYB
- Account Management
- Inquiry Master VA Balance
- List Primary Virtual Accounts
- Create Virtaul Account
- Get Virtual Account Detail
- List Virtual Account
- Send Email Verify Code
- Query bank info by account number
- Payout via Virtual Account
- Refund Virtual Account Order
- Get Virtual Account Order Detail
- List Virtual Account Orders
- Submit Invoice
- Get Invoice list Status
- List Banks
- Add Bank Account
- List Bank Account
- List RFI Sub Virtual Account
- Get Sub Virtual Account RFI Template Info
- Sub Virtual Account Submit RFI
- Wallet
- FX
- BPN Transactions
- Reconciliation
- Crypto Payment Link
- External Provider
- FE: Create stablecoin collection sub-account link
- Create stablecoin collection sub-account link
- Get sub wallet account
- List sub wallet accounts
- Change sub wallet status
- Query stablecoin collection order list
- Query stablecoin collection order status
- Get quote
- Accept stablecoin collection order
- Reject stablecoin collection order
- Query USD balance
- USD Payout (withdrawal)
- Query USD Payout order status
- Query USD Payout order list
- Mock
- Pay Session
- Webhooks & Events
- Resend Fail Webhook
- Open Virtual Account Status
- Virtual Account Payment Status
- Virtual Account Invoice update
- Transaction Status Notification
- KYB Status Notification
- Deposit Sender Detail Required
- Abnormal Fund Notification
- WALLET_TRANSFER_ORDER_UPDATED
- Sub Virtual Account RFI Required
- Sub Wallet Update
- wallet address whitelist Copy
- Crypto Deposit Order Notification
- Collect Order Updated
- Usd Payout Order Updated
- onboard result
- partner order status
- Partner Flow
- Appendix
- Release Notes & Changelog
order list
GET
/api/v1/orders
Request
Authorization
API Key
Add parameter in header
X-BPN-API-KEY
Example:
X-BPN-API-KEY: ********************API Key
Add parameter in header
X-BPN-SIGNATURE
Example:
X-BPN-SIGNATURE: ********************API Key
Add parameter in header
X-BPN-TIMESTAMP
Example:
X-BPN-TIMESTAMP: ********************or
Query Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/orders?partner_user_id=undefined&bpn_user_id=undefined&order_status=undefined&business_type=undefined&start_time=undefined&end_time=undefined&page=undefined&page_size=undefined' \
--header 'X-BPN-API-KEY: <api-key>' \
--header 'X-BPN-SIGNATURE: <api-key>' \
--header 'X-BPN-TIMESTAMP: <api-key>'Responses
🟢200
application/json
Bodyapplication/json
Example
{
"code": "SUCCESS",
"message": "ok",
"data": {
"total": 0,
"page": 0,
"page_size": 0,
"list": [
{
"bpn_order_id": "string",
"partner_order_id": "string",
"partner_user_id": "string",
"bpn_user_id": "string",
"business_type": "ON_RAMP",
"order_status": "CREATED",
"quote_id": "string",
"from_currency": "string",
"to_currency": "string",
"from_amount": "string",
"to_amount": "string",
"rate": "string",
"fee_amount": "string",
"fee_currency": "string",
"next_action": "COMPLETE_ONBOARDING",
"deposit_address": {
"asset": "USDT",
"network": "TRON",
"address": "string",
"memo": "string",
"address_owner_type": "string"
},
"payment_instruction": {
"instruction_type": "USER_FIXED_VA",
"instruction_status": "ACTIVE",
"currency": "string",
"amount": "string",
"account_scope": "string",
"bank_name": "string",
"bank_code": "string",
"branch_code": "string",
"account_name": "string",
"account_number": "string",
"iban": "string",
"swift_code": "string",
"sort_code": "string",
"reference": "string",
"qr_code_content": "string",
"qr_code_base64": "string",
"redirect_url": "string",
"display_instructions": [
"string"
],
"expires_at": "2019-08-24T14:15:22.123Z"
},
"va_account": {
"property1": "string",
"property2": "string"
},
"channel_settlement_address": {
"asset": "USDT",
"network": "TRON",
"address": "string",
"memo": "string",
"address_owner_type": "string"
},
"redirect_url": "string",
"return_url": "string",
"payout": {
"property1": "string",
"property2": "string"
},
"delivery": {
"property1": "string",
"property2": "string"
},
"fail_code": "string",
"fail_reason": "string",
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z",
"expires_at": "2019-08-24T14:15:22.123Z"
}
]
},
"trace_id": "b7c1f0c2-3f0a-4e9b-9c2a-2b1d9d6f0a11"
}