Transactions

7 operations. Authenticate with your secret API key (see Authentication); failures use the shape described in Errors. Example requests read $GIEP_API_URL, your deployment’s API host.

Orders, AOV, refunds and net revenue per currency, per store or all stores

GET/v1/analytics/overview

An order is a paid checkout order (not a payment attempt). AOV = order value / orders, per currency; currencies are never mixed. Refunds count on the refund date; net revenue does not deduct chargebacks or dispute losses. Includes the period of equal length before and the change in basis points; with no storeId, a per-store breakdown. Definitions: apps/api/src/modules/analytics/overview.service.ts.

Authentication: API key (Bearer)
Permission: payment:read
Idempotency-Key: Not used
Success: 200

Query parameters

fromstring · date-timerequired
ISO 8601 instant with Z or an offset, e.g. 2026-10-24T00:00:00Z
pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
tostring · date-timerequired
ISO 8601 instant with Z or an offset, e.g. 2026-10-24T00:00:00Z
pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
storeIdstring · uuid
A store of the merchant; omit for all of the merchant's stores
currencystring
Currency of the headline figures; defaults to the store or merchant currency
pattern ^[A-Za-z]{3}$

Responses

200Success
401Missing or invalid credentials Body is an error object with code and message.
403Role not permitted Body is an error object with code and message.
422Validation failed (invalid_request) Body is an error object with code and message.
429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

200 response fieldsBusinessOverview

storeIdstringrequirednullable
fromstringrequired
tostringrequired
previousobjectrequired
Fields: 2 fields
- fromstringrequired
- tostringrequired
currencystringrequired
3 chars
currenciesarray<string>required
byCurrencyarray<object>required
Each item has 4 fields
- currencystringrequired
  3 chars
- currentobjectrequired
  Fields: 5 fields
  ordersintegerrequired
  Paid checkout orders (not payment attempts).
  orderValueintegerrequired
  Sum of order totals, minor units.
  aovintegerrequirednullable
  orderValue / orders, minor units; null without orders.
  refundsintegerrequired
  Succeeded refunds of order payments, minor units.
  netRevenueintegerrequired
  orderValue - refunds, minor units.
- previousobjectrequired
  Fields: 5 fields
  ordersintegerrequired
  Paid checkout orders (not payment attempts).
  orderValueintegerrequired
  Sum of order totals, minor units.
  aovintegerrequirednullable
  orderValue / orders, minor units; null without orders.
  refundsintegerrequired
  Succeeded refunds of order payments, minor units.
  netRevenueintegerrequired
  orderValue - refunds, minor units.
- changeobjectrequired
  Change against the previous period in basis points; null without a baseline.
  Fields: 4 fields
  ordersintegerrequirednullable
  orderValueintegerrequirednullable
  aovintegerrequirednullable
  netRevenueintegerrequirednullable
storesarray<object>requirednullable
Each item has 4 fields
- storeIdstringrequired
- namestringrequired
- archivedbooleanrequired
- currenciesarray<object>required
  Each item has 4 fields
  currencystringrequired
  3 chars
  currentobjectrequired
  Fields: 5 fields
  ordersintegerrequired
  Paid checkout orders (not payment attempts).
  orderValueintegerrequired
  Sum of order totals, minor units.
  aovintegerrequirednullable
  orderValue / orders, minor units; null without orders.
  refundsintegerrequired
  Succeeded refunds of order payments, minor units.
  netRevenueintegerrequired
  orderValue - refunds, minor units.
  previousobjectrequired
  Fields: 5 fields
  ordersintegerrequired
  Paid checkout orders (not payment attempts).
  orderValueintegerrequired
  Sum of order totals, minor units.
  aovintegerrequirednullable
  orderValue / orders, minor units; null without orders.
  refundsintegerrequired
  Succeeded refunds of order payments, minor units.
  netRevenueintegerrequired
  orderValue - refunds, minor units.
  changeobjectrequired
  Change against the previous period in basis points; null without a baseline.
  Fields: 4 fields
  ordersintegerrequirednullable
  orderValueintegerrequirednullable
  aovintegerrequirednullable
  netRevenueintegerrequirednullable

Request · cURL

curl -X GET "$GIEP_API_URL/v1/analytics/overview?from=1&to=1" \
  -H "Authorization: Bearer $GIEP_API_KEY"

{
  "storeId": "string",
  "from": "string",
  "to": "string",
  "previous": {
    "from": "string",
    "to": "string"
  },
  "currency": "USD",
  "currencies": [
    "string"
  ],
  "byCurrency": [
    {
      "currency": "USD",
      "current": {
        "orders": 1,
        "orderValue": 1,
        "aov": 1,
        "refunds": 1,
        "netRevenue": 1
      },
      "previous": {
        "orders": 1,
        "orderValue": 1,
        "aov": 1,
        "refunds": 1,
        "netRevenue": 1
      },
      "change": {
        "orders": 1,
        "orderValue": 1,
        "aov": 1,
        "netRevenue": 1
      }
    }
  ],
  "stores": [
    {
      "storeId": "string",
      "name": "string",
      "archived": false,
      "currencies": [
        {}
      ]
    }
  ]
}

{
  "error": {
    "code": "unauthorized",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Human-readable explanation"
  }
}

Payment volume, refunds and approval over time

GET/v1/analytics/payments

UTC hour/day buckets over [from, to) in one currency (integer minor units), every bucket present, plus the same metrics for the period of equal length immediately before. hour allows at most 7 days, day at most 400.

Authentication: API key (Bearer)
Permission: payment:read
Idempotency-Key: Not used
Success: 200

Query parameters

fromstring · date-timerequired
ISO 8601 instant with Z or an offset, e.g. 2026-10-24T00:00:00Z
pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
tostring · date-timerequired
ISO 8601 instant with Z or an offset, e.g. 2026-10-24T00:00:00Z
pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
intervalstringrequired
UTC bucket size
One ofhourday
currencystring
ISO 4217 code; defaults to the merchant's default currency
pattern ^[A-Za-z]{3}$
storeIdstring · uuid
A store of the merchant; omit for all of the merchant's stores

Responses

200Success
401Missing or invalid credentials Body is an error object with code and message.
403Role not permitted Body is an error object with code and message.
422Validation failed (invalid_request) Body is an error object with code and message.
429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

200 response fieldsPaymentsAnalytics

currencystringrequired
3 chars
storeIdstringrequirednullable
The store in scope; null = all stores.
intervalstringrequired
One ofhourday
fromstringrequired
Effective start: from truncated to its UTC bucket.
tostringrequired
seriesarray<object>required
Each item has 7 fields
- startstringrequired
  Bucket start, ISO 8601 UTC.
- grossVolumeintegerrequired
  Captured amount of succeeded payments created in the bucket (minor units).
- refundsintegerrequired
  Succeeded refunds created in the bucket (minor units).
- netVolumeintegerrequired
  grossVolume - refunds (minor units; may be negative).
- paymentsintegerrequired
  Payments created in the bucket, any status.
- succeededintegerrequired
  Payments with status succeeded.
- failedintegerrequired
  Payments with status failed.
totalsobjectrequired
Fields: 7 fields
- grossVolumeintegerrequired
  Captured amount of succeeded payments created in the bucket (minor units).
- refundsintegerrequired
  Succeeded refunds created in the bucket (minor units).
- netVolumeintegerrequired
  grossVolume - refunds (minor units; may be negative).
- paymentsintegerrequired
  Payments created in the bucket, any status.
- succeededintegerrequired
  Payments with status succeeded.
- failedintegerrequired
  Payments with status failed.
- approvalRatenumberrequirednullable
  succeeded / (succeeded + failed); null when both are 0.
  min 0 · max 1
previousobjectrequired
Fields: 4 fields
- fromstringrequired
- tostringrequired
- seriesarray<object>required
  Each item has 7 fields
  startstringrequired
  Bucket start, ISO 8601 UTC.
  grossVolumeintegerrequired
  Captured amount of succeeded payments created in the bucket (minor units).
  refundsintegerrequired
  Succeeded refunds created in the bucket (minor units).
  netVolumeintegerrequired
  grossVolume - refunds (minor units; may be negative).
  paymentsintegerrequired
  Payments created in the bucket, any status.
  succeededintegerrequired
  Payments with status succeeded.
  failedintegerrequired
  Payments with status failed.
- totalsobjectrequired
  Fields: 7 fields
  grossVolumeintegerrequired
  Captured amount of succeeded payments created in the bucket (minor units).
  refundsintegerrequired
  Succeeded refunds created in the bucket (minor units).
  netVolumeintegerrequired
  grossVolume - refunds (minor units; may be negative).
  paymentsintegerrequired
  Payments created in the bucket, any status.
  succeededintegerrequired
  Payments with status succeeded.
  failedintegerrequired
  Payments with status failed.
  approvalRatenumberrequirednullable
  succeeded / (succeeded + failed); null when both are 0.
  min 0 · max 1

Request · cURL

curl -X GET "$GIEP_API_URL/v1/analytics/payments?from=1&to=1&interval=hour" \
  -H "Authorization: Bearer $GIEP_API_KEY"

{
  "currency": "USD",
  "storeId": "string",
  "interval": "hour",
  "from": "string",
  "to": "string",
  "series": [
    {
      "start": "string",
      "grossVolume": 1,
      "refunds": 1,
      "netVolume": 1,
      "payments": 1,
      "succeeded": 1,
      "failed": 1
    }
  ],
  "totals": {
    "grossVolume": 1,
    "refunds": 1,
    "netVolume": 1,
    "payments": 1,
    "succeeded": 1,
    "failed": 1,
    "approvalRate": 1
  },
  "previous": {
    "from": "string",
    "to": "string",
    "series": [
      {
        "start": "string",
        "grossVolume": 1,
        "refunds": 1,
        "netVolume": 1,
        "payments": 1,
        "succeeded": 1,
        "failed": 1
      }
    ],
    "totals": {
      "grossVolume": 1,
      "refunds": 1,
      "netVolume": 1,
      "payments": 1,
      "succeeded": 1,
      "failed": 1,
      "approvalRate": 1
    }
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Human-readable explanation"
  }
}

Read-only decline recovery funnel

GET/v1/analytics/recovery

Payments whose first attempt was a definite decline, how many were retried on a backup processor and how many then succeeded. Unknown/indeterminate first attempts are excluded entirely (a timeout is never a decline).

Authentication: API key (Bearer)
Permission: payment:read
Idempotency-Key: Not used
Success: 200

Query parameters

fromstring · date-timerequired
ISO 8601 instant with Z or an offset, e.g. 2026-10-24T00:00:00Z
pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
tostring · date-timerequired
ISO 8601 instant with Z or an offset, e.g. 2026-10-24T00:00:00Z
pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
currencystring
ISO 4217 code; defaults to the merchant's default currency
pattern ^[A-Za-z]{3}$

Responses

200Success
401Missing or invalid credentials Body is an error object with code and message.
403Role not permitted Body is an error object with code and message.
422Validation failed (invalid_request) Body is an error object with code and message.
429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

200 response fieldsRecovery

currencystringrequired
3 chars
fromstringrequired
tostringrequired
declinedintegerrequired
Payments whose first attempt was a definite decline.
retriedintegerrequired
Of those, payments with a later attempt (the cascade).
recoveredintegerrequired
Of those, payments that ended succeeded after a retry.
recoveredAmountintegerrequired
Captured amount of the recovered payments (minor units).
recoveryRatenumberrequirednullable
min 0 · max 1
retryRatenumberrequirednullable
min 0 · max 1
categoriesarray<object>required
Each item has 6 fields
- categorystringrequired
- declinedintegerrequired
  Payments whose first attempt was a definite decline.
- retriedintegerrequired
  Of those, payments with a later attempt (the cascade).
- recoveredintegerrequired
  Of those, payments that ended succeeded after a retry.
- recoveredAmountintegerrequired
  Captured amount of the recovered payments (minor units).
- recoveryRatenumberrequirednullable
  min 0 · max 1
excludedobjectrequired
Fields: 2 fields
- unknownintegerrequired
  First attempts that ended unknown (never a decline).
- unclassifiedintegerrequired
  First attempts that failed without a decline category.

Request · cURL

curl -X GET "$GIEP_API_URL/v1/analytics/recovery?from=1&to=1" \
  -H "Authorization: Bearer $GIEP_API_KEY"

{
  "currency": "USD",
  "from": "string",
  "to": "string",
  "declined": 1,
  "retried": 1,
  "recovered": 1,
  "recoveredAmount": 4999,
  "recoveryRate": 1,
  "retryRate": 1,
  "categories": [
    {
      "category": "string",
      "declined": 1,
      "retried": 1,
      "recovered": 1,
      "recoveredAmount": 4999,
      "recoveryRate": 1
    }
  ],
  "excluded": {
    "unknown": 1,
    "unclassified": 1
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Human-readable explanation"
  }
}

Read-only routing opportunities by card range

GET/v1/analytics/routing-opportunities

First attempts grouped by card range and processor. A range is compared only when at least minProcessors processors each have minCellAttempts definite first attempts; under lowConfidenceBelow the comparison is marked low confidence. Extra approvals and revenue are ESTIMATES in integer minor units, rounded down. Never changes routing.

Authentication: API key (Bearer)
Permission: payment:read
Idempotency-Key: Not used
Success: 200

Query parameters

fromstring · date-timerequired
ISO 8601 instant with Z or an offset, e.g. 2026-10-24T00:00:00Z
pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
tostring · date-timerequired
ISO 8601 instant with Z or an offset, e.g. 2026-10-24T00:00:00Z
pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
currencystring
ISO 4217 code; defaults to the merchant's default currency
pattern ^[A-Za-z]{3}$

Responses

200Success
401Missing or invalid credentials Body is an error object with code and message.
403Role not permitted Body is an error object with code and message.
422Validation failed (invalid_request) Body is an error object with code and message.
429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

200 response fieldsRoutingOpportunities

currencystringrequired
3 chars
fromstringrequired
tostringrequired
minCellAttemptsintegerrequired
minProcessorsintegerrequired
lowConfidenceBelowintegerrequired
totalsobjectrequired
Fields: 7 fields
- attemptsintegerrequired
- analysedAttemptsintegerrequired
- trafficSharenumberrequirednullable
  min 0 · max 1
- rangesComparedintegerrequired
- extraApprovedintegerrequired
- estimatedRevenueintegerrequired
  ESTIMATE (minor units).
- undecidedAttemptsintegerrequired
rangesarray<object>required
Each item has 10 fields
- cardRangestringrequired
  First 6 digits of the card number.
- attemptsintegerrequired
  Attempts over the compared processors.
- approvedintegerrequired
- approvalRatenumberrequired
  Blended rate over the compared processors.
  min 0 · max 1
- processorsarray<object>required
  Each item has 5 fields
  processorAccountIdstring · uuidrequired
  labelstringrequired
  attemptsintegerrequired
  First attempts with a definite outcome.
  approvedintegerrequired
  First attempts that ended succeeded or authorized.
  approvalRatenumberrequired
  min 0 · max 1
- bestobjectrequired
  Fields: 3 fields
  processorAccountIdstring · uuidrequired
  labelstringrequired
  approvalRatenumberrequired
  min 0 · max 1
- extraApprovedintegerrequired
  ESTIMATED extra approvals if the range went to the best processor (rounded down).
- averageTicketintegerrequired
  Average captured amount of the range's approved payments (minor units, rounded down).
- estimatedRevenueintegerrequired
  ESTIMATE: extraApproved x averageTicket (minor units).
- confidencestringrequired
  One oflowok

Request · cURL

curl -X GET "$GIEP_API_URL/v1/analytics/routing-opportunities?from=1&to=1" \
  -H "Authorization: Bearer $GIEP_API_KEY"

{
  "currency": "USD",
  "from": "string",
  "to": "string",
  "minCellAttempts": 1,
  "minProcessors": 1,
  "lowConfidenceBelow": 1,
  "totals": {
    "attempts": 1,
    "analysedAttempts": 1,
    "trafficShare": 1,
    "rangesCompared": 1,
    "extraApproved": 1,
    "estimatedRevenue": 1,
    "undecidedAttempts": 1
  },
  "ranges": [
    {
      "cardRange": "string",
      "attempts": 1,
      "approved": 1,
      "approvalRate": 1,
      "processors": [
        {
          "processorAccountId": "6a56728f-88e7-43cd-a890-8c9c7d0a",
          "label": "string",
          "attempts": 1,
          "approved": 1,
          "approvalRate": 1
        }
      ],
      "best": {
        "processorAccountId": "6a56728f-88e7-43cd-a890-8c9c7d0a",
        "label": "string",
        "approvalRate": 1
      },
      "extraApproved": 1,
      "averageTicket": 1,
      "estimatedRevenue": 1,
      "confidence": "low"
    }
  ]
}

{
  "error": {
    "code": "unauthorized",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Human-readable explanation"
  }
}

List and filter transactions

GET/v1/transactions

Payments with filters: status (comma list), processor account, store, date range, amount range (integer minor units; combine with currency) and search q (payment id prefix, customer email or card last 4). Sort by createdAt or amount. Cursor pagination: pass nextCursor back as cursor with the same filters.

Authentication: API key (Bearer)
Permission: payment:read
Idempotency-Key: Not used
Success: 200

Query parameters

statusstring
processorAccountIdstring · uuid
storeIdstring · uuid
A store of the merchant; omit for all of the merchant's stores
fromany
toany
minAmountinteger
min 0
maxAmountinteger
min 0
currencystring
3 chars
qstring
min 1 chars · max 100 chars
sortstring
One ofcreatedAtamountDefault createdAt
orderstring
One ofascdescDefault desc
limitinteger
Default 50min 1 · max 200
cursorstring
max 500 chars

Responses

200Success
401Missing or invalid credentials Body is an error object with code and message.
403Role not permitted Body is an error object with code and message.
422Validation failed (invalid_request) Body is an error object with code and message.
429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL

curl -X GET "$GIEP_API_URL/v1/transactions" \
  -H "Authorization: Bearer $GIEP_API_KEY"

// JSON object. The OpenAPI document does not list its fields.

{
  "error": {
    "code": "unauthorized",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Human-readable explanation"
  }
}

Transaction detail with timeline

GET/v1/transactions/{id}

One payment with its attempts, routing decision, refunds, webhooks and events, order and the merged timeline.

Authentication: API key (Bearer)
Permission: payment:read
Idempotency-Key: Not used
Success: 200

Path parameters

idstringrequired

Responses

200Success
401Missing or invalid credentials Body is an error object with code and message.
403Role not permitted Body is an error object with code and message.
429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL

curl -X GET "$GIEP_API_URL/v1/transactions/b57e25d1-b531-4fab-af77-3be4-42c" \
  -H "Authorization: Bearer $GIEP_API_KEY"

// JSON object. The OpenAPI document does not list its fields.

{
  "error": {
    "code": "unauthorized",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Human-readable explanation"
  }
}

Export filtered transactions as CSV

GET/v1/transactions/export.csv

CSV of the payments matching the filters (cursor and limit are ignored), streamed, at most 100,000 rows: split larger ranges by date. Amounts are decimal strings at the currency exponent.

Authentication: API key (Bearer)
Permission: payment:read
Idempotency-Key: Not used
Success: 200

Query parameters

statusstring
processorAccountIdstring · uuid
storeIdstring · uuid
A store of the merchant; omit for all of the merchant's stores
fromany
toany
minAmountinteger
min 0
maxAmountinteger
min 0
currencystring
3 chars
qstring
min 1 chars · max 100 chars
sortstring
One ofcreatedAtamountDefault createdAt
orderstring
One ofascdescDefault desc
limitinteger
Default 50min 1 · max 200
cursorstring
max 500 chars

Responses

200Success
401Missing or invalid credentials Body is an error object with code and message.
403Role not permitted Body is an error object with code and message.
422Validation failed (invalid_request) Body is an error object with code and message.
429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a CSV file, streamed.

200 response fields

Body type: string.

Request · cURL

curl -X GET "$GIEP_API_URL/v1/transactions/export.csv" \
  -H "Authorization: Bearer $GIEP_API_KEY"

(streamed CSV, one row per line)

{
  "error": {
    "code": "unauthorized",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "Human-readable explanation"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Human-readable explanation"
  }
}