List transactions

GET

transactions

curl --request GET \
  --url https://api.{id}.gr4vy.app/transactions \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "type": "transaction",
      "id": "7099948d-7286-47e4-aad8-b68f7eb44591",
      "reconciliation_id": "default",
      "merchant_account_id": "default",
      "currency": "EUR",
      "amount": 1299,
      "status": "authorization_succeeded",
      "authorized_amount": 1299,
      "captured_amount": 1299,
      "refunded_amount": 1299,
      "settled_currency": "USD",
      "settled_amount": 1100,
      "settled": true,
      "country": "US",
      "external_identifier": "transaction-12345",
      "intent": "capture",
      "payment_method": {
        "type": "payment-method",
        "approval_url": "https://gr4vy.app/redirect/12345",
        "country": "US",
        "currency": "USD",
        "details": {
          "bin": "<string>",
          "card_type": "credit",
          "card_issuer_name": "<string>"
        },
        "expiration_date": "12/30",
        "fingerprint": "20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17",
        "label": "1234",
        "last_replaced_at": "2013-07-16T19:23:00.000+00:00",
        "method": "card",
        "mode": "card",
        "scheme": "visa",
        "id": "852b951c-d7ea-4c98-b09e-4a1c9e97c077",
        "approval_target": "any",
        "external_identifier": "card-12345",
        "payment_account_reference": "V0010014629724763377327521982"
      },
      "method": "card",
      "instrument_type": "pan",
      "error_code": "missing_redirect_url",
      "payment_service": {
        "type": "payment-service",
        "id": "824ff064-7f4b-430b-9801-59aff90d013e",
        "payment_service_definition_id": "stripe-card",
        "method": "card",
        "display_name": "Stripe USA"
      },
      "pending_review": false,
      "buyer": {
        "type": "buyer",
        "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
        "display_name": "John Doe",
        "external_identifier": "buyer-12345",
        "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",
            "organization": "Gr4vy"
          },
          "tax_id": {
            "value": "12345678931",
            "kind": "us.ein"
          }
        },
        "account_number": "<string>"
      },
      "raw_response_code": "E104",
      "raw_response_description": "Missing redirect URL",
      "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",
          "organization": "Gr4vy"
        },
        "id": "bf8c36ad-02d9-4904-b0f9-a230b149e341",
        "buyer_id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
        "type": "shipping-details"
      },
      "checkout_session_id": "4137b1cf-39ac-42a8-bad6-1c680d5dab6b",
      "gift_card_redemptions": [
        {
          "type": "gift-card-redemption",
          "id": "31e65fb1-9c67-432e-9c06-83300b9d4059",
          "status": "succeeded",
          "amount": 100,
          "refunded_amount": 50,
          "gift_card_service_redemption_id": "xYqd43gySMtori",
          "error_code": "expired_card",
          "raw_error_code": "10001",
          "raw_error_message": "Card expired",
          "gift_card": {
            "type": "gift-card",
            "id": "356d56e5-fe16-42ae-97ee-8d55d846ae2e",
            "bin": "412345",
            "sub_bin": "554",
            "last4": "1234"
          }
        }
      ],
      "gift_card_service": {
        "type": "gift-card-service",
        "id": "35b60feec-a7c7-4844-b503-f39b09192d81",
        "gift_card_service_definition_id": "qwikcilver-gift-card",
        "display_name": "Qwikcilver USA"
      },
      "created_at": "2013-07-16T19:23:00.000+00:00",
      "updated_at": "2013-07-16T19:23:00.000+00:00"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

Authorizations

Authorization

string

header

required

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

Headers

x-gr4vy-merchant-account-id

string | null

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

Examples:

"default"

Query Parameters

cursor

string | null

A pointer to the page of results to return.

Examples:

"ZXhhbXBsZTE"

limit

integer

default:20

The maximum number of items that are at returned.

Required range: 1 <= x <= 100

Examples:

20

created_at_lte

string | 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_gte

string | 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"

updated_at_lte

string | null

Filters the results to only transactions updated 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"

updated_at_gte

string | null

Filters the results to only transactions updated 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"

string | null

Filters for transactions that have one of the following fields match exactly with the provided search value.

Examples:

"transaction-12345"

buyer_external_identifier

string | null

Filters the results to only the items for which the buyer has an external_identifier that exactly matches this value.

Examples:

"buyer-12345"

buyer_id

string | null

Filters the results to only the items for which the buyer has an id that matches this value.

Examples:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

buyer_email_address

string | null

Filters the results to only the items for which the buyer has an email_address that matches this value.

Examples:

"john@example.com"

buyer_search

string | null

Filters the results to only the items for which some of the buyer data contains exactly with the provided buyer_search value.

Required string length: 3 - 5000

Examples:

"John"

ip_address

string | null

Filters the results to only the transactions that were originated from the given ip_address.

Examples:

"8.214.133.47"

status

enum<string>[] | null

Filters the results to only the transactions that have a status that matches with any of the provided status values.

Examples:

"authorization_succeeded"

string | null

Filters for the transaction that has a matching id value.

Examples:

"7099948d-7286-47e4-aad8-b68f7eb44591"

payment_service_transaction_id

string | null

Filters for transactions that have a matching payment_service_transaction_id value. The payment_service_transaction_id is the identifier of the transaction given by the payment service.

Examples:

"tx-12345"

external_identifier

string | null

Filters the results to only the items for which the external_identifier matches this value.

Examples:

"transaction-12345"

metadata

string[] | null

Filters for transactions where their metadata values contain all of the provided metadata keys. The value sent for metadata must be formatted as a JSON string, and all keys and values must be strings. This value should also be URL encoded.

Examples:

[
  {
    "first_key": "first_value",
    "second_key": "second_value"
  }
]

amount_eq

integer | null

Filters for transactions that have an amount that is equal to the provided amount_eq value.

Required range: x >= 0

Examples:

1299

amount_lte

integer | null

Filters for transactions that have an amount that is less than or equal to the amount_lte value.

Required range: x >= 0

Examples:

1299

amount_gte

integer | null

Filters for transactions that have an amount that is greater than or equal to the amount_gte value.

Required range: x >= 0

Examples:

1299

currency

string[] | null

Filters for transactions that have matching currency values. The currency values provided must be formatted as 3-letter ISO currency code.

Examples:

["USD"]

country

string[] | null

Filters for transactions that have matching country values.

Examples:

["US"]

payment_service_id

string[] | null

Filters for transactions that were processed by the provided payment_service_id values.

Examples:

["fffd152a-9532-4087-9a4f-de58754210f0"]

payment_method_id

string | null

Filters for transactions that have a payment method with an ID that matches exactly with the provided value.

Examples:

"ef9496d8-53a5-4aad-8ca2-00eb68334389"

payment_method_label

string | null

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

Examples:

"1234"

payment_method_scheme

string | null

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

Examples:

["visa"]

payment_method_country

string | null

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

Examples:

["US"]

payment_method_fingerprint

string | null

Filters for transactions that have a payment method with a fingerprint that matches exactly with the provided value

Examples:

"a50b85c200ee0795d6fd33a5c66f37a4564f554355c5b46a756aac485dd168a4"

method

enum<string>[] | null

Filters for transactions that have matching method values.

Examples:

"card"

error_code

string[] | null

Filters for transactions where the error_code matches one for the provided values.

Examples:

["insufficient_funds"]

has_refunds

boolean | null

Filters for transactions with refunds.

Examples:

true

pending_review

boolean | null

Filters for transactions with a pending manual anti-fraud review.

Examples:

true

checkout_session_id

string | null

Filters for transactions where the checkout_session_id matches the provided value.

Examples:

"4137b1cf-39ac-42a8-bad6-1c680d5dab6b"

reconciliation_id

string | null

Filters for transactions where the reconciliation_id matches the provided value.

Examples:

"7jZXl4gBUNl0CnaLEnfXbt"

has_gift_card_redemptions

boolean | null

Filters for transactions with gift card redemptions.

Examples:

true

gift_card_id

string | null

Filters for transactions where a gift card used has an id that matches the provided value.

Examples:

"356d56e5-fe16-42ae-97ee-8d55d846ae2e"

gift_card_last4

string | null

Filters for transactions that have at least one gift card redemption where the last 4 digits of its gift card number matches exactly with the provided value.

Required string length: 4

Examples:

"7890"

has_settlements

boolean | null

Filters for transactions that have at least one associated settlement record.

Examples:

true

payment_method_bin

string | null

Filter for transactions that have a card with a BIN that matches exactly with the provided value.

Examples:

"411111"

payment_source

enum<string>[] | null

Filters the results to only the transactions that have a payment source that matches with any of the provided values.

Examples:

"recurring"

is_subsequent_payment

boolean | null

Filters for transactions where the is_subsequent_payment matches the provided value.

Examples:

true

merchant_initiated

boolean | null

Filters for transactions where the merchant_initiated matches the provided value.

Examples:

true

used_3ds

boolean | null

Filters for transactions that attempted 3DS authentication or not.

Examples:

true

Response

200

application/json

Successful Response

The response is of type object.

Create a Click to Pay session Create transaction

curl --request GET \
  --url https://api.{id}.gr4vy.app/transactions \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "type": "transaction",
      "id": "7099948d-7286-47e4-aad8-b68f7eb44591",
      "reconciliation_id": "default",
      "merchant_account_id": "default",
      "currency": "EUR",
      "amount": 1299,
      "status": "authorization_succeeded",
      "authorized_amount": 1299,
      "captured_amount": 1299,
      "refunded_amount": 1299,
      "settled_currency": "USD",
      "settled_amount": 1100,
      "settled": true,
      "country": "US",
      "external_identifier": "transaction-12345",
      "intent": "capture",
      "payment_method": {
        "type": "payment-method",
        "approval_url": "https://gr4vy.app/redirect/12345",
        "country": "US",
        "currency": "USD",
        "details": {
          "bin": "<string>",
          "card_type": "credit",
          "card_issuer_name": "<string>"
        },
        "expiration_date": "12/30",
        "fingerprint": "20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17",
        "label": "1234",
        "last_replaced_at": "2013-07-16T19:23:00.000+00:00",
        "method": "card",
        "mode": "card",
        "scheme": "visa",
        "id": "852b951c-d7ea-4c98-b09e-4a1c9e97c077",
        "approval_target": "any",
        "external_identifier": "card-12345",
        "payment_account_reference": "V0010014629724763377327521982"
      },
      "method": "card",
      "instrument_type": "pan",
      "error_code": "missing_redirect_url",
      "payment_service": {
        "type": "payment-service",
        "id": "824ff064-7f4b-430b-9801-59aff90d013e",
        "payment_service_definition_id": "stripe-card",
        "method": "card",
        "display_name": "Stripe USA"
      },
      "pending_review": false,
      "buyer": {
        "type": "buyer",
        "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
        "display_name": "John Doe",
        "external_identifier": "buyer-12345",
        "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",
            "organization": "Gr4vy"
          },
          "tax_id": {
            "value": "12345678931",
            "kind": "us.ein"
          }
        },
        "account_number": "<string>"
      },
      "raw_response_code": "E104",
      "raw_response_description": "Missing redirect URL",
      "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",
          "organization": "Gr4vy"
        },
        "id": "bf8c36ad-02d9-4904-b0f9-a230b149e341",
        "buyer_id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
        "type": "shipping-details"
      },
      "checkout_session_id": "4137b1cf-39ac-42a8-bad6-1c680d5dab6b",
      "gift_card_redemptions": [
        {
          "type": "gift-card-redemption",
          "id": "31e65fb1-9c67-432e-9c06-83300b9d4059",
          "status": "succeeded",
          "amount": 100,
          "refunded_amount": 50,
          "gift_card_service_redemption_id": "xYqd43gySMtori",
          "error_code": "expired_card",
          "raw_error_code": "10001",
          "raw_error_message": "Card expired",
          "gift_card": {
            "type": "gift-card",
            "id": "356d56e5-fe16-42ae-97ee-8d55d846ae2e",
            "bin": "412345",
            "sub_bin": "554",
            "last4": "1234"
          }
        }
      ],
      "gift_card_service": {
        "type": "gift-card-service",
        "id": "35b60feec-a7c7-4844-b503-f39b09192d81",
        "gift_card_service_definition_id": "qwikcilver-gift-card",
        "display_name": "Qwikcilver USA"
      },
      "created_at": "2013-07-16T19:23:00.000+00:00",
      "updated_at": "2013-07-16T19:23:00.000+00:00"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

Account updater

Buyers - Payment methods

Payment methods

Payment methods - Payment service tokens

Payment methods - Network tokens

Gift cards

Buyers - Gift cards

Buyers

Buyers - Shipping details

Card scheme definitions

Digital wallets - Setup

Digital wallets - Sessions

Transactions

Refunds

Payment options

Payment service definitions

Payment services

Audit logs

Checkout sessions

Merchant accounts

Payouts

List transactions

Authorizations

Headers

Query Parameters

Response