Payments
Retrieves all payments for the specified store using the filter specified.
Authorizations
AuthorizationstringRequired
An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816Query parameters
limitinteger · int32 · min: 1 · max: 100Optional
The maximum number of items to return in a single request.
afterstring · flake-idOptionalExample:
Returns items after the specified ID. Used for forward pagination through results.
411486491630370816beforestring · flake-idOptionalExample:
Returns items before the specified ID. Used for backward pagination through results.
411486491630370816ascbooleanOptional
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-idOptionalExample:
Filter by order ID
411486491630370816customer_idstring · flake-idOptionalExample:
Filter by customer ID
411486491630370816Responses
200
OK
application/json
default
Error response
application/json
get
/v1/stores/{storeId}/paymentsGET /v1/stores/{storeId}/payments HTTP/1.1
Host:
Authorization: YOUR_API_KEY
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": "text"
},
"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": "text",
"minecraft_platform": "unknown",
"name": "m0uka",
"created_at": "2025-11-19T15:31:52.322Z",
"updated_at": "2025-11-19T15:31:52.322Z",
"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": "text",
"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": "text",
"presentment_amount": 1,
"fx_rate": "text",
"refund_from_connected_user_balance": true,
"created_at": "2025-11-19T15:31:52.322Z",
"approved_at": "2025-11-19T15:31:52.322Z",
"pending_at": "2025-11-19T15:31:52.322Z",
"completed_at": "2025-11-19T15:31:52.322Z",
"canceled_at": "2025-11-19T15:31:52.322Z",
"failed_at": "2025-11-19T15:31:52.322Z"
}
],
"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"
}
},
"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"
}
}
]Retrieves a payment by an ID.
Authorizations
AuthorizationstringRequired
An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816paymentIdstring · flake-idRequiredExample:
411486491630370816Responses
200
OK
application/json
default
Error response
application/json
get
/v1/stores/{storeId}/payments/{paymentId}GET /v1/stores/{storeId}/payments/{paymentId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
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": "text"
},
"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": "text",
"minecraft_platform": "unknown",
"name": "m0uka",
"created_at": "2025-11-19T15:31:52.322Z",
"updated_at": "2025-11-19T15:31:52.322Z",
"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": "text",
"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": "text",
"presentment_amount": 1,
"fx_rate": "text",
"refund_from_connected_user_balance": true,
"created_at": "2025-11-19T15:31:52.322Z",
"approved_at": "2025-11-19T15:31:52.322Z",
"pending_at": "2025-11-19T15:31:52.322Z",
"completed_at": "2025-11-19T15:31:52.322Z",
"canceled_at": "2025-11-19T15:31:52.322Z",
"failed_at": "2025-11-19T15:31:52.322Z"
}
],
"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"
}
},
"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"
}
}Retrieves payment settings for a store.
Authorizations
AuthorizationstringRequired
An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816Responses
200
OK
application/json
default
Error response
application/json
get
/v1/stores/{storeId}/payments/settingsGET /v1/stores/{storeId}/payments/settings HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"show_all_payment_methods_for_subscriptions": true,
"store_tax_inclusive_pricing": true,
"block_prepaid_cards": "unspecified",
"max_checkout_amount": 1,
"force_3d_secure": true,
"chargeback_coverage": "unspecified",
"chargeback_coverage_max_amount": 1
}Updates payment settings for a store.
Authorizations
AuthorizationstringRequired
An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816Body
show_all_payment_methods_for_subscriptionsbooleanOptional
store_tax_inclusive_pricingbooleanOptional
block_prepaid_cardsstring · enumOptionalPossible values:
Defines when prepaid cards should be blocked from use.
Responses
204
No Content
default
Error response
application/json
patch
/v1/stores/{storeId}/payments/settingsPATCH /v1/stores/{storeId}/payments/settings HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 122
{
"show_all_payment_methods_for_subscriptions": true,
"store_tax_inclusive_pricing": true,
"block_prepaid_cards": "unspecified"
}No content
Last updated
Was this helpful?