卡片管理

卡片相关接口

获取商户可申请的卡片列表

get

获取商户可以申请的卡片列表。此接口只返回支持 API 对接的卡片（can_apply = 1），返回的卡片信息不包含用户相关的状态信息（如申请状态、绑定状态等）。

功能说明

支持按卡名关键字搜索
支持多种筛选条件（KYC要求、支付方式、费用类型等）
支持按评分排序（综合评分、福利评分、隐私评分）
无需登录验证（但建议使用 Token 以获取更好的服务）

Authorizations

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

/thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
其他所有接口都需要在请求头中携带 Authorization header
Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Query parameters

keywordstringOptional

卡名关键字搜索

Example: Bitcoin

sort_typestring · enumOptional

排序类型

Default: generalExample: generalPossible values:

sort_directionstring · enumOptional

排序方向

Default: descExample: descPossible values:

filtersstringOptional

筛选条件（JSON 字符串）

Example: {"kyc_required": 0}

no_kycbooleanOptional

筛选不需要 KYC 的卡片

Example: true

kyc_requiredbooleanOptional

筛选需要 KYC 的卡片

Example: false

google_paybooleanOptional

筛选支持 Google Pay 的卡片

Example: true

apple_paybooleanOptional

筛选支持 Apple Pay 的卡片

Example: true

wechatbooleanOptional

筛选支持微信支付的卡片

Example: true

alipaybooleanOptional

筛选支持支付宝的卡片

Example: true

chatgptbooleanOptional

筛选支持 ChatGPT 支付的卡片

Example: false

no_annualfeebooleanOptional

筛选无年费的卡片

Example: true

no_issuancefeebooleanOptional

筛选无开卡费的卡片

Example: true

no_monthlyfeebooleanOptional

筛选无月费的卡片

Example: true

no_transactionfeebooleanOptional

筛选无交易费的卡片

Example: true

no_atmfeebooleanOptional

筛选无 ATM 费的卡片

Example: true

Responses

200

获取成功

application/json

400

请求参数错误

application/json

401

未授权（Token 无效或过期）

application/json

500

服务器内部错误

application/json

get

/merchant/cards

GET /v1/api/merchant/cards HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": [
    {
      "id": 1,
      "card_name": "Bitcoin Card",
      "vendor": "BitPay",
      "card_type": "Virtual",
      "kyc_required": 0,
      "based_crypto": "BTC",
      "cashback": "2%",
      "fees": "{\"annualFee\": {\"value\": 0}, \"issuanceFee\": {\"value\": 0}}",
      "spending_limits": "{\"daily\": 10000, \"monthly\": 100000}",
      "google_pay_support": 1,
      "apple_wallet_support": 1,
      "wechat_pay_support": 0,
      "alipay_support": 0,
      "chatgpt_pay_support": 0,
      "summary": "支持比特币的虚拟卡片",
      "intro": "详细的卡片介绍信息",
      "application_url": "https://example.com/apply",
      "card_image_large": "https://example.com/images/card_large.jpg",
      "vendor_logo": "https://example.com/images/vendor_logo.png",
      "card_image_thumbnail": "https://example.com/images/card_thumb.jpg",
      "general_ratings": 4.5,
      "benefit_ratings": 4,
      "privacy_ratings": 4.8
    }
  ]
}

获取发卡商支持的卡片类型

get

获取指定发卡商支持的卡片类型配置信息。

功能说明

返回指定卡片ID（card_id）对应的发卡商支持的所有卡片类型
每个卡片类型包含：卡片BIN号、支持的国家、支持的币种、费用信息、限额信息等
用于开卡时选择卡片类型和配置

使用场景

在开卡前查询可用的卡片类型
获取卡片类型的详细配置信息（费用、限额、支持的国家和币种等）
根据用户需求选择合适的卡片类型

注意事项

card_id 参数可选，默认为 "23"（Bit2Go）
不同环境（测试/生产）可能返回不同的配置

Authorizations

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

/thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
其他所有接口都需要在请求头中携带 Authorization header
Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Query parameters

card_idstringOptional

卡片ID（可选，默认"23"）

Default: 23Example: 23

Responses

200

查询成功

application/json

400

请求参数错误

application/json

401

未授权

application/json

500

服务器内部错误

application/json

get

/cards/getCardbinSettings

GET /v1/api/cards/getCardbinSettings HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": [
    {
      "id": 112,
      "holder_config": {
        "flag": 1,
        "country": [
          "HKG"
        ],
        "billInfoFlag": 0,
        "nativeNameFlag": 0
      },
      "can_diy_date": "1",
      "days_range": "699",
      "min_days": "32",
      "ends_of_month": true,
      "phone_prefix_limit": false,
      "phone_prefix_range": [],
      "phone_prefix_country_range": [],
      "card_fee": {
        "transaction_fee": 0.5,
        "active_fee": 10,
        "transfer_in_fee": {
          "rate": 0,
          "fixed_fee": 0
        },
        "apple_pay_fee": 0.5,
        "fee_currency": "USD"
      },
      "card_limit": {
        "txn_max_amount": 10000,
        "daily_max_amount": 50000,
        "currency": "USD"
      },
      "card_bin": "525847",
      "country": "HKG",
      "currency": [
        "USD",
        "SGD",
        "HKD",
        "MYR",
        "THB",
        "JPY",
        "CAD",
        "AUD",
        "IDR",
        "NZD",
        "GBP",
        "EUR"
      ],
      "usage_times": "1",
      "organization": "mastercard",
      "fee_currency": "USD"
    }
  ]
}

申请前判断卡片是否可以申请

post

检查指定卡片是否可以申请，返回申请条件和状态信息。

功能说明

检查卡片是否支持 API 对接（can_apply 状态）
检查是否有可绑定的卡片
检查商户余额是否充足（如果没有可绑定卡片）
返回申请金额、活跃卡片数量等信息

使用场景

在用户申请卡片前，先检查卡片是否可以申请
根据返回的信息决定是否允许用户申请
获取申请所需的最低金额

返回字段说明

can_apply: 卡片是否支持 API 对接（0-不支持，1-支持）
can_bind_card: 是否可以绑卡（综合考虑可绑定卡片和商户余额）
has_bindable_cards: 是否有可绑定的卡片
bindable_cards_count: 可绑定卡片数量
card_binding_id: 如果有可绑定卡片，返回第一张卡片的绑定ID
apply_amount: 申请所需的最低金额
active_card_count: 用户已申请的该类型卡片数量

Authorizations

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

/thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
其他所有接口都需要在请求头中携带 Authorization header
Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Body

card_idstringRequired

卡片ID（PayAll卡片ID）

Example: 39

Responses

200

查询成功

application/json

400

请求参数错误

application/json

401

未授权

application/json

404

卡片不存在

application/json

500

服务器内部错误

application/json

post

/cards/checkCanApply

POST /v1/api/cards/checkCanApply HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "card_id": "39"
}

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": {
    "card_id": "39",
    "can_apply": 1,
    "card_name": "PayAll Crypto Card",
    "is_bound": false,
    "card_binding_id": 12345,
    "has_bindable_cards": true,
    "bindable_cards_count": 5,
    "can_bind_card": true,
    "open_card_address": {},
    "apply_amount": "30",
    "can_use_qrcode_charge": true,
    "active_card_count": 2
  }
}

申请卡片

post

申请/绑定卡片接口，用于用户申请新的卡片。

功能说明

用户通过此接口申请新的卡片
如果卡片支持 API 对接（can_apply = 1），会直接绑定卡片并返回卡片信息
如果卡片不支持 API 对接（can_apply = 0），会创建待确认的绑定记录

使用场景

用户在开卡前需要先申请卡片
申请成功后，卡片会被绑定到用户账户

注意事项

申请前建议先调用 /cards/checkCanApply 接口检查卡片是否可以申请
申请成功后，可以通过 /cards/getCardDetail 接口获取卡片详细信息

Authorizations

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

/thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
其他所有接口都需要在请求头中携带 Authorization header
Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Body

card_idstringRequired

卡片ID（PayAll卡片ID）

Example: 39

Responses

200

申请成功

application/json

400

请求参数错误

application/json

401

未授权

application/json

500

服务器内部错误

application/json

post

/cards/binding

POST /v1/api/cards/binding HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "card_id": "39"
}

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": {
    "card_number": "4111111111111111",
    "brand": "Master",
    "currency": "USD",
    "nickname": "My Card",
    "issuer_name": "PayAll",
    "binding_time": "2024-10-25T10:30:00",
    "status": "active",
    "binding_status": "active"
  }
}

查询开卡和充值汇率

post

查询开卡和充值相关的汇率及手续费信息。

功能说明

开卡汇率 (charge_type: OPEN_CARD): 查询开卡所需的手续费和汇率信息
卡片余额充值汇率 (charge_type: CARD_CHARGE): 查询卡片余额充值的手续费和汇率信息
卡片提现汇率 (charge_type: CARD_WITHDRAW): 查询卡片提现的手续费和汇率信息

使用场景

在用户进行开卡或充值操作前，可以先调用此接口查询相关费用和汇率
不同卡片（card_id）可能使用不同的费率计算方式
card_id=39 (MiPay) 使用统一的费率管理
其他卡片使用 Bit2Go 的费率计算

注意事项

卡片余额充值和提现场景必须提供 card_bin 参数
充值场景建议提供 amount 参数以获取准确的费率计算

Authorizations

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

/thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
其他所有接口都需要在请求头中携带 Authorization header
Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Body

charge_typestring · enumRequired

充值类型

Example: OPEN_CARDPossible values:

card_binstringOptional

卡片BIN号（卡片余额充值和提现时必填）

Example: 411111

amountstringOptional

金额（充值场景建议提供，用于计算准确的费率）

Example: 100

chainstringOptional

链名称（可选，默认BSC）

Example: BSC

card_idstringOptional

卡片ID（可选，默认"23"）

Example: 39

Responses

200

查询成功

application/json

400

请求参数错误

application/json

401

未授权

application/json

500

服务器内部错误

application/json

post

/cards/feeQuote

POST /v1/api/cards/feeQuote HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "charge_type": "OPEN_CARD",
  "card_id": "39"
}

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": {
    "fee_info": {
      "fee": 10,
      "open_card_fee": 10,
      "recharge_fee": 0.018,
      "fee_currency": "USDT",
      "wallet_amount": 30,
      "wallet_currency": "USDT",
      "card_amount": 20,
      "card_currency": "USD",
      "conversion_steps": [
        {
          "from_currency": "USDT",
          "to_currency": "USD",
          "rate": "1"
        }
      ]
    }
  }
}

预开卡充值

post

预开卡充值接口，用于开卡或卡片余额充值的预充值操作。

功能说明

开卡充值 (charge_type: OPEN_CARD): 用于新卡开卡时的充值
- 开卡时通常没有 card_binding_id，需要提供 card_issue_info 用于开卡
- card_binding_id 在开卡场景下为可选参数
卡片余额充值 (charge_type: CARD_CHARGE): 用于已绑定卡片的余额充值
- 必须提供 card_binding_id

使用流程

调用此接口进行预充值，获取 order_id
调用 /charge/getChargeQrCode 获取充值地址和二维码
用户向充值地址转账
系统自动处理充值并回调商户

Authorizations

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

/thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
其他所有接口都需要在请求头中携带 Authorization header
Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Body

charge_typestring · enumRequired

充值类型

Example: OPEN_CARDPossible values:

card_idstringRequired

卡片ID

Example: 39

card_binding_idstringOptional

卡片绑定ID（开卡时不需要传入，卡片余额充值时必填）

Example: 12345

Responses

200

预充值成功

application/json

400

请求参数错误

application/json

401

未授权

application/json

500

服务器内部错误

application/json

post

/charge/preCharge

POST /v1/api/charge/preCharge HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "charge_type": "OPEN_CARD",
  "card_id": "39",
  "card_issue_info": {
    "card_bin": "411111",
    "expiry_date": "2025-12",
    "card_holder_info": {
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "phone": "1234567890",
      "phone_prefix": "+1"
    }
  }
}

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": {
    "order_id": "open_card_12345_39_abc123"
  }
}

获取充值地址和二维码

post

获取充值地址和二维码接口，用于开卡充值或卡片余额充值。

功能说明

必须先调用 /charge/preCharge 接口进行预充值
返回充值地址、最小充值金额、过期时间和二维码（Base64编码）
币种代码（coin_code）需要传入 USDT 相关的币种（如 USDT_TRC20, USDT_ERC20, USDT_BSC 等）

使用流程

调用 /charge/preCharge 进行预充值
调用此接口获取充值地址和二维码
用户向充值地址转账（金额需大于等于最小充值金额）
系统自动处理充值并回调商户

Authorizations

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

/thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
其他所有接口都需要在请求头中携带 Authorization header
Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Body

coin_codestringRequired

币种代码，需要传入 USDT 相关的币种（如 USDT_TRC20, USDT_ERC20, USDT_BSC 等）

Example: USDT_TRC20

chainstringRequired

链名称（如 TRON, ETHEREUM, BSC 等）

Example: TRON

charge_typestring · enumRequired

充值类型

Example: OPEN_CARDPossible values:

card_idstringRequired

卡片ID

Example: 39

card_binding_idstringOptional

卡片绑定ID（卡片余额充值时必填，开卡时不需要传入）

Example: 12345

Responses

200

获取成功

application/json

400

请求参数错误

application/json

401

未授权

application/json

500

服务器内部错误

application/json

post

/charge/getChargeQrCode

POST /v1/api/charge/getChargeQrCode HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "coin_code": "USDT_TRC20",
  "chain": "TRON",
  "charge_type": "OPEN_CARD",
  "card_id": "39"
}

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": {
    "deposit_address": "TXYZabcdefghijklmnopqrstuvwxyz123456",
    "min_depositAmt": "10.5",
    "expired_time": "2024-12-25 10:30:00",
    "qr_code": "iVBORw0KGgoAAAANSUhEUgAA..."
  }
}

上传交易Hash（插件钱包转账开卡）

post

上传交易Hash接口，用于插件钱包转账开卡场景。

功能说明

当用户通过插件钱包（如MetaMask、Trust Wallet等）进行转账开卡时，需要调用此接口上传交易Hash
系统会记录该交易信息，用于后续的开卡处理
上传成功后，可以通过 /cards/getTransactionByHash 接口查询开卡状态

使用场景

用户通过插件钱包向充值地址转账后，需要上传交易Hash
适用于开卡场景，需要提供完整的交易信息

注意事项

必须提供 transaction_hash、card_id、chain、amount、from_address、to_address 等必填参数
card_binding_id 在开卡场景下通常为空

Authorizations

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

/thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
其他所有接口都需要在请求头中携带 Authorization header
Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Body

transaction_hashstringRequired

交易哈希（必填）

Example: 0x1234567890abcdef...

card_idstringRequired

关联的卡片ID（必填）

Example: 39

card_binding_idstringOptional

卡片绑定ID（开卡时通常为空）

chainstringRequired

区块链ID（必填，如 TRON, ETHEREUM, BSC 等）

Example: TRON

token_addressstringOptional

代币合约地址（可选，原生币为null）

token_symbolstringOptional

代币符号（可选）

Example: USDT

token_namestringOptional

代币名称（可选）

Example: Tether USD

token_decimalsintegerOptional

代币精度（可选，默认18）

Example: 18

amountstringRequired

转账金额（必填，原始金额字符串）

Example: 1000000000000000000

amount_displaystringOptional

显示金额（可选，用户友好的显示金额）

Example: 1.0

from_addressstringRequired

发送方地址（必填）

Example: 0x1234567890abcdef...

to_addressstringRequired

接收方地址（必填，充值地址）

Example: TXYZabcdefghijklmnopqrstuvwxyz123456

transaction_statusstring · enumOptional

交易状态（可选，默认pending）

Example: pendingPossible values:

block_numberintegerOptional

区块号（可选）

Example: 12345678

block_hashstringOptional

区块哈希（可选）

Example: 0xabcdef...

gas_usedstringOptional

实际消耗的Gas（可选）

Example: 21000

gas_pricestringOptional

Gas价格（可选）

Example: 20000000000

gas_feestringOptional

Gas费用（可选）

Example: 0.00042

transaction_feestringOptional

交易费用（可选）

Example: 0.00042

confirmation_countintegerOptional

确认数（可选，默认0）

Example: 0

transaction_typestringOptional

交易类型（可选，默认transfer）

Example: deposit

descriptionstringOptional

交易描述（可选）

Example: Open card transaction

transaction_timeintegerOptional

交易时间戳（可选）

Example: 1698203395

Responses

200

上传成功

application/json

400

请求参数错误

application/json

401

未授权

application/json

500

服务器内部错误

application/json

post

/cards/uploadTransaction

POST /v1/api/cards/uploadTransaction HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 396

{
  "transaction_hash": "0x1234567890abcdef...",
  "card_id": "39",
  "card_binding_id": null,
  "chain": "TRON",
  "token_address": null,
  "token_symbol": "USDT",
  "token_name": "Tether USD",
  "token_decimals": 18,
  "amount": "30000000",
  "amount_display": "30.0",
  "from_address": "TXYZabcdefghijklmnopqrstuvwxyz123456",
  "to_address": "TXYZabcdefghijklmnopqrstuvwxyz123456",
  "transaction_status": "pending",
  "transaction_type": "deposit"
}

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": {
    "transaction_id": 12345,
    "message": "Open card transaction uploaded successfully"
  }
}

根据交易Hash获取开卡状态

post

根据交易Hash获取开卡状态接口，用于查询插件钱包转账开卡的处理状态。

功能说明

通过交易Hash查询开卡交易的处理状态
返回完整的交易信息，包括交易状态、区块信息、Gas信息等
如果交易已处理（processed.status = 1），还会返回卡片信息

使用场景

用户上传交易Hash后，可以定期调用此接口查询开卡状态
用于轮询查询开卡是否成功

交易状态说明

pending: 交易待处理
success: 交易成功
failed: 交易失败

处理状态说明

processed.status = 0: 交易未处理
processed.status = 1: 交易已处理（开卡成功）

Authorizations

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

/thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
其他所有接口都需要在请求头中携带 Authorization header
Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Body

transaction_hashstringRequired

交易哈希（必填）

Example: 0x1234567890abcdef...

Responses

200

查询成功

application/json

400

请求参数错误

application/json

401

未授权

application/json

404

交易不存在

application/json

500

服务器内部错误

application/json

post

/cards/getTransactionByHash

POST /v1/api/cards/getTransactionByHash HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "transaction_hash": "0x1234567890abcdef..."
}

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": {
    "id": 12345,
    "transaction_hash": "0x1234567890abcdef...",
    "transaction_hash_url": "https://tronscan.org/#/transaction/0x1234567890abcdef...",
    "user_id": 123,
    "card_id": "39",
    "card_binding_id": null,
    "chain": "TRON",
    "token_info": {
      "address": null,
      "symbol": "USDT",
      "name": "Tether USD",
      "decimals": 18
    },
    "amount": {
      "raw": "30000000",
      "display": "30.0"
    },
    "addresses": {
      "from": "TXYZabcdefghijklmnopqrstuvwxyz123456",
      "to": "TXYZabcdefghijklmnopqrstuvwxyz123456"
    },
    "status": "success",
    "block_info": {
      "number": 12345678,
      "hash": "0xabcdef...",
      "confirmation_count": 12
    },
    "gas_info": {
      "used": "21000",
      "price": "20000000000",
      "fee": "0.00042",
      "transaction_fee": "0.00042"
    },
    "transaction_type": "deposit",
    "description": "Open card transaction",
    "timestamps": {
      "created_at": "2024-10-25T10:30:00",
      "updated_at": "2024-10-25T10:35:00",
      "transaction_time": 1698203395
    },
    "processed": {
      "status": 1,
      "processed_at": "2024-10-25T10:35:00"
    },
    "card_info": {
      "card_number": "4111111111111111",
      "brand": "Visa",
      "currency": "USD",
      "nickname": "My Card",
      "issuer_name": "PayAll",
      "binding_time": "2024-10-25T10:35:00",
      "status": "active",
      "binding_status": "active",
      "card_balance": "20.0"
    }
  }
}

上传交易Hash（插件钱包转账充值）

post

上传交易Hash接口，用于插件钱包转账充值场景。

功能说明

当用户通过插件钱包（如MetaMask、Trust Wallet等）进行转账充值时，需要调用此接口上传交易Hash
系统会记录该交易信息，用于后续的充值处理
上传成功后，可以通过 /wallet/getTransactionByHash 接口查询充值状态

使用场景

用户通过插件钱包向充值地址转账后，需要上传交易Hash
适用于卡片余额充值场景，需要提供 card_binding_id

注意事项

必须提供 transaction_hash、card_id、card_binding_id、chain、amount、from_address、to_address 等必填参数
card_binding_id 在充值场景下为必填参数

Authorizations

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

/thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
其他所有接口都需要在请求头中携带 Authorization header
Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Body

transaction_hashstringRequired

交易哈希（必填）

Example: 0x1234567890abcdef...

card_idstringRequired

关联的卡片ID（必填）

Example: 39

card_binding_idstringRequired

卡片绑定ID（必填）

Example: 12345

chainstringRequired

区块链ID（必填，如 TRON, ETHEREUM, BSC 等）

Example: TRON

token_addressstringOptional

代币合约地址（可选，原生币为null）

token_symbolstringOptional

代币符号（可选）

Example: USDT

token_namestringOptional

代币名称（可选）

Example: Tether USD

token_decimalsintegerOptional

代币精度（可选，默认18）

Example: 18

amountstringRequired

转账金额（必填，原始金额字符串）

Example: 1000000000000000000

amount_displaystringOptional

显示金额（可选，用户友好的显示金额）

Example: 100.0

from_addressstringRequired

发送方地址（必填）

Example: 0x1234567890abcdef...

to_addressstringRequired

接收方地址（必填，充值地址）

Example: TXYZabcdefghijklmnopqrstuvwxyz123456

transaction_statusstring · enumOptional

交易状态（可选，默认pending）

Example: pendingPossible values:

block_numberintegerOptional

区块号（可选）

Example: 12345678

block_hashstringOptional

区块哈希（可选）

Example: 0xabcdef...

gas_usedstringOptional

实际消耗的Gas（可选）

Example: 21000

gas_pricestringOptional

Gas价格（可选）

Example: 20000000000

gas_feestringOptional

Gas费用（可选）

Example: 0.00042

transaction_feestringOptional

交易费用（可选）

Example: 0.00042

confirmation_countintegerOptional

确认数（可选，默认0）

Example: 0

transaction_typestringOptional

交易类型（可选，默认transfer）

Example: deposit

descriptionstringOptional

交易描述（可选）

Example: Card recharge transaction

transaction_timeintegerOptional

交易时间戳（可选）

Example: 1698203395

Responses

200

上传成功

application/json

400

请求参数错误

application/json

401

未授权

application/json

500

服务器内部错误

application/json

post

/wallet/uploadTransaction

POST /v1/api/wallet/uploadTransaction HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 401

{
  "transaction_hash": "0x1234567890abcdef...",
  "card_id": "39",
  "card_binding_id": "12345",
  "chain": "TRON",
  "token_address": null,
  "token_symbol": "USDT",
  "token_name": "Tether USD",
  "token_decimals": 18,
  "amount": "100000000",
  "amount_display": "100.0",
  "from_address": "TXYZabcdefghijklmnopqrstuvwxyz123456",
  "to_address": "TXYZabcdefghijklmnopqrstuvwxyz123456",
  "transaction_status": "pending",
  "transaction_type": "deposit"
}

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": {
    "transaction_id": 12345,
    "message": "Wallet transaction uploaded successfully"
  }
}

根据交易Hash获取充值状态

post

根据交易Hash获取充值状态接口，用于查询插件钱包转账充值的处理状态。

功能说明

通过交易Hash查询充值交易的处理状态
返回完整的交易信息，包括交易状态、区块信息、Gas信息等
用于轮询查询充值是否成功

使用场景

用户上传交易Hash后，可以定期调用此接口查询充值状态
用于轮询查询充值是否成功

交易状态说明

pending: 交易待处理
success: 交易成功
failed: 交易失败

处理状态说明

processed.status = 0: 交易未处理
processed.status = 1: 交易已处理（充值成功）

Authorizations

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

/thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
其他所有接口都需要在请求头中携带 Authorization header
Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Body

transaction_hashstringRequired

交易哈希（必填）

Example: 0x1234567890abcdef...

Responses

200

查询成功

application/json

400

请求参数错误

application/json

401

未授权

application/json

404

交易不存在

application/json

500

服务器内部错误

application/json

post

/wallet/getTransactionByHash

POST /v1/api/wallet/getTransactionByHash HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "transaction_hash": "0x1234567890abcdef..."
}

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": {
    "id": 12345,
    "transaction_hash": "0x1234567890abcdef...",
    "transaction_hash_url": "https://tronscan.org/#/transaction/0x1234567890abcdef...",
    "user_id": 123,
    "card_id": "39",
    "card_binding_id": 12345,
    "chain": "TRON",
    "token_info": {
      "address": null,
      "symbol": "USDT",
      "name": "Tether USD",
      "decimals": 18
    },
    "amount": {
      "raw": "100000000",
      "display": "100.0"
    },
    "addresses": {
      "from": "TXYZabcdefghijklmnopqrstuvwxyz123456",
      "to": "TXYZabcdefghijklmnopqrstuvwxyz123456"
    },
    "status": "success",
    "block_info": {
      "number": 12345678,
      "hash": "0xabcdef...",
      "confirmation_count": 12
    },
    "gas_info": {
      "used": "21000",
      "price": "20000000000",
      "fee": "0.00042",
      "transaction_fee": "0.00042"
    },
    "transaction_type": "deposit",
    "description": "Card recharge transaction",
    "timestamps": {
      "created_at": "2024-10-25T10:30:00",
      "updated_at": "2024-10-25T10:35:00",
      "transaction_time": 1698203395
    },
    "processed": {
      "status": 1,
      "processed_at": "2024-10-25T10:35:00"
    }
  }
}

Previous第三方接入 Next交易管理

Last updated 1 minute ago

Good night

hashtag获取商户可申请的卡片列表

hashtag功能说明

hashtag获取发卡商支持的卡片类型

hashtag功能说明

hashtag使用场景

hashtag注意事项

hashtag申请前判断卡片是否可以申请

hashtag功能说明

hashtag使用场景

hashtag返回字段说明

hashtag申请卡片

hashtag功能说明

hashtag使用场景

hashtag注意事项

hashtag查询开卡和充值汇率

hashtag功能说明

hashtag使用场景

hashtag注意事项

hashtag预开卡充值

hashtag功能说明

hashtag使用流程

hashtag获取充值地址和二维码

hashtag功能说明

hashtag使用流程

hashtag上传交易Hash（插件钱包转账开卡）

hashtag功能说明

hashtag使用场景

hashtag注意事项

hashtag根据交易Hash获取开卡状态

hashtag功能说明

hashtag使用场景

hashtag交易状态说明

hashtag处理状态说明

hashtag上传交易Hash（插件钱包转账充值）

hashtag功能说明

hashtag使用场景

hashtag注意事项

hashtag根据交易Hash获取充值状态

hashtag功能说明

hashtag使用场景

hashtag交易状态说明

hashtag处理状态说明

获取商户可申请的卡片列表

功能说明

获取发卡商支持的卡片类型

功能说明

使用场景

注意事项

申请前判断卡片是否可以申请

功能说明

使用场景

返回字段说明

申请卡片

功能说明

使用场景

注意事项

查询开卡和充值汇率

功能说明

使用场景

注意事项

预开卡充值

功能说明

使用流程

获取充值地址和二维码

功能说明

使用流程

上传交易Hash（插件钱包转账开卡）

功能说明

使用场景

注意事项

根据交易Hash获取开卡状态

功能说明

使用场景

交易状态说明

处理状态说明

上传交易Hash（插件钱包转账充值）

功能说明

使用场景

注意事项

根据交易Hash获取充值状态

功能说明

使用场景

交易状态说明

处理状态说明