BPN OpenAPI
  1. Crypto Payment Link
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
    • Account Management
      • Inquiry Master VA Balance
      • 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
      • 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
      • Create Payment Link
        POST
      • List Payment links
        POST
      • Get Curreny Network Config
        GET
    • Mock
      • Mock Virtual account Payin Order
  • Webhooks & Events
    • Resend Fail Webhook
      POST
    • Open Virtual Account Status
    • Virtual Account Payment Status
    • Virtual Account Invoice update
    • Transaction Status Notification
    • KYB Status Notification
    • Deposit Sender Detail Required
  • Appendix
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
    • Version History
  • Schemas
    • walletBalance
    • walletAddress
    • transactionRecord
  1. Crypto Payment Link

List Payment links

Developing
POST
/v1/stable/collect/payment-links

Request

Body Params application/jsonRequired

Example
{
    "pageNum": 1,
    "pageSize": 1,
    "paymentId": "string",
    "userOrderNo": "string",
    "recipientAccountId": "string",
    "fiatCurrency": "string",
    "cryptoCurrency": "string",
    "supportCurrency": "string",
    "supportNetwork": "string",
    "paymentLinkType": "permanent",
    "statuses": [
        "init"
    ],
    "startTime": 0,
    "endTime": 0
}

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 --request POST '/v1/stable/collect/payment-links' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pageNum": 1,
    "pageSize": 1,
    "paymentId": "string",
    "userOrderNo": "string",
    "recipientAccountId": "string",
    "fiatCurrency": "string",
    "cryptoCurrency": "string",
    "supportCurrency": "string",
    "supportNetwork": "string",
    "paymentLinkType": "permanent",
    "statuses": [
        "init"
    ],
    "startTime": 0,
    "endTime": 0
}'

Responses

🟢200Success
application/json
Body

Example
{
    "status": 0,
    "code": "string",
    "msg": "string",
    "data": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalPage": 0,
        "totalRow": 0,
        "records": [
            {
                "paymentId": "string",
                "productRemark": "string",
                "userOrderNo": "string",
                "recipientName": "string",
                "recipientAccountId": 0,
                "fiatCurrency": "string",
                "fiatAmount": "string",
                "cryptoCurrency": "string",
                "cryptoAmount": "string",
                "quotePrice": "string",
                "supportCurrency": "string",
                "supportNetwork": "string",
                "payerInfo": {
                    "payerNameUnavailable": true
                },
                "returnUrl": "http://example.com",
                "status": "init",
                "paymentLinkType": "permanent",
                "paymentValidTime": 1,
                "paymentLink": "http://example.com",
                "effectiveTime": 0,
                "expiresTime": 0,
                "createTime": 0
            }
        ]
    },
    "traceId": "string"
}
Previous
Create Payment Link
Next
Get Curreny Network Config
Built with