Skip to main content

Transaction List

Transactions

Returns a paginated list of transactions for the merchant account, sorted by most recently updated. You can filter, sort, and search transactions using query parameters.

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

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form `Bearer <token>`, where `<token>` is your auth token.

Headers

x-merchant-account-idstringrequired

The ID of the merchant account to use for this request.

Examples:"default"

Query Parameters

cursorinteger

A pointer to the page of results to return.

Examples:"0"
limitinteger

The maximum number of items that are at returned.

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

Filters the results to only transactions created before this ISO date-time string. The time zone must be included. Ensure that the date-time string is URL encoded, e.g. `2022-01-01T12:00:00+08:00` must be encoded as `2022-01-01T12%3A00%3A00%2B08%3A00`.

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

Filters the results to only transactions created after this ISO date-time string. The time zone must be included. Ensure that the date-time string is URL encoded, e.g. `2022-01-01T12:00:00+08:00` must be encoded as `2022-01-01T12%3A00%3A00%2B08%3A00`.

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

Filters the results to only the transactions that have a `status` that matches with any of the provided status values. For detailed descriptions of each status, see Transaction statuses.

Examples:"authorization_succeeded"
idstring | null

Filters for the transaction that has a matching `id` value.

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

Filters for transactions that have matching `method` values. Includes both card-based and alternative payment methods (APM). For detailed descriptions of each payment method, see Payment Methods.

Examples:"card"
payment_method_schemestring | null

Filters for transactions that have a payment method with a scheme that matches with the provided value.

Examples:["visa"]

Response

application/json

Successful Response

itemsTransactionSummary · object[]required

A list of items returned for this request.

limitinteger

The number of items for this page.

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

The cursor pointing at the next page of items.

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

The cursor pointing at the previous page of items.

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",
      },
      "billing_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",
        },
      },
      "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