api-reference.md

Referência automática da API

Ficheiro gerado automaticamente. Não edite manualmente.

Para regenerar: composer docs:api.

Esta referência lista símbolos públicos em src/ e os métodos públicos declarados.

Índice

• Kowts\Sisp\Application\Action\BuildPaymentRequest
• Kowts\Sisp\Application\Action\BuildPurchaseRequest
• Kowts\Sisp\Application\Builder\PaymentBuilder
• Kowts\Sisp\Bridge\Laravel\SispServiceProvider
• Kowts\Sisp\Bridge\Symfony\SispBundle
• Kowts\Sisp\Bridge\Symfony\SispExtension
• Kowts\Sisp\Bridge\Yii2\SispBootstrap
• Kowts\Sisp\Bridge\Yii2\SispComponent
• Kowts\Sisp\Config\SispConfig
• Kowts\Sisp\Contract\PaymentIntentStore
• Kowts\Sisp\Contract\TransactionStore
• Kowts\Sisp\Domain\Amount\SispAmount
• Kowts\Sisp\Domain\TransactionCode
• Kowts\Sisp\Domain\TransactionStatus
• Kowts\Sisp\Domain\ValueObject\CallbackPayload
• Kowts\Sisp\Domain\ValueObject\PaymentRequest
• Kowts\Sisp\Domain\ValueObject\SispCredentials
• Kowts\Sisp\Domain\ValueObject\TransactionRecord
• Kowts\Sisp\Infrastructure\Http\AutoSubmitForm
• Kowts\Sisp\Infrastructure\Persistence\InMemoryPaymentIntentStore
• Kowts\Sisp\Infrastructure\Persistence\InMemoryTransactionStore
• Kowts\Sisp\Infrastructure\Persistence\PdoPaymentIntentStore
• Kowts\Sisp\Infrastructure\Persistence\PdoTransactionStore
• Kowts\Sisp\Infrastructure\Persistence\SispSchema
• Kowts\Sisp\Infrastructure\Security\Fingerprint
• Kowts\Sisp\Sisp
• Kowts\Sisp\SispFactory
• Kowts\Sisp\Support\CountryCodeMapper
• Kowts\Sisp\Support\Generators

Kowts\Sisp\Application\Action\BuildPaymentRequest

• Tipo: Classe
• Ficheiro: src/Application/Action/BuildPaymentRequest.php

Métodos públicos

__construct()

public function __construct(SispCredentials $credentials, string $transactionCode = '1')

handle()

public function handle(array $data): PaymentRequest

Kowts\Sisp\Application\Action\BuildPurchaseRequest

• Tipo: Classe
• Ficheiro: src/Application/Action/BuildPurchaseRequest.php

Métodos públicos

handle()

public static function handle(array $customer, ?DateTimeInterface $now = null): string

Kowts\Sisp\Application\Builder\PaymentBuilder

• Tipo: Classe
• Ficheiro: src/Application/Builder/PaymentBuilder.php

Métodos públicos

__construct()

public function __construct(BuildPaymentRequest $buildPaymentRequest)

amount()

public function amount($amount): self

merchantRef()

public function merchantRef(string $merchantRef): self

merchantSession()

public function merchantSession(string $merchantSession): self

timeStamp()

public function timeStamp(string $timeStamp): self

currency()

public function currency(string $currency): self

transactionCode()

public function transactionCode(string $transactionCode): self

token()

public function token(string $token): self

entityCode()

public function entityCode(string $entityCode): self

referenceNumber()

public function referenceNumber(string $referenceNumber): self

locale()

public function locale(string $locale): self

customerEmail()

public function customerEmail(string $email): self

customerCountry()

public function customerCountry(string $country): self

customerCity()

public function customerCity(string $city): self

customerAddress()

public function customerAddress(string $address): self

customerPostalCode()

public function customerPostalCode(string $postalCode): self

customerPhone()

public function customerPhone(string $phone): self

build()

public function build(): PaymentRequest

Kowts\Sisp\Bridge\Laravel\SispServiceProvider

• Tipo: Classe
• Ficheiro: src/Bridge/Laravel/SispServiceProvider.php

Métodos públicos

register()

public function register(): void

boot()

public function boot(): void

Kowts\Sisp\Bridge\Symfony\SispBundle

• Tipo: Classe
• Ficheiro: src/Bridge/Symfony/SispBundle.php

Métodos públicos

getContainerExtension()

public function getContainerExtension(): SispExtension

Kowts\Sisp\Bridge\Symfony\SispExtension

• Tipo: Classe
• Ficheiro: src/Bridge/Symfony/SispExtension.php

Métodos públicos

load()

public function load(array $configs, ContainerBuilder $container): void

Kowts\Sisp\Bridge\Yii2\SispBootstrap

• Tipo: Classe
• Ficheiro: src/Bridge/Yii2/SispBootstrap.php

Métodos públicos

bootstrap()

public function bootstrap($app): void

Kowts\Sisp\Bridge\Yii2\SispComponent

• Tipo: Classe
• Ficheiro: src/Bridge/Yii2/SispComponent.php

Métodos públicos

getClient()

public function getClient(): Sisp

__call()

public function __call($name, $arguments)

Kowts\Sisp\Config\SispConfig

• Tipo: Classe
• Ficheiro: src/Config/SispConfig.php

Métodos públicos

fromArray()

public static function fromArray(array $data): self

credentials()

public function credentials(): SispCredentials

transactionCode()

public function transactionCode(): string

pdo()

public function pdo(): ?PDO

transactionStore()

public function transactionStore(): ?TransactionStore

autoMigrate()

public function autoMigrate(): bool

Kowts\Sisp\Contract\PaymentIntentStore

• Tipo: Interface
• Ficheiro: src/Contract/PaymentIntentStore.php

Métodos públicos

reserve()

public function reserve(string $key, string $status = 'reserved'): void

link()

public function link(string $key, int $transactionId): void

find()

public function find(string $key): ?array

Kowts\Sisp\Contract\TransactionStore

• Tipo: Interface
• Ficheiro: src/Contract/TransactionStore.php

Métodos públicos

storePaymentRequest()

public function storePaymentRequest(PaymentRequest $request): TransactionRecord

findByMerchantIdentifiers()

public function findByMerchantIdentifiers(string $merchantRef, string $merchantSession): ?TransactionRecord

applyCallback()

public function applyCallback(TransactionRecord $transaction, CallbackPayload $payload, string $status): TransactionRecord

Kowts\Sisp\Domain\Amount\SispAmount

• Tipo: Classe
• Ficheiro: src/Domain/Amount/SispAmount.php

Métodos públicos

toThousandths()

public static function toThousandths($amount): int

toCents()

public static function toCents($amount): int

fromCents()

public static function fromCents($cents): float

Kowts\Sisp\Domain\TransactionCode

• Tipo: Classe
• Ficheiro: src/Domain/TransactionCode.php

Kowts\Sisp\Domain\TransactionStatus

• Tipo: Classe
• Ficheiro: src/Domain/TransactionStatus.php

Kowts\Sisp\Domain\ValueObject\CallbackPayload

• Tipo: Classe
• Ficheiro: src/Domain/ValueObject/CallbackPayload.php

Métodos públicos

__construct()

public function __construct(array $data)

fromPost()

public static function fromPost(array $post): self

toFormFields()

public function toFormFields(): array

toSafeLogContext()

public function toSafeLogContext(): array

toSafeStorageFields()

public function toSafeStorageFields(): array

Campos técnicos permitidos no histórico da transacção. Exclui a assinatura, PAN, recibo e mensagem de erro devolvida pelo gateway.

Kowts\Sisp\Domain\ValueObject\PaymentRequest

• Tipo: Classe
• Ficheiro: src/Domain/ValueObject/PaymentRequest.php

Métodos públicos

__construct()

public function __construct(array $data)

toFormFields()

public function toFormFields(): array

toSafeStorageFields()

public function toSafeStorageFields(): array

Representação mínima para persistência interna. Tokens, fingerprints e dados 3DS pertencem ao pedido enviado ao gateway, não ao histórico local.

Kowts\Sisp\Domain\ValueObject\SispCredentials

• Tipo: Classe
• Ficheiro: src/Domain/ValueObject/SispCredentials.php

Métodos públicos

__construct()

public function __construct(array $data)

Kowts\Sisp\Domain\ValueObject\TransactionRecord

• Tipo: Classe
• Ficheiro: src/Domain/ValueObject/TransactionRecord.php

Métodos públicos

__construct()

public function __construct(int $id, string $merchantRef, string $merchantSession, $amount, string $currency, string $transactionCode, string $status, ?string $gatewayTransactionId = null, array $payload = [])

Kowts\Sisp\Infrastructure\Http\AutoSubmitForm

• Tipo: Classe
• Ficheiro: src/Infrastructure/Http/AutoSubmitForm.php

Métodos públicos

render()

public static function render(string $action, array $fields, string $title = 'Redirecting to SISP'): string

Kowts\Sisp\Infrastructure\Persistence\InMemoryPaymentIntentStore

• Tipo: Classe
• Ficheiro: src/Infrastructure/Persistence/InMemoryPaymentIntentStore.php

Métodos públicos

reserve()

public function reserve(string $key, string $status = 'reserved'): void

link()

public function link(string $key, int $transactionId): void

find()

public function find(string $key): ?array

Kowts\Sisp\Infrastructure\Persistence\InMemoryTransactionStore

• Tipo: Classe
• Ficheiro: src/Infrastructure/Persistence/InMemoryTransactionStore.php

Métodos públicos

storePaymentRequest()

public function storePaymentRequest(PaymentRequest $request): TransactionRecord

findByMerchantIdentifiers()

public function findByMerchantIdentifiers(string $merchantRef, string $merchantSession): ?TransactionRecord

applyCallback()

public function applyCallback(TransactionRecord $transaction, CallbackPayload $payload, string $status): TransactionRecord

Kowts\Sisp\Infrastructure\Persistence\PdoPaymentIntentStore

• Tipo: Classe
• Ficheiro: src/Infrastructure/Persistence/PdoPaymentIntentStore.php

Métodos públicos

__construct()

public function __construct(PDO $pdo, bool $autoMigrate = true)

reserve()

public function reserve(string $key, string $status = 'reserved'): void

link()

public function link(string $key, int $transactionId): void

find()

public function find(string $key): ?array

Kowts\Sisp\Infrastructure\Persistence\PdoTransactionStore

• Tipo: Classe
• Ficheiro: src/Infrastructure/Persistence/PdoTransactionStore.php

Métodos públicos

__construct()

public function __construct(PDO $pdo, bool $autoMigrate = true)

storePaymentRequest()

public function storePaymentRequest(PaymentRequest $request): TransactionRecord

findByMerchantIdentifiers()

public function findByMerchantIdentifiers(string $merchantRef, string $merchantSession): ?TransactionRecord

applyCallback()

public function applyCallback(TransactionRecord $transaction, CallbackPayload $payload, string $status): TransactionRecord

Kowts\Sisp\Infrastructure\Persistence\SispSchema

• Tipo: Classe
• Ficheiro: src/Infrastructure/Persistence/SispSchema.php

Métodos públicos

migrate()

public static function migrate(PDO $pdo): void

statements()

public static function statements(string $driver = 'sqlite'): array

Kowts\Sisp\Infrastructure\Security\Fingerprint

• Tipo: Classe
• Ficheiro: src/Infrastructure/Security/Fingerprint.php

Métodos públicos

sha512Base64()

public static function sha512Base64(string $content): string

computeToken()

public static function computeToken(string $posAutCode): string

payment()

public static function payment(string $token, array $data): string

callback()

public static function callback(string $token, CallbackPayload $payload): string

refund()

public static function refund(string $token, array $data): string

validateCallback()

public static function validateCallback(string $token, CallbackPayload $payload): bool

constantTimeEquals()

public static function constantTimeEquals(string $expected, string $actual): bool

Kowts\Sisp\Sisp

• Tipo: Classe
• Ficheiro: src/Sisp.php

Métodos públicos

__construct()

public function __construct(SispCredentials $credentials, string $transactionCode = '1', ?TransactionStore $transactionStore = null)

payment()

public function payment(): PaymentBuilder

buildRequestPayload()

public function buildRequestPayload(array $data): PaymentRequest

createPayment()

public function createPayment(array $data): PaymentRequest

validateCallback()

public function validateCallback(CallbackPayload $payload): bool

handleCallback()

public function handleCallback(CallbackPayload $payload): ?TransactionRecord

gatewayFormAction()

public function gatewayFormAction(PaymentRequest $request): string

renderPaymentForm()

public function renderPaymentForm(PaymentRequest $request, string $title = 'Redirecting to SISP'): string

Kowts\Sisp\SispFactory

• Tipo: Classe
• Ficheiro: src/SispFactory.php

Métodos públicos

create()

public static function create(SispConfig $config): Sisp

Kowts\Sisp\Support\CountryCodeMapper

• Tipo: Classe
• Ficheiro: src/Support/CountryCodeMapper.php

Métodos públicos

toNumeric()

public static function toNumeric(string $alpha2Code): string

Kowts\Sisp\Support\Generators

• Tipo: Classe
• Ficheiro: src/Support/Generators.php

Métodos públicos

merchantReference()

public static function merchantReference(?DateTimeInterface $date = null): string

merchantSession()

public static function merchantSession(?DateTimeInterface $date = null): string

timeStamp()

public static function timeStamp(?DateTimeInterface $date = null): string