72 lines
3.3 KiB
PHP
72 lines
3.3 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
/*
|
|
// MODULE_CONTRACT: Represents the SBP API call to get detailed data about a QR Code reversal.
|
|
// RESPONSIBILITY: To define the POST request for retrieving specific information about a reversal transaction.
|
|
// INPUTS: Reversal data request (TermNo, currency, qrcId, payrrn, etc.).
|
|
// OUTPUTS: GetQrcReversalDataResponseData (DTO).
|
|
*/
|
|
|
|
namespace Apoloz\AlfaBank\Sbp\Requests\Reversal;
|
|
|
|
// <SECTION name="module_imports" intent="Import DTOs and Saloon components for a JSON body request.">
|
|
// <BELIEF_STATE "This POST request requires specific DTOs for its JSON body and its response, along with Saloon's body-handling traits.">
|
|
use Apoloz\AlfaBank\Sbp\Data\Reversal\GetQrcReversalDataRequestData;
|
|
use Apoloz\AlfaBank\Sbp\Data\Reversal\GetQrcReversalDataResponseData;
|
|
use Apoloz\AlfaBank\Utils\CmsSigner;
|
|
use Saloon\Contracts\Body\HasBody;
|
|
use Saloon\Enums\Method;
|
|
use Saloon\Http\Request;
|
|
use Saloon\Http\Response;
|
|
use Saloon\Traits\Body\HasStringBody;
|
|
|
|
// </SECTION>
|
|
|
|
// <SECTION name="class_definition" intent="Define the request to get detailed QR Code reversal data.">
|
|
// <BELIEF_STATE "This class encapsulates the logic for querying detailed SBP reversal information, which is crucial for auditing and reconciliation.">
|
|
class GetQrcReversalDataRequest extends Request implements HasBody
|
|
{
|
|
use HasStringBody;
|
|
|
|
// <SECTION name="http_method" intent="Declare the HTTP verb.">
|
|
// <BELIEF_STATE "Even though it retrieves data, SBP data requests are often performed via POST requests with a JSON body.">
|
|
protected Method $method = Method::POST;
|
|
// </SECTION>
|
|
|
|
// <SECTION name="constructor" intent="Inject the DTO containing the reversal data request parameters.">
|
|
// <BELIEF_STATE "Using a strongly-typed DTO (`GetQrcReversalDataRequestData`) ensures that all necessary information for the data query is provided and correctly structured.">
|
|
public function __construct(
|
|
protected GetQrcReversalDataRequestData $data
|
|
) {}
|
|
|
|
// <SECTION name="endpoint_resolver" intent="Define the endpoint for SBP reversal data queries.">
|
|
// <BELIEF_STATE "The SBP API often uses generic endpoints with a 'command' field in the body, implying the endpoint itself might be empty or a base SBP URL.">
|
|
public function resolveEndpoint(): string
|
|
{
|
|
return ''; // Endpoint is determined by SbpConnector's base URL
|
|
}
|
|
// </SECTION>
|
|
|
|
// <SECTION name="response_caster" intent="Map the JSON response to a DTO.">
|
|
// <BELIEF_STATE "Casting the response to a `GetQrcReversalDataResponseData` DTO provides a type-safe and structured object for the detailed reversal data.">
|
|
public function createDtoFromResponse(Response $response): GetQrcReversalDataResponseData
|
|
{
|
|
return GetQrcReversalDataResponseData::from($response->json());
|
|
}
|
|
// </SECTION>
|
|
|
|
// <SECTION name="body_builder" intent="Construct the JSON body for the request.">
|
|
// <BELIEF_STATE "The `command` field specifies the operation to the SBP API. Other fields from the DTO are conditionally added, ensuring the payload precisely matches the API specification.">
|
|
protected function defaultBody(): string
|
|
{
|
|
$bodyArray = array_merge(
|
|
['command' => 'GetQRCreversalData'],
|
|
$this->data->toArray()
|
|
);
|
|
|
|
return CmsSigner::canonicalize($bodyArray);
|
|
}
|
|
// </SECTION>
|
|
}
|