Payment method domains
The Payment method domain object#
Every field on a payment method domain, as returned by retrieve and carried by the endpoints below.
Attributes
created_atstringRequiredRFC3339 timestamp.
domain_namestringRequiredpayment_method_domain_idstringRequiredpayment_optionsarray of objectRequiredpayment_optionenumRequiredapple_paygoogle_pay
statusenumRequiredactiveinactiveunavailable
statusenumRequiredactiveinactive
updated_atstringRequiredRFC3339 timestamp.
validation_statusenumRequiredactiveaction_requiredunavailable
List payment method domains#
/v1/payment-method-domainsReturns 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_sizeintegerPage size, default 20, max 100.
page_tokenstringCursor returned by the previous list response.
Response · 200
dataarray of objectRequiredcreated_atstringRequiredRFC3339 timestamp.
domain_namestringRequiredpayment_method_domain_idstringRequiredpayment_optionsarray of objectRequiredstatusenumRequiredactiveinactive
updated_atstringRequiredRFC3339 timestamp.
validation_statusenumRequiredactiveaction_requiredunavailable
metaobjectapi_versionstringidempotency_replayedbooleanrequest_idstringtrace_idstringwarningsarray of objectnext_page_tokenstringrequest_idstring- AMBIGUOUS_AUTH
- API_KEY_EXPIRED
- API_KEY_MODE_MISMATCH
- API_KEY_NOT_FOUND
- API_KEY_REQUIRED
- API_KEY_REVOKED
- API_KEY_SANDBOX_UNAVAILABLE
- API_KEY_SCOPE_UNSUPPORTED
- API_VERSION_RETIRED
- AUTH_UNAVAILABLE
- AUTH_VALIDATION_FAILED
- DEFAULT_ENVIRONMENT_REQUIRED
- DEMO_SESSION_ROUTE_NOT_ALLOWED
- ENVIRONMENT_LOOKUP_FAILED
- ENVIRONMENT_REQUIRED
- EXTERNAL_API_KEY_REQUIRED
- INSUFFICIENT_SCOPE
- INTERNAL_ERROR
- INVALID_API_KEY
- INVALID_API_VERSION
- INVALID_AUTHORIZATION_HEADER
- INVALID_BEARER_TOKEN
- INVALID_EXPAND
- INVALID_JSON
- INVALID_MODE
- INVALID_OAUTH_TOKEN
- INVALID_PAGE_SIZE
- INVALID_PAGE_TOKEN
- INVALID_REQUEST
- MERCHANT_ACCESS_REQUIRED
- OAUTH_CONTEXT_MISMATCH
- OAUTH_UNAVAILABLE
- ORG_SCOPE_RESOLUTION_FAILED
- PARTNER_AUTH_UNSUPPORTED
- PAYMENT_METHOD_DOMAINS_UNAVAILABLE
- RATE_LIMIT_EXCEEDED
- REQUEST_BODY_TOO_LARGE
- SANDBOX_SELECTION_REQUIRED
- UNSUPPORTED_QUERY_PARAM
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#
/v1/payment-method-domainsIdempotentRegisters one exact domain or subdomain for Apple Pay and Google Pay in the selected Flint environment, then validates its wallet readiness.
Request body
domain_namestringRequiredExact fully-qualified hostname to register. Do not include a scheme, path, port, IP address, or wildcard.
Response · 201
dataobjectRequiredcreated_atstringRequiredRFC3339 timestamp.
domain_namestringRequiredpayment_method_domain_idstringRequiredpayment_optionsarray of objectRequiredstatusenumRequiredactiveinactive
updated_atstringRequiredRFC3339 timestamp.
validation_statusenumRequiredactiveaction_requiredunavailable
metaobjectapi_versionstringidempotency_replayedbooleanrequest_idstringtrace_idstringwarningsarray of objectrequest_idstring- AMBIGUOUS_AUTH
- API_KEY_EXPIRED
- API_KEY_MODE_MISMATCH
- API_KEY_NOT_FOUND
- API_KEY_REQUIRED
- API_KEY_REVOKED
- API_KEY_SANDBOX_UNAVAILABLE
- API_KEY_SCOPE_UNSUPPORTED
- API_VERSION_RETIRED
- AUTH_UNAVAILABLE
- AUTH_VALIDATION_FAILED
- DEFAULT_ENVIRONMENT_REQUIRED
- DEMO_SESSION_ROUTE_NOT_ALLOWED
- ENVIRONMENT_LOOKUP_FAILED
- ENVIRONMENT_REQUIRED
- EXTERNAL_API_KEY_REQUIRED
- IDEMPOTENCY_CLEAR_FAILED
- IDEMPOTENCY_KEY_IN_PROGRESS
- IDEMPOTENCY_KEY_REUSED
- IDEMPOTENCY_LOAD_FAILED
- IDEMPOTENCY_PERSIST_FAILED
- IDEMPOTENCY_RECOVERY_REQUIRED
- INSUFFICIENT_SCOPE
- INTERNAL_ERROR
- INVALID_API_KEY
- INVALID_API_VERSION
- INVALID_AUTHORIZATION_HEADER
- INVALID_BEARER_TOKEN
- INVALID_DOMAIN_NAME
- INVALID_EXPAND
- INVALID_IDEMPOTENCY_KEY
- INVALID_JSON
- INVALID_MODE
- INVALID_OAUTH_TOKEN
- INVALID_REQUEST
- MERCHANT_ACCESS_REQUIRED
- MERCHANT_ACCOUNT_NOT_READY
- OAUTH_CONTEXT_MISMATCH
- OAUTH_UNAVAILABLE
- ORG_SCOPE_RESOLUTION_FAILED
- PARTNER_AUTH_UNSUPPORTED
- PAYMENT_METHOD_DOMAINS_UNAVAILABLE
- PAYMENT_METHOD_DOMAIN_ALREADY_EXISTS
- PAYMENT_METHOD_DOMAIN_REGISTRATION_FAILED
- RATE_LIMIT_EXCEEDED
- REQUEST_BODY_TOO_LARGE
- REQUEST_TIMEOUT
- SANDBOX_SELECTION_REQUIRED
- SERVICE_UNAVAILABLE
- UNSUPPORTED_CONTENT_TYPE
- UNSUPPORTED_QUERY_PARAM
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#
/v1/payment-method-domains/{payment_method_domain_id}Returns one environment-scoped payment method domain and its Apple Pay and Google Pay readiness.
Path parameters
payment_method_domain_idstringRequiredFlint payment method domain ID.
Response · 200
Same response as Register payment method domain.
- AMBIGUOUS_AUTH
- API_KEY_EXPIRED
- API_KEY_MODE_MISMATCH
- API_KEY_NOT_FOUND
- API_KEY_REQUIRED
- API_KEY_REVOKED
- API_KEY_SANDBOX_UNAVAILABLE
- API_KEY_SCOPE_UNSUPPORTED
- API_VERSION_RETIRED
- AUTH_UNAVAILABLE
- AUTH_VALIDATION_FAILED
- DEFAULT_ENVIRONMENT_REQUIRED
- DEMO_SESSION_ROUTE_NOT_ALLOWED
- ENVIRONMENT_LOOKUP_FAILED
- ENVIRONMENT_REQUIRED
- EXTERNAL_API_KEY_REQUIRED
- INSUFFICIENT_SCOPE
- INTERNAL_ERROR
- INVALID_API_KEY
- INVALID_API_VERSION
- INVALID_AUTHORIZATION_HEADER
- INVALID_BEARER_TOKEN
- INVALID_EXPAND
- INVALID_JSON
- INVALID_MODE
- INVALID_OAUTH_TOKEN
- INVALID_REQUEST
- MERCHANT_ACCESS_REQUIRED
- OAUTH_CONTEXT_MISMATCH
- OAUTH_UNAVAILABLE
- ORG_SCOPE_RESOLUTION_FAILED
- PARTNER_AUTH_UNSUPPORTED
- PAYMENT_METHOD_DOMAINS_UNAVAILABLE
- PAYMENT_METHOD_DOMAIN_NOT_FOUND
- RATE_LIMIT_EXCEEDED
- REQUEST_BODY_TOO_LARGE
- RESOURCE_NOT_FOUND
- SANDBOX_SELECTION_REQUIRED
- UNSUPPORTED_QUERY_PARAM
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#
/v1/payment-method-domains/{payment_method_domain_id}IdempotentSets the domain registration status. Activating the domain also validates Apple Pay and Google Pay readiness.
Path parameters
payment_method_domain_idstringRequiredFlint payment method domain ID.
Request body
statusenumRequiredactiveinactive
Response · 200
Same response as Register payment method domain.
- AMBIGUOUS_AUTH
- API_KEY_EXPIRED
- API_KEY_MODE_MISMATCH
- API_KEY_NOT_FOUND
- API_KEY_REQUIRED
- API_KEY_REVOKED
- API_KEY_SANDBOX_UNAVAILABLE
- API_KEY_SCOPE_UNSUPPORTED
- API_VERSION_RETIRED
- AUTH_UNAVAILABLE
- AUTH_VALIDATION_FAILED
- DEFAULT_ENVIRONMENT_REQUIRED
- DEMO_SESSION_ROUTE_NOT_ALLOWED
- ENVIRONMENT_LOOKUP_FAILED
- ENVIRONMENT_REQUIRED
- EXTERNAL_API_KEY_REQUIRED
- IDEMPOTENCY_CLEAR_FAILED
- IDEMPOTENCY_KEY_IN_PROGRESS
- IDEMPOTENCY_KEY_REUSED
- IDEMPOTENCY_LOAD_FAILED
- IDEMPOTENCY_PERSIST_FAILED
- IDEMPOTENCY_RECOVERY_REQUIRED
- INSUFFICIENT_SCOPE
- INTERNAL_ERROR
- INVALID_API_KEY
- INVALID_API_VERSION
- INVALID_AUTHORIZATION_HEADER
- INVALID_BEARER_TOKEN
- INVALID_EXPAND
- INVALID_IDEMPOTENCY_KEY
- INVALID_JSON
- INVALID_MODE
- INVALID_OAUTH_TOKEN
- INVALID_REQUEST
- INVALID_STATUS
- MERCHANT_ACCESS_REQUIRED
- MERCHANT_ACCOUNT_NOT_READY
- OAUTH_CONTEXT_MISMATCH
- OAUTH_UNAVAILABLE
- ORG_SCOPE_RESOLUTION_FAILED
- PARTNER_AUTH_UNSUPPORTED
- PAYMENT_METHOD_DOMAINS_UNAVAILABLE
- PAYMENT_METHOD_DOMAIN_NOT_FOUND
- PAYMENT_METHOD_DOMAIN_OPERATION_IN_PROGRESS
- PAYMENT_METHOD_DOMAIN_REGISTRATION_FAILED
- RATE_LIMIT_EXCEEDED
- REQUEST_BODY_TOO_LARGE
- REQUEST_TIMEOUT
- RESOURCE_NOT_FOUND
- SANDBOX_SELECTION_REQUIRED
- SERVICE_UNAVAILABLE
- UNSUPPORTED_CONTENT_TYPE
- UNSUPPORTED_QUERY_PARAM
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"
}'Was this helpful?
