FlintflintDocs

Payment method domains

Endpoints

The Payment method domain object#

Every field on a payment method domain, as returned by retrieve and carried by the endpoints below.

Attributes
created_atstringrequired

RFC3339 timestamp.

domain_namestringrequired
payment_method_domain_idstringrequired
payment_optionsarray of objectrequired
statusenumrequired
activeinactive
updated_atstringrequired

RFC3339 timestamp.

validation_statusenumrequired
activeaction_requiredunavailable

List payment method domains#

GET/v1/payment-method-domainsRequires scope: payments.payment_method_domains.read or payments.payment_method_domains.write

Returns payment method domains ordered by payment_method_domain_id ascending in the selected Flint environment. Page tokens are opaque, bind to the list parameters, and return a validation error when invalid or mismatched.

Query parameters
page_sizeinteger

Page size, default 20, max 100.

page_tokenstring

Cursor returned by the previous list response.

Response · 200
dataarray of objectrequired
metaobject
next_page_tokenstring
request_idstring

Error codes

AUTH_REQUIREDINSUFFICIENT_SCOPEINTERNAL_ERRORINVALID_PAGE_SIZEINVALID_PAGE_TOKENINVALID_REQUESTPAYMENT_METHOD_DOMAINS_UNAVAILABLERATE_LIMIT_EXCEEDEDUNSUPPORTED_QUERY_PARAM
Bash
curl https://api.withflintpay.com/v1/payment-method-domains \
  -H "Flint-Version: 2026-09-07" \
  -H "Authorization: Bearer YOUR_API_KEY"

Register payment method domain#

POST/v1/payment-method-domainsIdempotentRequires scope: payments.payment_method_domains.write

Registers one exact domain or subdomain for Apple Pay and Google Pay in the selected Flint environment, then validates its wallet readiness.

Request body
domain_namestringrequired

Exact fully-qualified hostname to register. Do not include a scheme, path, port, IP address, or wildcard.

Response · 201
dataobjectrequired
metaobject
request_idstring

Error codes

AUTH_REQUIREDIDEMPOTENCY_CLEAR_FAILEDIDEMPOTENCY_KEY_IN_PROGRESSIDEMPOTENCY_KEY_REUSEDIDEMPOTENCY_LOAD_FAILEDIDEMPOTENCY_PERSIST_FAILEDIDEMPOTENCY_RECOVERY_REQUIREDINSUFFICIENT_SCOPEINTERNAL_ERRORINVALID_DOMAIN_NAMEINVALID_IDEMPOTENCY_KEYINVALID_REQUESTMERCHANT_ACCOUNT_NOT_READYPAYMENT_METHOD_DOMAINS_UNAVAILABLEPAYMENT_METHOD_DOMAIN_ALREADY_EXISTSPAYMENT_METHOD_DOMAIN_REGISTRATION_FAILEDRATE_LIMIT_EXCEEDEDREQUEST_TIMEOUTSERVICE_UNAVAILABLE
Bash
curl -X POST https://api.withflintpay.com/v1/payment-method-domains \
  -H "Flint-Version: 2026-09-07" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: a-unique-key" \
  -d '{
    "domain_name": ""
  }'

Get payment method domain#

GET/v1/payment-method-domains/{payment_method_domain_id}Requires scope: payments.payment_method_domains.read or payments.payment_method_domains.write

Returns one environment-scoped payment method domain and its Apple Pay and Google Pay readiness.

Path parameters
payment_method_domain_idstringrequired

Flint payment method domain ID.

Response · 200
dataobjectrequired
metaobject
request_idstring

Error codes

AUTH_REQUIREDINSUFFICIENT_SCOPEINTERNAL_ERRORINVALID_REQUESTPAYMENT_METHOD_DOMAINS_UNAVAILABLEPAYMENT_METHOD_DOMAIN_NOT_FOUNDRATE_LIMIT_EXCEEDEDRESOURCE_NOT_FOUND
Bash
curl https://api.withflintpay.com/v1/payment-method-domains/{payment_method_domain_id} \
  -H "Flint-Version: 2026-09-07" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update payment method domain#

PATCH/v1/payment-method-domains/{payment_method_domain_id}IdempotentRequires scope: payments.payment_method_domains.write

Sets the domain registration status. Activating the domain also validates Apple Pay and Google Pay readiness.

Path parameters
payment_method_domain_idstringrequired

Flint payment method domain ID.

Request body
statusenumrequired
activeinactive
Response · 200
dataobjectrequired
metaobject
request_idstring

Error codes

AUTH_REQUIREDIDEMPOTENCY_CLEAR_FAILEDIDEMPOTENCY_KEY_IN_PROGRESSIDEMPOTENCY_KEY_REUSEDIDEMPOTENCY_LOAD_FAILEDIDEMPOTENCY_PERSIST_FAILEDIDEMPOTENCY_RECOVERY_REQUIREDINSUFFICIENT_SCOPEINTERNAL_ERRORINVALID_IDEMPOTENCY_KEYINVALID_REQUESTINVALID_STATUSMERCHANT_ACCOUNT_NOT_READYPAYMENT_METHOD_DOMAINS_UNAVAILABLEPAYMENT_METHOD_DOMAIN_NOT_FOUNDPAYMENT_METHOD_DOMAIN_OPERATION_IN_PROGRESSPAYMENT_METHOD_DOMAIN_REGISTRATION_FAILEDRATE_LIMIT_EXCEEDEDREQUEST_TIMEOUTRESOURCE_LIMIT_EXCEEDEDRESOURCE_NOT_FOUNDSERVICE_UNAVAILABLE
Bash
curl -X PATCH https://api.withflintpay.com/v1/payment-method-domains/{payment_method_domain_id} \
  -H "Flint-Version: 2026-09-07" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: a-unique-key" \
  -d '{
    "status": "active"
  }'
Rate this doc