payment30 Ops

Payment API

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

Queries

QUERY

adminBillingPaymentMethods

#

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

Argumente

  • issuerId!
Gibt zurück[!]!
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.

Argumente

  • tenantId!
  • input!

    Standard

    {
      "provider": null,
      "environment": null,
      "enabled": null,
      "regionId": null,
      "search": null,
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      }
    }
Gibt zurück!
QUERY

instantPaymentMethods

#

Argumente

  • input!
Gibt zurück[!]!
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.

Gibt zurück[!]!
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.

Argumente

  • countryCodeString!

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

Gibt zurück[!]!
QUERY

paymentOptions

#

Argumente

  • input!
Gibt zurück[!]!
QUERY

pspAccount

#

Get a single PSP account by ID (admin only)

Argumente

  • idString!
Gibt zurück
QUERY

pspAccounts

#

List Tenant's PSP accounts (admin only)

Argumente

  • input!

    Standard

    {
      "provider": null,
      "environment": null,
      "enabled": null,
      "regionId": null,
      "search": null,
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      }
    }
Gibt zurück!
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.

Argumente

  • countryCodes[String!]!

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

    Standard

    []
Gibt zurück[!]!
QUERY

savablePaymentOptions

#

Get all savable payment options available for the user

Argumente

  • countryString
  • currencyString
  • amountMinorInt
  • device
Gibt zurück[!]!
QUERY

savedPaymentMethods

#

List saved payment methods for the current user.

Argumente

  • limitInt!

    Standard

    20
  • offsetInt!

    Standard

    0
Gibt zurück!

Mutations

MUTATION

addPaymentMethod

#

Argumente

  • input!
Gibt zurück!
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.

Argumente

  • id!
Gibt zurückBoolean!
MUTATION

adminRecordInvoicePayment

#

Record money received against an invoice (PlatformAdmin only).

Argumente

  • input!
Gibt zurück!
MUTATION

adminRemoveInvoicePayment

#

Remove a payment recorded in error (PlatformAdmin only).

Argumente

  • input!
Gibt zurück!
MUTATION

adminSaveBillingPaymentMethod

#

Create or update a payment method (PlatformAdmin only).

Argumente

  • input!
Gibt zurück!
MUTATION

beginAddPaymentMethod

#

Argumente

  • input!
Gibt zurück!
MUTATION

beginWalletTopUp

#

Argumente

  • input!
Gibt zurück!
MUTATION

completeAddPaymentMethod

#

Argumente

  • input!
Gibt zurück!
MUTATION

completeWalletTopUp

#

Argumente

  • input!
Gibt zurück!
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.

Argumente

  • input!
Gibt zurück!
MUTATION

createPspAccount

#

Argumente

  • input!
Gibt zurück!
MUTATION

deletePspAccount

#

Delete a PSP account (admin only)

Argumente

  • idString!
Gibt zurückBoolean!
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.

Argumente

  • pspAccountIdString!
Gibt zurück!
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.

Argumente

  • idString!
Gibt zurück!
MUTATION

refundPayment

#

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

Argumente

  • input!
Gibt zurück!
MUTATION

removePaymentMethod

#

Argumente

  • idID!
Gibt zurückBoolean!
MUTATION

setDefaultPaymentMethod

#

Argumente

  • idID!
Gibt zurück!
MUTATION

testPspAccount

#

Test PSP account connectivity (admin only)

Argumente

  • idString!
Gibt zurück!
MUTATION

updatePspAccount

#

Update a PSP account (admin only)

Argumente

  • input!
Gibt zurück!