Payments

Get payments

get

Retrieves all payments for the specified store using the filter specified.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Query parameters

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816

beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

order_idstring · flake-idOptional

Filter by order ID

Example: 411486491630370816

customer_idstring · flake-idOptional

Filter by customer ID

Example: 411486491630370816

Responses

200

OK

application/json

Represents a payment transaction

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

order_idstring · flake-idRequiredExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

gatewaystringRequired

The payment gateway provider

Example: stripe

gateway_entity_identifierstringRequired

The gateway entity identifier

gateway_idstringRequired

The gateway payment identifier

method_idstring · flake-idOptionalExample: 411486491630370816

statusstring · enumRequired

Represents payment status

Possible values:

currencystringRequired

The currency code used for this payment in the store's currency

Example: usd

amountinteger · int32Required

The total payment amount in smallest currency unit

Example: 10000

gateway_fee_amountinteger · int32Required

The gateway fee amount in smallest currency unit

Example: 320

tax_amountinteger · int32Required

The tax amount in smallest currency unit

Example: 850

platform_fee_amountinteger · int32Required

The platform fee amount in smallest currency unit

Example: 500

store_net_amountinteger · int32Required

The net amount going to the store in smallest currency unit

Example: 8330

presentment_currencystringRequired

The currency code used for presentment to the customer

Example: eur

presentment_amountinteger · int32Required

The amount presented to the customer in smallest currency unit

Example: 9500

fx_ratenumber · nullableOptional

The foreign exchange rate used for currency conversion

Example: 1.085

platform_fee_rateinteger · int32Required

The platform fee rate applied to this payment (in basis points)

Example: 500

chargeback_statusstring · enumRequired

Represents chargeback status of a payment

Possible values:

chargeback_status_updated_atstring · nullableOptional

The date and time when the chargeback status was last updated

created_atstring · date-timeRequired

The date and time when this payment was created

Example: 2025-04-01T15:30:45Z

pending_atstring · nullableOptional

The date and time when this payment entered pending status

Example: 2025-04-01T15:30:46Z

completed_atstring · nullableOptional

The date and time when this payment was completed

Example: 2025-04-01T15:31:12Z

canceled_atstring · nullableOptional

The date and time when this payment was canceled

failed_atstring · nullableOptional

The date and time when this payment failed

refunded_atstring · nullableOptional

The date and time when this payment was last refunded

chargeback_atstring · nullableOptional

The date and time when a chargeback was initiated on this payment

default

Error response

application/json

get

/v1/stores/{storeId}/payments

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/payments HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "order_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-05-21T00:13:47.625Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "refunds": [
      {
        "id": "411486491630370816",
        "store_id": "411486491630370816",
        "payment_id": "411486491630370816",
        "customer_id": "411486491630370816",
        "order_line_id": "411486491630370816",
        "status": "created",
        "failure_reason": null,
        "currency": "text",
        "amount": 1,
        "amount_str": "text",
        "gateway_fee_amount": 1,
        "gateway_fee_amount_str": "text",
        "tax_amount": 1,
        "tax_amount_str": "text",
        "platform_fee_amount": 1,
        "platform_fee_amount_str": "text",
        "store_net_amount": 1,
        "store_net_amount_str": "text",
        "store_refund_amount": 1,
        "store_refund_amount_str": "text",
        "presentment_currency": null,
        "presentment_amount": null,
        "fx_rate": null,
        "refund_from_connected_user_balance": true,
        "created_at": "2026-05-21T00:13:47.625Z",
        "approved_at": null,
        "pending_at": null,
        "completed_at": null,
        "canceled_at": null,
        "failed_at": null
      }
    ],
    "gateway": "stripe",
    "gateway_entity_identifier": "text",
    "gateway_id": "text",
    "method": {
      "id": "411486491630370816",
      "customer_id": "411486491630370816",
      "gateway": "text",
      "gateway_id": "text",
      "gateway_customer_id": "text",
      "gateway_type": "card",
      "method_type": "card",
      "method_details": {
        "card": {
          "brand": "visa",
          "country": "US",
          "exp_month": 12,
          "exp_year": 2028,
          "fingerprint": "abc123def456",
          "funding": "credit",
          "last4": "4242",
          "bin": 424242,
          "issuer": "Chase Bank",
          "description": "Visa Signature",
          "wallet": {
            "type": "apple_pay"
          }
        },
        "cashapp": {
          "buyer_id": "buyer_abc123",
          "cashtag": "$johndoe"
        },
        "paypal": {
          "payer_id": "PAYERID123",
          "payer_email": "[email protected]",
          "payer_name": "John Doe",
          "country": "US",
          "vault": true,
          "pending_vault_approval": false,
          "standalone_setup": false
        },
        "link": {
          "email": "[email protected]"
        },
        "crypto": {
          "crypto_currency": "BTC",
          "crypto_amount": "0.00150000",
          "total_paid": "0.00150000",
          "confirmations": 6
        },
        "steamskins": {
          "items": [
            {
              "id": "text",
              "app_id": 730,
              "name": "AK-47 | Redline",
              "price": 2500
            }
          ]
        },
        "ideal": {
          "bank": "abn_amro",
          "bic": "ABNANL2A",
          "iban_last4": 1234,
          "payer_name": "John Doe"
        },
        "p24": {
          "bank": "ing",
          "payer_name": "Jan Kowalski"
        },
        "bancontact": {
          "bank": "bnp_paribas",
          "bank_name": "BNP Paribas",
          "bic": "GEBABEBB",
          "iban_last4": 3456,
          "payer_name": "Jean Dupont"
        },
        "klarna": {
          "country": "SE",
          "method_category": "pay_later"
        },
        "alipay": {
          "buyer_id": "buyer_abc123",
          "fingerprint": "fingerprint_xyz789"
        },
        "pay_by_bank": {
          "bank_name": "Chase Bank",
          "bic": "CHASUS33",
          "country": "US",
          "payer_name": "John Smith"
        },
        "pix": {
          "bank_name": "Banco do Brasil",
          "bank_account_number": "12345-6",
          "payer_name": "João Silva"
        },
        "paysafecard": {
          "first_name": null,
          "last_name": null,
          "psc_id": null,
          "association_id": null
        }
      },
      "created_at": "2025-03-15T10:20:30Z",
      "gateway_entity_identifier": "text",
      "updated_at": "2025-03-20T14:30:00Z"
    },
    "method_id": "411486491630370816",
    "status": "unknown",
    "currency": "usd",
    "amount": 10000,
    "gateway_fee_amount": 320,
    "tax_amount": 850,
    "platform_fee_amount": 500,
    "store_net_amount": 8330,
    "presentment_currency": "eur",
    "presentment_amount": 9500,
    "fx_rate": 1.085,
    "platform_fee_rate": 500,
    "chargeback_status": "none",
    "chargeback_status_updated_at": null,
    "payout_split_rules": [
      {
        "line_id": "411486491630370816",
        "line_amount_total": 10000,
        "line_amount_tax": 850,
        "splits": [
          {
            "user_id": "411486491630370816",
            "percentage": 5000,
            "platform_fee_percentage": 500
          }
        ]
      }
    ],
    "payout_split_results": [
      {
        "user_id": "411486491630370816",
        "gross_amount": 10000,
        "tax_amount": 850,
        "gateway_fee_amount": 320,
        "platform_fee_amount": 500,
        "connected_platform_fee_amount": 100,
        "net_amount": 8230,
        "line_id": "411486491630370816"
      }
    ],
    "created_at": "2025-04-01T15:30:45Z",
    "pending_at": "2025-04-01T15:30:46Z",
    "completed_at": "2025-04-01T15:31:12Z",
    "canceled_at": null,
    "failed_at": null,
    "refunded_at": null,
    "chargeback_at": null,
    "last_payment_error": {
      "decline_code": "unknown",
      "message": "text"
    }
  }
]

Get payment by ID

get

Retrieves a payment by an ID.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

paymentIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

Represents a payment transaction

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

order_idstring · flake-idRequiredExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

gatewaystringRequired

The payment gateway provider

Example: stripe

gateway_entity_identifierstringRequired

The gateway entity identifier

gateway_idstringRequired

The gateway payment identifier

method_idstring · flake-idOptionalExample: 411486491630370816

statusstring · enumRequired

Represents payment status

Possible values:

currencystringRequired

The currency code used for this payment in the store's currency

Example: usd

amountinteger · int32Required

The total payment amount in smallest currency unit

Example: 10000

gateway_fee_amountinteger · int32Required

The gateway fee amount in smallest currency unit

Example: 320

tax_amountinteger · int32Required

The tax amount in smallest currency unit

Example: 850

platform_fee_amountinteger · int32Required

The platform fee amount in smallest currency unit

Example: 500

store_net_amountinteger · int32Required

The net amount going to the store in smallest currency unit

Example: 8330

presentment_currencystringRequired

The currency code used for presentment to the customer

Example: eur

presentment_amountinteger · int32Required

The amount presented to the customer in smallest currency unit

Example: 9500

fx_ratenumber · nullableOptional

The foreign exchange rate used for currency conversion

Example: 1.085

platform_fee_rateinteger · int32Required

The platform fee rate applied to this payment (in basis points)

Example: 500

chargeback_statusstring · enumRequired

Represents chargeback status of a payment

Possible values:

chargeback_status_updated_atstring · nullableOptional

The date and time when the chargeback status was last updated

created_atstring · date-timeRequired

The date and time when this payment was created

Example: 2025-04-01T15:30:45Z

pending_atstring · nullableOptional

The date and time when this payment entered pending status

Example: 2025-04-01T15:30:46Z

completed_atstring · nullableOptional

The date and time when this payment was completed

Example: 2025-04-01T15:31:12Z

canceled_atstring · nullableOptional

The date and time when this payment was canceled

failed_atstring · nullableOptional

The date and time when this payment failed

refunded_atstring · nullableOptional

The date and time when this payment was last refunded

chargeback_atstring · nullableOptional

The date and time when a chargeback was initiated on this payment

default

Error response

application/json

get

/v1/stores/{storeId}/payments/{paymentId}

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/payments/{paymentId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "order_id": "411486491630370816",
  "customer_id": "411486491630370816",
  "customer": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "profile": {
      "id": "text",
      "platform": "steam",
      "name": "text",
      "avatar_url": null
    },
    "steam_id": "76561197960287930",
    "steam": {
      "id": "76561197960287930",
      "name": "text",
      "avatar_url": "text"
    },
    "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
    "minecraft": {
      "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "name": "notch",
      "avatar_url": "text"
    },
    "xbox_xuid": null,
    "minecraft_platform": "unknown",
    "name": "m0uka",
    "created_at": "2026-05-21T00:13:47.625Z",
    "updated_at": null,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "refunds": [
    {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "payment_id": "411486491630370816",
      "customer_id": "411486491630370816",
      "order_line_id": "411486491630370816",
      "status": "created",
      "failure_reason": null,
      "currency": "text",
      "amount": 1,
      "amount_str": "text",
      "gateway_fee_amount": 1,
      "gateway_fee_amount_str": "text",
      "tax_amount": 1,
      "tax_amount_str": "text",
      "platform_fee_amount": 1,
      "platform_fee_amount_str": "text",
      "store_net_amount": 1,
      "store_net_amount_str": "text",
      "store_refund_amount": 1,
      "store_refund_amount_str": "text",
      "presentment_currency": null,
      "presentment_amount": null,
      "fx_rate": null,
      "refund_from_connected_user_balance": true,
      "created_at": "2026-05-21T00:13:47.625Z",
      "approved_at": null,
      "pending_at": null,
      "completed_at": null,
      "canceled_at": null,
      "failed_at": null
    }
  ],
  "gateway": "stripe",
  "gateway_entity_identifier": "text",
  "gateway_id": "text",
  "method": {
    "id": "411486491630370816",
    "customer_id": "411486491630370816",
    "gateway": "text",
    "gateway_id": "text",
    "gateway_customer_id": "text",
    "gateway_type": "card",
    "method_type": "card",
    "method_details": {
      "card": {
        "brand": "visa",
        "country": "US",
        "exp_month": 12,
        "exp_year": 2028,
        "fingerprint": "abc123def456",
        "funding": "credit",
        "last4": "4242",
        "bin": 424242,
        "issuer": "Chase Bank",
        "description": "Visa Signature",
        "wallet": {
          "type": "apple_pay"
        }
      },
      "cashapp": {
        "buyer_id": "buyer_abc123",
        "cashtag": "$johndoe"
      },
      "paypal": {
        "payer_id": "PAYERID123",
        "payer_email": "[email protected]",
        "payer_name": "John Doe",
        "country": "US",
        "vault": true,
        "pending_vault_approval": false,
        "standalone_setup": false
      },
      "link": {
        "email": "[email protected]"
      },
      "crypto": {
        "crypto_currency": "BTC",
        "crypto_amount": "0.00150000",
        "total_paid": "0.00150000",
        "confirmations": 6
      },
      "steamskins": {
        "items": [
          {
            "id": "text",
            "app_id": 730,
            "name": "AK-47 | Redline",
            "price": 2500
          }
        ]
      },
      "ideal": {
        "bank": "abn_amro",
        "bic": "ABNANL2A",
        "iban_last4": 1234,
        "payer_name": "John Doe"
      },
      "p24": {
        "bank": "ing",
        "payer_name": "Jan Kowalski"
      },
      "bancontact": {
        "bank": "bnp_paribas",
        "bank_name": "BNP Paribas",
        "bic": "GEBABEBB",
        "iban_last4": 3456,
        "payer_name": "Jean Dupont"
      },
      "klarna": {
        "country": "SE",
        "method_category": "pay_later"
      },
      "alipay": {
        "buyer_id": "buyer_abc123",
        "fingerprint": "fingerprint_xyz789"
      },
      "pay_by_bank": {
        "bank_name": "Chase Bank",
        "bic": "CHASUS33",
        "country": "US",
        "payer_name": "John Smith"
      },
      "pix": {
        "bank_name": "Banco do Brasil",
        "bank_account_number": "12345-6",
        "payer_name": "João Silva"
      },
      "paysafecard": {
        "first_name": null,
        "last_name": null,
        "psc_id": null,
        "association_id": null
      }
    },
    "created_at": "2025-03-15T10:20:30Z",
    "gateway_entity_identifier": "text",
    "updated_at": "2025-03-20T14:30:00Z"
  },
  "method_id": "411486491630370816",
  "status": "unknown",
  "currency": "usd",
  "amount": 10000,
  "gateway_fee_amount": 320,
  "tax_amount": 850,
  "platform_fee_amount": 500,
  "store_net_amount": 8330,
  "presentment_currency": "eur",
  "presentment_amount": 9500,
  "fx_rate": 1.085,
  "platform_fee_rate": 500,
  "chargeback_status": "none",
  "chargeback_status_updated_at": null,
  "payout_split_rules": [
    {
      "line_id": "411486491630370816",
      "line_amount_total": 10000,
      "line_amount_tax": 850,
      "splits": [
        {
          "user_id": "411486491630370816",
          "percentage": 5000,
          "platform_fee_percentage": 500
        }
      ]
    }
  ],
  "payout_split_results": [
    {
      "user_id": "411486491630370816",
      "gross_amount": 10000,
      "tax_amount": 850,
      "gateway_fee_amount": 320,
      "platform_fee_amount": 500,
      "connected_platform_fee_amount": 100,
      "net_amount": 8230,
      "line_id": "411486491630370816"
    }
  ],
  "created_at": "2025-04-01T15:30:45Z",
  "pending_at": "2025-04-01T15:30:46Z",
  "completed_at": "2025-04-01T15:31:12Z",
  "canceled_at": null,
  "failed_at": null,
  "refunded_at": null,
  "chargeback_at": null,
  "last_payment_error": {
    "decline_code": "unknown",
    "message": "text"
  }
}