FlintflintDocs

Payment method domains

Endpoints

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 "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 "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 "Authorization: Bearer YOUR_API_KEY"

Activate payment method domain#

POST/v1/payment-method-domains/{payment_method_domain_id}/activateIdempotentRequires scope: payments.payment_method_domains.write

Activates the domain registration and validates 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_REQUIREDIDEMPOTENCY_CLEAR_FAILEDIDEMPOTENCY_KEY_IN_PROGRESSIDEMPOTENCY_KEY_REUSEDIDEMPOTENCY_LOAD_FAILEDIDEMPOTENCY_PERSIST_FAILEDIDEMPOTENCY_RECOVERY_REQUIREDINSUFFICIENT_SCOPEINTERNAL_ERRORINVALID_IDEMPOTENCY_KEYINVALID_REQUESTMERCHANT_ACCOUNT_NOT_READYPAYMENT_METHOD_DOMAINS_UNAVAILABLEPAYMENT_METHOD_DOMAIN_NOT_FOUNDPAYMENT_METHOD_DOMAIN_OPERATION_IN_PROGRESSPAYMENT_METHOD_DOMAIN_REGISTRATION_FAILEDRATE_LIMIT_EXCEEDEDREQUEST_TIMEOUTRESOURCE_NOT_FOUNDSERVICE_UNAVAILABLEUNSUPPORTED_REQUEST_BODY
Bash
curl -X POST https://api.withflintpay.com/v1/payment-method-domains/{payment_method_domain_id}/activate \
  -H "Authorization: Bearer YOUR_API_KEY"

Deactivate payment method domain#

POST/v1/payment-method-domains/{payment_method_domain_id}/deactivateIdempotentRequires scope: payments.payment_method_domains.write

Deactivates the domain registration without deleting its Flint identity.

Path parameters
payment_method_domain_idstringrequired

Flint payment method domain ID.

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_REQUESTMERCHANT_ACCOUNT_NOT_READYPAYMENT_METHOD_DOMAINS_UNAVAILABLEPAYMENT_METHOD_DOMAIN_NOT_FOUNDPAYMENT_METHOD_DOMAIN_OPERATION_IN_PROGRESSPAYMENT_METHOD_DOMAIN_REGISTRATION_FAILEDRATE_LIMIT_EXCEEDEDREQUEST_TIMEOUTRESOURCE_NOT_FOUNDSERVICE_UNAVAILABLEUNSUPPORTED_REQUEST_BODY
Bash
curl -X POST https://api.withflintpay.com/v1/payment-method-domains/{payment_method_domain_id}/deactivate \
  -H "Authorization: Bearer YOUR_API_KEY"

Validate payment method domain#

POST/v1/payment-method-domains/{payment_method_domain_id}/validateIdempotentRequires scope: payments.payment_method_domains.write

Revalidates Apple Pay and Google Pay readiness for an active domain registration.

Path parameters
payment_method_domain_idstringrequired

Flint payment method domain ID.

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_REQUESTMERCHANT_ACCOUNT_NOT_READYPAYMENT_METHOD_DOMAINS_UNAVAILABLEPAYMENT_METHOD_DOMAIN_INACTIVEPAYMENT_METHOD_DOMAIN_NOT_FOUNDPAYMENT_METHOD_DOMAIN_OPERATION_IN_PROGRESSPAYMENT_METHOD_DOMAIN_REGISTRATION_FAILEDRATE_LIMIT_EXCEEDEDREQUEST_TIMEOUTRESOURCE_NOT_FOUNDSERVICE_UNAVAILABLEUNSUPPORTED_REQUEST_BODY
Bash
curl -X POST https://api.withflintpay.com/v1/payment-method-domains/{payment_method_domain_id}/validate \
  -H "Authorization: Bearer YOUR_API_KEY"
Rate this doc