payment30 ops

API de Payment

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

Consultas

CONSULTA

adminBillingPaymentMethods

#

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

Argumentos

  • issuerId!
Devuelve[!]!
CONSULTA

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.

Argumentos

  • tenantId!
  • input!

    Por defecto

    {
  "provider": null,
  "environment": null,
  "enabled": null,
  "regionId": null,
  "search": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
Devuelve!
CONSULTA

instantPaymentMethods

#

Argumentos

  • input!
Devuelve[!]!
CONSULTA

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.

Devuelve[!]!
CONSULTA

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.

Argumentos

  • countryCodeString!

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

Devuelve[!]!
CONSULTA

paymentOptions

#

Argumentos

  • input!
Devuelve[!]!
CONSULTA

pspAccount

#

Get a single PSP account by ID (admin only)

Argumentos

  • idString!
Devuelve
CONSULTA

pspAccounts

#

List Tenant's PSP accounts (admin only)

Argumentos

  • input!

    Por defecto

    {
  "provider": null,
  "environment": null,
  "enabled": null,
  "regionId": null,
  "search": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
Devuelve!
CONSULTA

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.

Argumentos

  • countryCodes[String!]!

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

    Por defecto

    []
Devuelve[!]!
CONSULTA

savablePaymentOptions

#

Get all savable payment options available for the user

Argumentos

  • countryString
  • currencyString
  • amountMinorInt
  • device
Devuelve[!]!
CONSULTA

savedPaymentMethods

#

List saved payment methods for the current user.

Argumentos

  • limitInt!

    Por defecto

    20
  • offsetInt!

    Por defecto

    0
Devuelve!

Mutaciones

MUTACIÓN

addPaymentMethod

#

Argumentos

  • input!
Devuelve!
MUTACIÓN

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.

Argumentos

  • id!
DevuelveBoolean!
MUTACIÓN

adminRecordInvoicePayment

#

Record money received against an invoice (PlatformAdmin only).

Argumentos

  • input!
Devuelve!
MUTACIÓN

adminRemoveInvoicePayment

#

Remove a payment recorded in error (PlatformAdmin only).

Argumentos

  • input!
Devuelve!
MUTACIÓN

adminSaveBillingPaymentMethod

#

Create or update a payment method (PlatformAdmin only).

Argumentos

  • input!
Devuelve!
MUTACIÓN

beginAddPaymentMethod

#

Argumentos

  • input!
Devuelve!
MUTACIÓN

beginWalletTopUp

#

Argumentos

  • input!
Devuelve!
MUTACIÓN

completeAddPaymentMethod

#

Argumentos

  • input!
Devuelve!
MUTACIÓN

completeWalletTopUp

#

Argumentos

  • input!
Devuelve!
MUTACIÓN

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.

Argumentos

  • input!
Devuelve!
MUTACIÓN

createPspAccount

#

Argumentos

  • input!
Devuelve!
MUTACIÓN

deletePspAccount

#

Delete a PSP account (admin only)

Argumentos

  • idString!
DevuelveBoolean!
MUTACIÓN

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.

Argumentos

  • pspAccountIdString!
Devuelve!
MUTACIÓN

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.

Argumentos

  • idString!
Devuelve!
MUTACIÓN

refundPayment

#

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

Argumentos

  • input!
Devuelve!
MUTACIÓN

removePaymentMethod

#

Argumentos

  • idID!
DevuelveBoolean!
MUTACIÓN

setDefaultPaymentMethod

#

Argumentos

  • idID!
Devuelve!
MUTACIÓN

testPspAccount

#

Test PSP account connectivity (admin only)

Argumentos

  • idString!
Devuelve!
MUTACIÓN

updatePspAccount

#

Update a PSP account (admin only)

Argumentos

  • input!
Devuelve!