跳到主要内容

交易列表

Transactions

返回商户账户的交易分页列表，按最近更新时间排序。你可以通过查询参数进行筛选、排序和搜索。

GEThttps://api.efundpay.com/v4/transactions
This endpoint requires the transactions.read scope.

Authorizations

Authorizationstringheaderrequired

认证请求头，格式为 `Bearer <token>`，`<token>` 为您的认证令牌。

Headers

x-merchant-account-idstring | null

此请求要使用的商户账户ID。

Examples:"default"

Query Parameters

cursorinteger

页码。

Examples:"0"
limitinteger

每页返回的最大条目数。

Default:20
Range:1 <= x <= 100
Examples:"20"
created_at_ltestring | null

返回在此日期时间之前创建的交易。时间需包含时区，需进行 URL 编码，例如 `2022-01-01T12:00:00+08:00` 编码为 `2022-01-01T12%3A00%3A00%2B08%3A00`。

Examples:"2022-01-01T12:00:00+08:00"
created_at_gtestring | null

返回在此日期时间之后创建的交易。时间需包含时区，需进行 URL 编码，例如 `2022-01-01T12:00:00+08:00` 编码为 `2022-01-01T12%3A00%3A00%2B08%3A00`。

Examples:"2022-01-01T12:00:00+08:00"
statusenum<string>[] | null

筛选返回状态匹配的交易。各状态含义详见 交易状态。

Examples:"authorization_succeeded"
idstring | null

筛选指定EFundFlow id 的交易。

Examples:"7099948d-7286-47e4-aad8-b68f7eb44591"
methodenum<string>[] | null

筛选指定支付方式的交易，包含国际信用卡和 APM。各支付方式详见 支付方式。

Examples:"card"
payment_method_schemestring | null

筛选指定支付卡组织的交易。

Examples:["visa"]

Response

application/json

Successful Response

itemsTransactionSummary · object[]required

本次请求返回的交易列表。

limitinteger

本页返回的条目数。

Default:20
Required range:1 <= x <= 100
Examples:"20"
next_cursorstring | null

指向下一页条目的游标。

Required string length:1 - 1000
Examples:"2"
previous_cursorstring | null

指向上一页条目的游标。

Required string length:1 - 1000
Examples:"1"
curl --request GET \
  --url https://api.efundpay.com/v4/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'x-merchant-account-id: <x-merchant-account-id>'
{
  "items": [
    {
      "type": "transaction",
      "id": "7099948d-7286-47e4-aad8-b68f7eb44591",
      "external_identifier": "2024121234394394",
      "merchant_account_id": "default",
      "currency": "USD",
      "amount": 100,
      "status": "authorization_succeeded",
      "country": "US",
      "method": "card",
      "payment_time": "2013-07-16T19:23:00.000+00:00",
      "error_code": null,
      "buyer": {
        "display_name": "Doe John",
        "external_identifier" :"buy1234"
        "first_name": "John",
        "last_name": "Doe",
        "email_address": "john@example.com",
        "phone_number": "+1234567890",
        "account_number": "123456789",
      },
      "shipping_details": {
        "first_name": "John",
        "last_name": "Doe",
        "email_address": "john@example.com",
        "phone_number": "+1234567890",
        "address": {
          "city": "San Jose",
          "country": "US",
          "postal_code": "94560",
          "state": "California",
          "state_code": "US-CA",
          "house_number_or_name": "10",
          "line1": "Stafford Appartments",
          "line2": "29th Street",
        },
      }
    }
  ],
  "limit": 20,
  "next_cursor": "1",
  "previous_cursor": "2"
}
Powered by Docusaurus