免费注册

开发者文档

用 RESTful API 把发卡、充值、风控与对账接进你自己的系统。下面是快速上手与核心接口参考。

概览

Faorbit API 基于 HTTPS，所有请求与响应均为 JSON。Base URL 为 https://api.faorbit.com/v1。接口遵循 REST 语义，并对写操作支持幂等键，避免重复开卡。

GEThttps://api.faorbit.com/v1/cards

鉴权

在控制台「开发者 → API 密钥」生成密钥，通过 Bearer Token 放入请求头。测试环境使用 sk_test_ 前缀，生产环境使用 sk_live_。

# 在请求头中携带密钥
curl https://api.faorbit.com/v1/cards \
  -H "Authorization: Bearer sk_live_••••"

import Faorbit from 'faorbit';
const client = new Faorbit('sk_live_••••');
const cards = await client.cards.list();

import faorbit
client = faorbit.Client("sk_live_••••")
cards = client.cards.list()

快速开始

三步即可开出第一张卡：创建密钥 → 给钱包充值 → 调用创建卡片接口。下面的请求会创建一张 USD 卡，限额 2000。

create_card.sh

curl -X POST https://api.faorbit.com/v1/cards \
  -H "Authorization: Bearer sk_live_••••" \
  -d currency="USD" \
  -d limit="2000" \
  -d label="meta-ads-07"

创建卡片

POST/v1/cards

参数	类型	说明
`currency` 必填	string	卡片币种，如 USD / EUR / HKD
`limit` 必填	integer	卡片消费限额（最小单位）
`bin`	string	指定 BIN，缺省由智能路由分配
`label`	string	卡片备注，便于对账归类

查询卡片

GET/v1/cards/{id}

返回卡片状态、余额、卡号掩码及绑定标签。

卡片充值

POST/v1/cards/{id}/topup

参数	类型	说明
`amount` 必填	integer	充值金额（最小单位）

冻结 / 注销

POST/v1/cards/{id}/freeze

DEL/v1/cards/{id}

冻结后卡片暂停交易但保留余额；注销将退回余额至钱包并永久作废卡片。

交易列表

GET/v1/transactions

支持按卡片、时间区间与状态分页查询，可用于对账与报表。

Webhook

在控制台配置回调地址后，以下事件会以 POST 推送到你的服务，并带有签名头用于校验。

事件	触发时机
`card.created`	卡片创建成功
`transaction.authorized`	一笔交易被授权
`transaction.declined`	一笔交易被拒付
`transaction.refunded`	发生退款
`card.frozen`	卡片被冻结

官方 SDK

使用官方 SDK 可以省去签名与重试逻辑，开箱即用。

Node.js

npm i faorbit

Python

pip install faorbit

Go

go get faorbit-go

PHP

composer require faorbit/sdk