Logo
Section 1 / 3

通用账户余额

了解通用账户(GPAs)及其余额,以及如何获取它们。

导入

通用账户余额

了解通用账户(GPAs)及其余额,以及如何获取它们。

通用账户(GPA) 是用户的默认账户。资金会从资金来源转入用户的 GPA。

GPA 余额类型

我们来看一下用户或企业可用的不同类型的 GPA 余额:

  • 在标准资金模式下,账面余额 指的是可使用的资金总额,包括已授权但尚未清算的交易金额。
    关于 即时资金(JIT):即时资金允许在交易发生时,自动将项目资金来源中的资金划转至相应账户。在此模式下,该余额指的是已授权但尚未清算、目前处于冻结状态的资金。

  • 可用余额 指的是用户的消费能力。它是从账面余额中扣除尚未清算的已授权交易后得出的金额。若用户使用 JIT 资金,则此余额为 0.00。

  • 待处理贷方 指的是已接受但仍在等待清算的 ACH 交易。
    ACH 是美国银行网络使用的支付系统,每日在指定时间将交易提交至清算网络进行处理。

  • 缓存余额 和 信用余额 当前未被使用。

获取 GPA 余额

可以通过向 {BASE_URL}/balances/{token} 端点发送 GET 请求来获取用户或企业的所有 GPA 余额。路径参数 {token} 表示要查询其 GPA 余额的用户或企业的令牌。该端点还会在响应中提供指向指定用户或企业 GPA 余额的链接。

请求参数

此端点仅需一个请求参数,具体如下:

参数类型必填描述
token字符串是要查询其 GPA 余额的用户或企业的令牌。注意:这是路径参数。

点击下方代码框中的“运行”按钮查看输出结果。

1// 导入所需库 2import fetch from "node-fetch" 3 4const tokens = '{{APPLICATION_TOKEN}}:{{ADMIN_ACCESS_TOKEN}}' 5const encoded = Buffer.from(tokens, 'ascii').toString('base64') 6 7const userToken = '{{USER_TOKEN}}' 8 9// 定义端点 URL 10const endpointUrl = new URL(`{{BASE_URL}}balances/${userToken}`); 11 12const headerParameters = { 13 'Content-Type': 'application/json', 14 'Authorization': `Basic ${encoded}` 15}; 16 17// 设置 API 调用选项 18const options = { 19 method: "GET", 20 headers: headerParameters 21}; 22 23// 发起 API 调用的函数 24async function getGpaBalance() { 25 try { 26 const response = await fetch(endpointUrl, options); 27 // 输出响应内容 28 printResponse(response); 29 } catch (error) { 30 // 输出错误信息 31 printError(error); 32 } 33} 34 35// 调用函数发起请求 36getGpaBalance();

在上述代码中:

  • 第 10 行:将端点 URL 定义在 endpointUrl 变量中。
  • 第 19 行:将请求方法设置为 GET,用于获取用户或企业的 GPA 余额。
  • 第 26 行:使用 fetch 函数发起 API 请求。

响应字段

当代码成功执行后,输出将显示与给定 token 对应的用户或企业的全部 GPA 余额,并附带相关链接。若请求失败,则显示相应的错误信息。

该端点返回 gpa 和 links 对象。gpa 对象的字段说明如下:

字段名类型描述
gpa.currency_code字符串三位货币代码(ISO 4217 标准)
gpa.ledger_balance十进制数使用标准资金时,表示尚未清算的已授权交易金额及可立即使用的资金;使用即时资金时,表示当前处于冻结状态但尚未清算的资金。格式:0.00
gpa.available_balance十进制数账面余额减去尚未清算的已授权交易金额,也称为持卡人的消费能力。格式:0.00
gpa.pending_credits十进制数表示已批准但尚未到达资金到账时间的 ACH 入账金额。格式:0.00
gpa.balances对象包含按货币代码组织的 GPA 余额信息

附录

GPA 订单