docs(payments): document connector object in payment-method responses (#156527)

docs/developers/apis/get-payment-methods.StatusCodes.json

@@ -1 +1 @@
-{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_payment_methods":{"type":"array","items":{},"description":"Denotes a collection of payment gateways which used by user in successful payment attempts."},"payment_methods":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","readOnly":true,"description":"Indicates the unique code associated with the payment gateway. This pivotal identifier facilitates transaction initiation through both the dashboard and API."},"name":{"type":"string","readOnly":true,"description":"Represents the payment gateway internal name defined in Ottu."},"is_sandbox":{"type":"boolean","readOnly":true,"description":"Indicates whether this payment gateway operates in a sandbox or production environment."},"logo":{"type":"string","format":"uri"},"wallets":{"type":"array","items":{},"readOnly":true,"default":["ApplePay","GooglePay"],"description":"Denotes a list of payment services linked with this payment gateway, such as `GooglePay` and `ApplePay`"},"payment_services":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Code to identify the service in the API/URLs/etc","maxLength":16,"pattern":"^[-a-zA-Z0-9_]+$"},"name":{"type":"string","description":"Name to be displayed in dropdown or anywhere else the settings are being displayed. IE: Apple Pay, Google Pay, etc","maxLength":16},"name_ar":{"type":"string","title":"Arabic Name","description":"Arabic Name to be displayed in dropdown or anywhere else the settings are being displayed. IE: Apple Pay, Google Pay, etc","maxLength":16}},"required":["code","name"],"title":"PaymentServiceListing"},"readOnly":true,"description":"Active payment services linked to this payment gateway — device payment services (Apple Pay, Google Pay, Samsung Pay, ...) and wallet providers (Ottu, Qitaf, ...). Each entry exposes the service `code` and `name`."},"default_currency":{"type":"string","readOnly":true,"default":"KWD","description":"Specifies the default currency code for the payment gateway, formatted according to ISO 4217."},"accepted_currencies":{"type":"array","items":{},"readOnly":true,"default":["KWD","USD"],"description":"Indicates a list of default accepted currencies for the payment gateway, each formatted in accordance with ISO 4217 standards."},"operation":{"type":"string","description":"Specifies the processing operation type for the payment method: either 'authorize' or 'purchase'. When set to `authorize`, successful transactions using this payment method will transition to the `authorize` state. Similarly, if set to `purchase`, they will follow the purchase flow."},"operations":{"type":"array","items":{},"default":["refund","void"],"readOnly":true,"description":"Specifies the payment operations that are available for this payment gateway."},"is_tokenizable":{"type":"boolean","description":"This flag indicates whether tokenization is enabled for this payment gateway. When set to true, it allows for the secure storage of payment details, enabling future transactions without the need for re-entering payment information."},"auto_debit_enabled":{"type":"boolean","description":"This flag indicates whether auto-debit operation enabled or not."},"tags":{"type":"array","items":{"enum":["e_commerce","crm","pos","invoicing","subscriptions","marketplace","mobile_app","ticket_booking","donations","government","education","healthcare","insurance","logistics","hospitality","real_estate","retail","telecom","utilities","demo","test"],"type":"string","description":"* `e_commerce` - e_commerce\n* `crm` - crm\n* `pos` - pos\n* `invoicing` - invoicing\n* `subscriptions` - subscriptions\n* `marketplace` - marketplace\n* `mobile_app` - mobile_app\n* `ticket_booking` - ticket_booking\n* `donations` - donations\n* `government` - government\n* `education` - education\n* `healthcare` - healthcare\n* `insurance` - insurance\n* `logistics` - logistics\n* `hospitality` - hospitality\n* `real_estate` - real_estate\n* `retail` - retail\n* `telecom` - telecom\n* `utilities` - utilities\n* `demo` - demo\n* `test` - test","x-spec-enum-id":"397e40e715a6be71"},"readOnly":true,"description":"Business vertical tags assigned to this payment method."}},"required":["accepted_currencies","auto_debit_enabled","code","default_currency","is_sandbox","is_tokenizable","logo","name","operation","operations","payment_services","tags","wallets"],"title":"PGPaymentMethods"},"description":"Provides a comprehensive overview of the available payment gateways, delineated as distinct payment methods."}},"title":"PaymentMethodsResponse"}}},"description":""},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"field_name":{"type":"array","items":{"type":"string","default":"This field is required."}}},"title":"FieldErrors"}}},"description":""},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}},"required":["detail"],"title":"GenericErrorMessage"}}},"description":""}}}
+{"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_payment_methods":{"type":"array","items":{},"description":"Denotes a collection of payment gateways which used by user in successful payment attempts."},"payment_methods":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","readOnly":true,"description":"Indicates the unique code associated with the payment gateway. This pivotal identifier facilitates transaction initiation through both the dashboard and API."},"name":{"type":"string","readOnly":true,"description":"Represents the payment gateway internal name defined in Ottu."},"connector":{"allOf":[{"type":"object","description":"Identifies the payment method's underlying gateway integration and the processor it routes through. Present on every payment-method entry, giving consumers a stable connector identity that is independent of the merchant-renamable `code`.","properties":{"identifier":{"type":"string","readOnly":true,"description":"The stable, unique identifier of the connector, such as `knet`, `kpay`, `cybersource`, or `csuc`. It does not change, so use it to reliably detect one specific gateway."},"processor":{"type":"string","readOnly":true,"description":"The processor the connector routes through, such as `knet` or `cybersource`. Equal to `identifier` for most connectors; differs only when several connectors share one processor (for example `kpay` routes through `knet`, and `csuc` routes through `cybersource`)."}},"required":["identifier","processor"],"title":"Connector"}],"readOnly":true,"description":"The connector behind this payment method — its unique `identifier` and the `processor` it routes through. See [Connector](/developers/payments/payment-methods/#connector) for the identifier-vs-processor concept."},"is_sandbox":{"type":"boolean","readOnly":true,"description":"Indicates whether this payment gateway operates in a sandbox or production environment."},"logo":{"type":"string","format":"uri"},"wallets":{"type":"array","items":{},"readOnly":true,"default":["ApplePay","GooglePay"],"description":"Denotes a list of payment services linked with this payment gateway, such as `GooglePay` and `ApplePay`"},"payment_services":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Code to identify the service in the API/URLs/etc","maxLength":16,"pattern":"^[-a-zA-Z0-9_]+$"},"name":{"type":"string","description":"Name to be displayed in dropdown or anywhere else the settings are being displayed. IE: Apple Pay, Google Pay, etc","maxLength":16},"name_ar":{"type":"string","title":"Arabic Name","description":"Arabic Name to be displayed in dropdown or anywhere else the settings are being displayed. IE: Apple Pay, Google Pay, etc","maxLength":16}},"required":["code","name"],"title":"PaymentServiceListing"},"readOnly":true,"description":"Active payment services linked to this payment gateway — device payment services (Apple Pay, Google Pay, Samsung Pay, ...) and wallet providers (Ottu, Qitaf, ...). Each entry exposes the service `code` and `name`."},"default_currency":{"type":"string","readOnly":true,"default":"KWD","description":"Specifies the default currency code for the payment gateway, formatted according to ISO 4217."},"accepted_currencies":{"type":"array","items":{},"readOnly":true,"default":["KWD","USD"],"description":"Indicates a list of default accepted currencies for the payment gateway, each formatted in accordance with ISO 4217 standards."},"operation":{"type":"string","description":"Specifies the processing operation type for the payment method: either 'authorize' or 'purchase'. When set to `authorize`, successful transactions using this payment method will transition to the `authorize` state. Similarly, if set to `purchase`, they will follow the purchase flow."},"operations":{"type":"array","items":{},"default":["refund","void"],"readOnly":true,"description":"Specifies the payment operations that are available for this payment gateway."},"is_tokenizable":{"type":"boolean","description":"This flag indicates whether tokenization is enabled for this payment gateway. When set to true, it allows for the secure storage of payment details, enabling future transactions without the need for re-entering payment information."},"auto_debit_enabled":{"type":"boolean","description":"This flag indicates whether auto-debit operation enabled or not."},"tags":{"type":"array","items":{"enum":["e_commerce","crm","pos","invoicing","subscriptions","marketplace","mobile_app","ticket_booking","donations","government","education","healthcare","insurance","logistics","hospitality","real_estate","retail","telecom","utilities","demo","test"],"type":"string","description":"* `e_commerce` - e_commerce\n* `crm` - crm\n* `pos` - pos\n* `invoicing` - invoicing\n* `subscriptions` - subscriptions\n* `marketplace` - marketplace\n* `mobile_app` - mobile_app\n* `ticket_booking` - ticket_booking\n* `donations` - donations\n* `government` - government\n* `education` - education\n* `healthcare` - healthcare\n* `insurance` - insurance\n* `logistics` - logistics\n* `hospitality` - hospitality\n* `real_estate` - real_estate\n* `retail` - retail\n* `telecom` - telecom\n* `utilities` - utilities\n* `demo` - demo\n* `test` - test","x-spec-enum-id":"397e40e715a6be71"},"readOnly":true,"description":"Business vertical tags assigned to this payment method."}},"required":["accepted_currencies","auto_debit_enabled","code","connector","default_currency","is_sandbox","is_tokenizable","logo","name","operation","operations","payment_services","tags","wallets"],"title":"PGPaymentMethods"},"description":"Provides a comprehensive overview of the available payment gateways, delineated as distinct payment methods."}},"title":"PaymentMethodsResponse"}}},"description":""},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"field_name":{"type":"array","items":{"type":"string","default":"This field is required."}}},"title":"FieldErrors"}}},"description":""},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}},"required":["detail"],"title":"GenericErrorMessage"}}},"description":""}}}