> For the complete documentation index, see [llms.txt](https://docs.ecommerce.seb.ee/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ecommerce.seb.ee/seb-docs-draft/seb-docs-public-lt/integracija/mobilusis-sdk/ios-sdk/nuoroda/api.md).

# API

Kiekvienas viešas iOS SDK tipas su jo Swift ir Objective-C pavadinimu.

Modulis: `EGWPay`. Minimalus diegimo taikinys: iOS 15.0.

Swift kalboje tipai neturi priešdėlio. Objective-C kalboje tie patys tipai turi `EGW` priešdėlį. Abu pavadinimai pateikiami kiekvienam tipui.

***

## PaymentKit

`PaymentKit` / `EGWPaymentKit`

Įėjimo taškas. Vienu metu vykdo vieną mokėjimą; pradėjus antrąjį, kol pirmasis rodomas ekrane, antrasis iš karto užbaigiamas kaip `.failed` su `invalidRequest` klaida.

### Inicializatoriai

```swift
init(configuration: Configuration)
init(configuration: Configuration, statusResolver: PaymentStatusResolving)
```

Objective-C: `-initWithConfiguration:` ir `-initWithConfiguration:statusResolver:`.

Pirmoji forma naudoja integruotą būsenos paiešką, kai `configuration.apiBaseURL` nustatytas, o kitu atveju kiekvieną mokėjimą išsprendžia kaip `.unresolved`.

### Metodai

```swift
func startPayment(_ request: PaymentRequest,
                  from presenter: UIViewController,
                  completion: @escaping (PaymentResult) -> Void)

func startPayment(_ request: PaymentRequest,
                  from presenter: UIViewController,
                  delegate: PaymentDelegate)

func startCardPayment(_ request: CardPaymentRequest,
                      card: CardInput,
                      from presenter: UIViewController,
                      completion: @escaping (PaymentResult) -> Void)

func startCardPayment(_ request: CardPaymentRequest,
                      card: CardInput,
                      from presenter: UIViewController,
                      delegate: PaymentDelegate)
```

Objective-C selektoriai: `startPayment:from:completion:`, `startPayment:from:delegate:`, `startCardPayment:card:from:completion:`, `startCardPayment:card:from:delegate:`.

Kiekvienas perkrovimas pateikia lygiai vieną rezultatą pagrindinėje gijoje, po to, kai SDK uždaro bet kokią savo pateiktą sąsają. Delegate saugomas silpnai.

`startCardPayment` reikalauja `checkoutAPIBaseURL` ir `checkoutBaseURL` konfigūracijoje. Trūkstant `checkoutAPIBaseURL` sukelia `invalidRequest`; trūkstant `checkoutBaseURL` sukelia `encryptionKeyUnavailable`.

***

## Konfigūracija

`Konfigūracija` / `EGWConfiguration`

Žr. [Konfigūracija](broken://pages/c40f39c9b4651fb53afbae9a3221c4ead03c7e9e).

***

## PaymentRequest

`PaymentRequest` / `EGWPaymentRequest`

Mokėjimas priglobto atsiskaitymo būdu.

### Inicializatorius

```swift
init(paymentId: String, verificationKey: String, checkoutURL: URL, returnURL: URL)
```

Objective-C: `-initWithPaymentId:verificationKey:checkoutURL:returnURL:`.

### Ypatybės

| Ypatybė           | Tipas     | Aprašymas                                                                                                                   |
| ----------------- | --------- | --------------------------------------------------------------------------------------------------------------------------- |
| `paymentId`       | `String`  | Tik skaitomas. Mokėjimo identifikatorius iš jūsų backend'o.                                                                 |
| `verificationKey` | `String`  | Tik skaitomas. Kiekvienam mokėjimui skirtas prieigos kredencialas iš jūsų backend'o.                                        |
| `checkoutURL`     | `URL`     | Tik skaitomas. Reikšmė `_links.checkoutRedirect.href` turi būti `http` arba `https`.                                        |
| `returnURL`       | `URL`     | Tik skaitomas. Ta pati reikšmė, kurią jūsų backend'as pateikė kaip `shopRedirectUrl`.                                       |
| `preferredMethod` | `String?` | Kintamas. Atidaro atsiskaitymo puslapį tiesiai į vieną būdą. `nil` rodo būdo pasirinkiklį. Neatpažinta reikšmė ignoruojama. |

### MethodHint

`PaymentRequest.MethodHint` / `EGWPaymentMethodHint`

Eilučių konstantos `preferredMethod`.

| Konstanta               | Reikšmė          |
| ----------------------- | ---------------- |
| `MethodHint.card`       | `"card"`         |
| `MethodHint.bank`       | `"bank"`         |
| `MethodHint.clickToPay` | `"click-to-pay"` |

***

## CardPaymentRequest

`CardPaymentRequest` / `EGWCardPaymentRequest`

Mokėjimas per jūsų pačių kortelės formą.

```swift
init(paymentId: String, verificationKey: String)
```

Objective-C: `-initWithPaymentId:verificationKey:`.

| Ypatybė           | Tipas    | Aprašymas      |
| ----------------- | -------- | -------------- |
| `paymentId`       | `String` | Tik skaitomas. |
| `verificationKey` | `String` | Tik skaitomas. |

Nėra checkout URL ir nėra return URL: pirkėjas niekada neišeina iš jūsų programos.

***

## PaymentResult

`PaymentResult` / `EGWPaymentResult`

Pateikiamas jūsų completion bloke arba delegate. Tik gavimui: programos jo nekonstruoja.

| Ypatybė         | Tipas            | Aprašymas                                                                                               |
| --------------- | ---------------- | ------------------------------------------------------------------------------------------------------- |
| `outcome`       | `PaymentOutcome` | Mokėjimo vykdymo baigtis.                                                                               |
| `paymentId`     | `String`         | Visada yra.                                                                                             |
| `paymentStatus` | `String?`        | Neapdorota platformos būsenos eilutė, pavyzdžiui `"SETTLED"`.                                           |
| `orderNumber`   | `String?`        | Platformos įrašas apie jūsų backend'o pateiktą užsakymo numerį.                                         |
| `sessionId`     | `String?`        | Kortelės sesijos identifikatorius. Nustatomas tik kortelės srauto metu; `nil` priglobtam atsiskaitymui. |
| `error`         | `NSError?`       | Pateikiama, kai SDK negalėjo užbaigti srauto.                                                           |

`description` grąžina trumpą suvestinę, tinkamą žurnalams. Joje nėra kortelės duomenų ir patvirtinimo rakto.

***

## PaymentOutcome

`PaymentOutcome` / `EGWPaymentOutcome`

| Atvejis       | Objective-C                   | Neapdorota reikšmė | Mokėjimo būsena                                                             |
| ------------- | ----------------------------- | ------------------ | --------------------------------------------------------------------------- |
| `.succeeded`  | `EGWPaymentOutcomeSucceeded`  | `0`                | `AUTHORIZED`, `CAPTURED`, `SETTLED`, `REFUNDED`                             |
| `.failed`     | `EGWPaymentOutcomeFailed`     | `1`                | `FAILED`, arba SDK negalėjo paleisti srauto                                 |
| `.cancelled`  | `EGWPaymentOutcomeCancelled`  | `2`                | `CANCELLED`, `ABANDONED`, arba pirkėjas uždarė puslapį                      |
| `.unresolved` | `EGWPaymentOutcomeUnresolved` | `3`                | `INITIALIZED`, `SENT_FOR_PROCESSING`, neatpažinta būsena arba nėra paieškos |

`.unresolved` yra normali baigtis, ne klaida. Žr. [Rezultato tvarkymas](/seb-docs-draft/seb-docs-public-lt/integracija/mobilusis-sdk/ios-sdk/naudojant-sdk/rezultato-apdorojimas.md).

***

## CardInput

`CardInput` / `EGWCardInput`

Be sąsajos modelis kortelės duomenims. Reikšmės nuskaitomos pateikimo metu.

```swift
init()
```

| Ypatybė          | Tipas       | Aprašymas                                                                                                                                                                    |
| ---------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cardholderName` | `String`    | Kintamas. Numatytoji reikšmė: `""`.                                                                                                                                          |
| `cardNumber`     | `String`    | Kintamas. Numatytoji reikšmė: `""`. Formatavimo simboliai leidžiami.                                                                                                         |
| `expiryMonth`    | `String`    | Kintamas. Du skaitmenys, `"01"` iki `"12"`.                                                                                                                                  |
| `expiryYear`     | `String`    | Kintamas. Du skaitmenys, pavyzdžiui `"30"`.                                                                                                                                  |
| `securityCode`   | `String`    | Kintamas. Numatytoji reikšmė: `""`.                                                                                                                                          |
| `brand`          | `CardBrand` | Tik skaitomas, gaunamas iš `cardNumber`. Naudojamas tik rodymui ir įvesties formatavimui; niekada nesiunčiamas į mokėjimų vartus ir niekada nenaudojamas pateikčiai atmesti. |
| `isValid`        | `Bool`      | Tik skaitomas. `true` kai kiekvienas laukas praeina validaciją.                                                                                                              |

### Metodai

```swift
func validationError(for field: CardField) -> NSError?
```

Objective-C: `-validationErrorFor:`.

Grąžina `nil` kai laukas yra tinkamas, o kitu atveju — `NSError` domeno `com.egw.egwpay` su kodu `7` (`cardValidationFailed`) kurio `localizedDescription` nurodo problemą.

***

## CardField

`CardField` / `EGWCardField`

| Atvejis           | Objective-C                  | Neapdorota reikšmė |
| ----------------- | ---------------------------- | ------------------ |
| `.cardholderName` | `EGWCardFieldCardholderName` | `0`                |
| `.cardNumber`     | `EGWCardFieldCardNumber`     | `1`                |
| `.expiry`         | `EGWCardFieldExpiry`         | `2`                |
| `.securityCode`   | `EGWCardFieldSecurityCode`   | `3`                |

***

## CardBrand

`CardBrand` / `EGWCardBrand`

| Atvejis       | Objective-C              | Neapdorota reikšmė |
| ------------- | ------------------------ | ------------------ |
| `.unknown`    | `EGWCardBrandUnknown`    | `0`                |
| `.visa`       | `EGWCardBrandVisa`       | `1`                |
| `.mastercard` | `EGWCardBrandMastercard` | `2`                |
| `.amex`       | `EGWCardBrandAmex`       | `3`                |
| `.maestro`    | `EGWCardBrandMaestro`    | `4`                |
| `.discover`   | `EGWCardBrandDiscover`   | `5`                |

Prekės ženklo atpažinimas lemia rodymo ir įvesties formatavimą. Ar parduotuvė priima prekės ženklą, sprendžiama serverio pusėje.

***

## Kortelės teksto laukai

Trys `UITextField` poklasiai, kurie tvarko įvesties elgseną ir formatavimą. Jie nenustato jokių spalvų, šriftų, rėmelių ar įdėklų, todėl paveldi jūsų programos išvaizdą. Visi trys palaiko `init(frame:)` ir `init?(coder:)`, todėl veikia tiek kode, tiek Interface Builder.

Jų naudojimas neprivalomas.

### CardNumberTextField

`CardNumberTextField` / `EGWCardNumberTextField`

Grupuoja skaitmenis vartotojui rašant, riboja ilgį ir nustato `textContentType = .creditCardNumber` kad veiktų iOS automatinis užpildymas ir kortelės nuskaitymas.

| Ypatybė      | Tipas       | Aprašymas                                      |
| ------------ | ----------- | ---------------------------------------------- |
| `skaitmenys` | `String`    | Tik skaitomas. Įvestas numeris be formatavimo. |
| `brand`      | `CardBrand` | Tik skaitomas. Gaunamas iš `skaitmenys`.       |

### CardExpiryTextField

`CardExpiryTextField` / `EGWCardExpiryTextField`

Formatuoja įvestį kaip `MM/YY`.

| Ypatybė | Tipas    | Aprašymas                                                 |
| ------- | -------- | --------------------------------------------------------- |
| `mėnuo` | `String` | Tik skaitomas. `""` kol įvesta du skaitmenys.             |
| `metai` | `String` | Tik skaitomas. `""` kol įvesta daugiau nei du skaitmenys. |

### CardSecurityCodeTextField

`CardSecurityCodeTextField` / `EGWCardSecurityCodeTextField`

Maskuoja įvestį ir riboja skaitmenų kiekį pagal kortelės prekės ženklą.

| Ypatybė      | Tipas       | Aprašymas                                                                              |
| ------------ | ----------- | -------------------------------------------------------------------------------------- |
| `brand`      | `CardBrand` | Kintamas. Nustatykite jį iš numerio lauko `brand` kad skaitmenų limitas sektų kortelę. |
| `skaitmenys` | `String`    | Tik skaitomas. Įvestas kodas.                                                          |

***

## PaymentStatusResolving

`PaymentStatusResolving` / `EGWPaymentStatusResolving`

Įgyvendinkite tai, kad SDK integruotą būsenos paiešką pakeistumėte sava.

```swift
@objc protocol PaymentStatusResolving: NSObjectProtocol {
    func resolveStatus(paymentId: String,
                       verificationKey: String,
                       completion: @escaping (_ status: String?,
                                              _ orderNumber: String?,
                                              _ error: NSError?) -> Void)
}
```

Objective-C selektorius: `resolveStatusWithPaymentId:verificationKey:completion:`.

Kvietimą `completion` iškvieskite lygiai vieną kartą iš bet kurios eilės. Grąžinkite neapdorotą platformos būsenos eilutę, o SDK ją susies su baigtimi. Būsena su `nil` klaida išsprendžiama į `nil` PaymentResult.error `.unresolved`.

***

## PaymentDelegate

`PaymentDelegate` / `EGWPaymentDelegate`

Alternatyva completion blokui.

```swift
@objc protocol PaymentDelegate: NSObjectProtocol {
    func paymentDidFinish(_ result: PaymentResult)
}
```

Objective-C selektorius: `paymentDidFinish:`.

Iškviečiamas tik vieną kartą, pagrindinėje gijoje, kai SDK sąsaja uždaroma. `PaymentKit` delegate saugomas silpnai, todėl išsaugokite savo stiprią nuorodą.

***

## PaymentError

`PaymentError` yra Swift išvardijimas. Objective-C programoms ir Swift kodui, kuris skaito `PaymentResult.error`, žr. `NSError` vietoje to.

| Narys                 | Reikšmė                                                         |
| --------------------- | --------------------------------------------------------------- |
| `PaymentError.domain` | `"com.egw.egwpay"`                                              |
| `PaymentError.Code`   | Int `paremtų dvylikos klaidų kodų išvardijimas`Klaidų tvarkymas |

Žr. [kodo lentelę ir atkūrimo gaires.](/seb-docs-draft/seb-docs-public-lt/integracija/mobilusis-sdk/ios-sdk/gaires/klaidu-valdymas.md) kodo lentelę ir atkūrimo gaires.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ecommerce.seb.ee/seb-docs-draft/seb-docs-public-lt/integracija/mobilusis-sdk/ios-sdk/nuoroda/api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.