paymentGatewayProviders

Requires permission settings:integration:read.

Lists the payment providers ARC supports, with the credential fields each one needs and the webhook URL to register in that provider's dashboard for your organization.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PaymentGatewayProviders {
  paymentGatewayProviders {
    displayName
    provider
    webhookUrl
    credentialFields {
      helpText
      key
      label
      placeholder
      secret
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PaymentGatewayProviders {\n  paymentGatewayProviders {\n    displayName\n    provider\n    webhookUrl\n    credentialFields {\n      helpText\n      key\n      label\n      placeholder\n      secret\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "paymentGatewayProviders": [
      {
        "displayName": "string",
        "provider": "PEACH",
        "webhookUrl": "string",
        "credentialFields": [
          {
            "helpText": "string",
            "key": "string",
            "label": "string",
            "placeholder": "string",
            "secret": true
          }
        ]
      }
    ]
  }
}

paymentGatewayProviders: [PaymentGatewayProviderInfo!]!

Type

PaymentGatewayProviderInfo object

A payment provider the organization can connect, and the credentials it needs.