Payments

Get payments

get

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: 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
get
/v1/stores/{storeId}/payments

Get payment by ID

get

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: 411486491630370816
paymentIdstring · flake-idRequiredExample: 411486491630370816
Responses
200

OK

application/json
get
/v1/stores/{storeId}/payments/{paymentId}

Get store payment settings

get

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: 411486491630370816
Responses
200

OK

application/json
get
/v1/stores/{storeId}/payments/settings

Updates store payment settings

patch

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: 411486491630370816
Body
show_all_payment_methods_for_subscriptionsbooleanOptional
store_tax_inclusive_pricingbooleanOptional
block_prepaid_cardsstring · enumOptional

Defines when prepaid cards should be blocked from use.

Possible values:
Responses
patch
/v1/stores/{storeId}/payments/settings

No content

Last updated

Was this helpful?