Payment Method Types

Get store payment method types

get

Retrieves all payment method types associated with a store

Authorizations

APIKey

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

idstringRequired

namestringRequired

logo_urlstring · nullableOptional

checkout_logo_url_lightstring · nullableOptional

checkout_logo_url_darkstring · nullableOptional

categorystringRequired

confirmationstringRequired

enabledbooleanRequired

refunds_supportedbooleanRequired

subscriptions_supportedbooleanRequired

kyc_requiredbooleanRequired

supported_currenciesstring[]Required

supported_settlement_currenciesstring[]Required

supported_countriesstring[]Required

revenue_usageinteger · int64Required

monthly_revenue_limitinteger · nullableOptional

default_monthly_revenue_limitinteger · nullableOptional

settlement_timestring · nullableOptional

min_transaction_amountinteger · nullableOptional

max_transaction_amountinteger · nullableOptional

b2c_supportedbooleanRequired

b2b_supportedbooleanRequired

approval_requiredbooleanRequired

approval_statusstring · enumOptionalPossible values:

approval_decline_reasonstring · nullableOptional

approval_requested_atstring · nullableOptional

approval_decided_atstring · nullableOptional

default

Error response

application/json

get/v1/stores/{storeId}/payment-method-types

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/payment-method-types HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "logo_url": null,
    "checkout_logo_url_light": null,
    "checkout_logo_url_dark": null,
    "category": "text",
    "confirmation": "text",
    "enabled": true,
    "refunds_supported": true,
    "subscriptions_supported": true,
    "kyc_required": true,
    "supported_currencies": [
      "text"
    ],
    "supported_settlement_currencies": [
      "text"
    ],
    "supported_countries": [
      "text"
    ],
    "gateways": [
      "invalid"
    ],
    "fee_overrides": [
      {
        "fee_percentage": 1,
        "fee_cents": 1,
        "countries": [
          "text"
        ]
      }
    ],
    "country_currency_mapping": [
      {
        "country": "text",
        "currencies": [
          "text"
        ]
      }
    ],
    "revenue_usage": 1,
    "monthly_revenue_limit": null,
    "default_monthly_revenue_limit": null,
    "settlement_time": null,
    "min_transaction_amount": null,
    "max_transaction_amount": null,
    "b2c_supported": true,
    "b2b_supported": true,
    "approval_required": true,
    "approval_status": "invalid",
    "approval_decline_reason": null,
    "approval_requested_at": null,
    "approval_decided_at": null
  }
]

Toggle a store payment method type

patch

Enables or disabled a payment method type for a store

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

paymentMethodTypeIdstringRequired

Body

application/jsontext/jsonapplication/*+json

enabledbooleanRequired

Responses

204

No Content

No content

default

Error response

application/json

patch/v1/stores/{storeId}/payment-method-types/{paymentMethodTypeId}/toggle

HTTPcURLJavaScriptPython

PATCH /v1/stores/{storeId}/payment-method-types/{paymentMethodTypeId}/toggle HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}

application/jsontext/jsonapplication/*+json

No content

Request approval for a store payment method type

post

Requests approval to use a payment method type that requires manual review

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

paymentMethodTypeIdstringRequired

Responses

204

No Content

No content

default

Error response

application/json

post/v1/stores/{storeId}/payment-method-types/{paymentMethodTypeId}/request-approval

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/payment-method-types/{paymentMethodTypeId}/request-approval HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

No content