1. Partner Flow
BPN OpenAPI
  • Getting Started
    • Introduction to BPN
    • Key Concepts & Terminology
    • Architecture Overview
  • Onboarding & Prerequisites
    • Product Demo
    • Sandbox & Test Environment
    • Signature Authentication Mechanism
  • Use Case
    • Transfer
    • Vault
    • On/Off Ramp
    • Compliance (Travel Rule Information Submission)
    • Fiat Collection(BRL PIX for example)
  • API Reference
    • KYB
      • Share KYB/KYC Info For Sub User
      • Get KYB Sub User Status
    • 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
      • List Wallets
      • List Sub Account
      • Create Sub Account
      • Wallet Internal Transfer
      • Query Wallet Internal Transfer Detail
      • List Wallet Internal Transfer order
      • Get Asset Balance
      • Get Deposit Address
      • Add Deposit Sender
      • Add Withdraw Whitelist
      • Delete Withdraw Whiltelist
      • Request Withdraw
      • Query Transaction History
    • FX
      • Inquery FX Rate
    • BPN Transactions
      • Get Stablecoin Quote
      • Create Stable Order
      • Get Order (Single) Detail
      • List Orders(Batch)
    • Reconciliation
      • Get Reconciliation Order List By Page
    • Crypto Payment Link
      • Abnormal fund
        • Abnormal funds
        • Matchable Payment links
        • Link Order(Abnormal fund)
        • Submit to platform
      • Create Payment Link
      • List Payment links
      • Get Curreny Network Config
    • 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
      • Mock Virtual account Payin Order
      • Mock wallet deposit transaction
      • Mock Payin Order Refund
      • Mock Payout Order Update Status
    • Pay Session
      • Request 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
    • inquiry supported currency
      GET
    • KYC/KYB Sharing
      POST
    • inquiry onboard status
      GET
    • get price
      POST
    • Create order
      POST
    • order list
      GET
    • inquiry single order
      GET
    • get user deposit address
      GET
    • get payment instruction
      GET
    • sync fund notification
      POST
  • Appendix
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
    • Version History
  1. Partner Flow

Create order

POST
/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
Body Params application/jsonRequired

Example
{
    "partner_user_id": "string",
    "partner_order_id": "string",
    "business_type": "ON_RAMP",
    "quote_id": "string",
    "from_currency": "string",
    "to_currency": "string",
    "from_amount": "string",
    "to_amount": "string",
    "bank_account": {
        "account_holder_name": "string",
        "bank_name": "string",
        "bank_code": "string",
        "branch_code": "string",
        "account_number": "string",
        "currency": "HKD",
        "account_type": "string"
    },
    "partner_receive_address": {
        "asset": "USDT",
        "network": "TRON",
        "address": "string",
        "memo": "string",
        "address_owner_type": "string"
    },
    "travel_rule": {
        "originator_name": "string",
        "originator_customer_type": "INDIVIDUAL",
        "date_of_birth": "string",
        "residence_country": "string",
        "place_of_birth": "string",
        "registered_address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "region": "string",
            "postal_code": "string",
            "country": "string",
            "full_address": "string"
        },
        "id_type": "string",
        "id_number": "string",
        "property1": "string",
        "property2": "string"
    },
    "return_url": "string",
    "client_remark": "string"
}

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' \
--header 'X-BPN-API-KEY: <api-key>' \
--header 'X-BPN-SIGNATURE: <api-key>' \
--header 'X-BPN-TIMESTAMP: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "partner_user_id": "string",
    "partner_order_id": "string",
    "business_type": "ON_RAMP",
    "quote_id": "string",
    "from_currency": "string",
    "to_currency": "string",
    "from_amount": "string",
    "to_amount": "string",
    "bank_account": {
        "account_holder_name": "string",
        "bank_name": "string",
        "bank_code": "string",
        "branch_code": "string",
        "account_number": "string",
        "currency": "HKD",
        "account_type": "string"
    },
    "partner_receive_address": {
        "asset": "USDT",
        "network": "TRON",
        "address": "string",
        "memo": "string",
        "address_owner_type": "string"
    },
    "travel_rule": {
        "originator_name": "string",
        "originator_customer_type": "INDIVIDUAL",
        "date_of_birth": "string",
        "residence_country": "string",
        "place_of_birth": "string",
        "registered_address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "region": "string",
            "postal_code": "string",
            "country": "string",
            "full_address": "string"
        },
        "id_type": "string",
        "id_number": "string",
        "property1": "string",
        "property2": "string"
    },
    "return_url": "string",
    "client_remark": "string"
}'

Responses

🟢200
application/json
统一响应信封
Bodyapplication/json

Example
{
    "code": "SUCCESS",
    "message": "ok",
    "data": {
        "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",
        "fee_amount": "string",
        "fee_currency": "string",
        "next_action": "COMPLETE_ONBOARDING",
        "redirect_url": "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"
}
Previous
get price
Next
order list
Built with