payment30 عملية

Payment API

Payment methods, payment service providers, top-ups, refunds, and gateway adapters.

Queries

QUERY

adminBillingPaymentMethods

#

An issuer's active payment methods (PlatformAdmin only).

الوسائط

  • issuerId!
يُرجع[!]!
QUERY

adminTenantPspAccounts

#

List the PSP accounts of a specific tenant (PlatformAdmin only). Mirrors pspAccounts but takes the target tenant from the argument instead of the request context, so platform admins can inspect a tenant they're not impersonating. Used by the admin tenant detail page.

الوسائط

  • tenantId!
  • input!

    افتراضي

    {
  "provider": null,
  "environment": null,
  "enabled": null,
  "regionId": null,
  "search": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
يُرجع!
QUERY

instantPaymentMethods

#

الوسائط

  • input!
يُرجع[!]!
QUERY

paymentGatewayCoverage

#

Full PSP coverage matrix: every PSP with its supported countries, brand name, and whether this deployment can actually charge through it. Intended for marketing "by region" views.

يُرجع[!]!
QUERY

paymentGatewaysForCountry

#

Payment gateways (PSPs) available in the given country. country_code must be an ISO 3166-1 alpha-2 code (case-insensitive). Returns an empty list for unknown country codes.

الوسائط

  • countryCodeString!

    ISO 3166-1 alpha-2 country code (e.g. "KW", "US").

يُرجع[!]!
QUERY

paymentOptions

#

الوسائط

  • input!
يُرجع[!]!
QUERY

pspAccount

#

Get a single PSP account by ID (admin only)

الوسائط

  • idString!
يُرجع
QUERY

pspAccounts

#

List Tenant's PSP accounts (admin only)

الوسائط

  • input!

    افتراضي

    {
  "provider": null,
  "environment": null,
  "enabled": null,
  "regionId": null,
  "search": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
يُرجع!
QUERY

pspProviderCatalog

#

Every payment gateway, ranked for the given countries. Pass the tenant's operating countries (from myOperationFootprint) to get a coverage verdict per gateway and a recommendation. Pass an empty list to get the bare catalog — capabilities and credential schemas, with no ranking. Returns credential *schemas*, never credential values.

الوسائط

  • countryCodes[String!]!

    ISO 3166-1 alpha-2 codes the gateway must serve, e.g. ["GB", "SA"].

    افتراضي

    []
يُرجع[!]!
QUERY

savablePaymentOptions

#

Get all savable payment options available for the user

الوسائط

  • countryString
  • currencyString
  • amountMinorInt
  • device
يُرجع[!]!
QUERY

savedPaymentMethods

#

List saved payment methods for the current user.

الوسائط

  • limitInt!

    افتراضي

    20
  • offsetInt!

    افتراضي

    0
يُرجع!

Mutations

MUTATION

addPaymentMethod

#

الوسائط

  • input!
يُرجع!
MUTATION

adminArchiveBillingPaymentMethod

#

Archive a payment method (PlatformAdmin only). Never a hard delete: issued invoices reference it, and the details a client was actually given live in the invoice's own snapshot.

الوسائط

  • id!
يُرجعBoolean!
MUTATION

adminRecordInvoicePayment

#

Record money received against an invoice (PlatformAdmin only).

الوسائط

  • input!
يُرجع!
MUTATION

adminRemoveInvoicePayment

#

Remove a payment recorded in error (PlatformAdmin only).

الوسائط

  • input!
يُرجع!
MUTATION

adminSaveBillingPaymentMethod

#

Create or update a payment method (PlatformAdmin only).

الوسائط

  • input!
يُرجع!
MUTATION

beginAddPaymentMethod

#

الوسائط

  • input!
يُرجع!
MUTATION

beginWalletTopUp

#

الوسائط

  • input!
يُرجع!
MUTATION

completeAddPaymentMethod

#

الوسائط

  • input!
يُرجع!
MUTATION

completeWalletTopUp

#

الوسائط

  • input!
يُرجع!
MUTATION

confirmWalletTopUp

#

Confirm a wallet top-up after the client finished the Stripe flow. Polls the PSP for PI status and credits the wallet when captured. Idempotent — safe to call multiple times and to race with the webhook.

الوسائط

  • input!
يُرجع!
MUTATION

createPspAccount

#

الوسائط

  • input!
يُرجع!
MUTATION

deletePspAccount

#

Delete a PSP account (admin only)

الوسائط

  • idString!
يُرجعBoolean!
MUTATION

provisionPspWebhook

#

Register a webhook endpoint at the PSP and persist the returned signing secret on this PSP account. Used by the admin console's "Provision automatically" button so tenants don't have to touch the Stripe Dashboard. Admin-only.

الوسائط

  • pspAccountIdString!
يُرجع!
MUTATION

refreshPspAccountCapabilities

#

Re-fetch this PSP account's enabled payment-method capabilities from the PSP and persist them (admin only). Returns the refreshed account so the client sees the updated capabilitiesRefreshedAt and paymentMethodCapabilities in one round-trip.

الوسائط

  • idString!
يُرجع!
MUTATION

refundPayment

#

Issue a refund for a previously captured payment. Admin only.

الوسائط

  • input!
يُرجع!
MUTATION

removePaymentMethod

#

الوسائط

  • idID!
يُرجعBoolean!
MUTATION

setDefaultPaymentMethod

#

الوسائط

  • idID!
يُرجع!
MUTATION

testPspAccount

#

Test PSP account connectivity (admin only)

الوسائط

  • idString!
يُرجع!
MUTATION

updatePspAccount

#

Update a PSP account (admin only)

الوسائط

  • input!
يُرجع!