{"id":37230658,"url":"https://github.com/localgovdrupal/govuk-pay-client-php","last_synced_at":"2026-01-15T03:39:37.895Z","repository":{"id":332092028,"uuid":"1132730692","full_name":"localgovdrupal/govuk-pay-client-php","owner":"localgovdrupal","description":"SwaggerClient-php  for the GOV.UK Pay REST API","archived":false,"fork":false,"pushed_at":"2026-01-12T11:29:29.000Z","size":100,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-12T19:22:26.467Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/localgovdrupal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-12T11:23:01.000Z","updated_at":"2026-01-12T11:29:32.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/localgovdrupal/govuk-pay-client-php","commit_stats":null,"previous_names":["localgovdrupal/govuk-pay-client-php"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/localgovdrupal/govuk-pay-client-php","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localgovdrupal%2Fgovuk-pay-client-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localgovdrupal%2Fgovuk-pay-client-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localgovdrupal%2Fgovuk-pay-client-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localgovdrupal%2Fgovuk-pay-client-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/localgovdrupal","download_url":"https://codeload.github.com/localgovdrupal/govuk-pay-client-php/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localgovdrupal%2Fgovuk-pay-client-php/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28442310,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-15T00:55:22.719Z","status":"online","status_checked_at":"2026-01-15T02:00:08.019Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-15T03:39:37.273Z","updated_at":"2026-01-15T03:39:37.889Z","avatar_url":"https://github.com/localgovdrupal.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SwaggerClient-php\nThe GOV.UK Pay REST API. Read [our documentation](https://docs.payments.service.gov.uk/) for more details.\n\nThis PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 1.0.3\n- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen\n\n## Requirements\n\nPHP 5.5 and later\n\n## Installation \u0026 Usage\n### Composer\n\nTo install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:\n\n```\n{\n  \"repositories\": [\n    {\n      \"type\": \"git\",\n      \"url\": \"https://github.com/git_user_id/git_repo_id.git\"\n    }\n  ],\n  \"require\": {\n    \"git_user_id/git_repo_id\": \"*@dev\"\n  }\n}\n```\n\nThen run `composer install`\n\n### Manual Installation\n\nDownload the files and include `autoload.php`:\n\n```php\n    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');\n```\n\n## Tests\n\nTo run the unit tests:\n\n```\ncomposer install\n./vendor/bin/phpunit\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```php\n\u003c?php\nrequire_once(__DIR__ . '/vendor/autoload.php');\n\n\n$apiInstance = new Swagger\\Client\\Api\\AgreementsApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n$agreement_id = \"agreement_id_example\"; // string | The `agreement_id` of the agreement you are cancelling\n\ntry {\n    $apiInstance-\u003ecancelAnAgreement($agreement_id);\n} catch (Exception $e) {\n    echo 'Exception when calling AgreementsApi-\u003ecancelAnAgreement: ', $e-\u003egetMessage(), PHP_EOL;\n}\n\n\n$apiInstance = new Swagger\\Client\\Api\\AgreementsApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n$body = new \\Swagger\\Client\\Model\\CreateAgreementRequest(); // \\Swagger\\Client\\Model\\CreateAgreementRequest | requestPayload\n\ntry {\n    $result = $apiInstance-\u003ecreateAnAgreement($body);\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling AgreementsApi-\u003ecreateAnAgreement: ', $e-\u003egetMessage(), PHP_EOL;\n}\n\n\n$apiInstance = new Swagger\\Client\\Api\\AgreementsApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n$agreement_id = \"agreement_id_example\"; // string | Returns the agreement with the matching `agreement_id`. GOV.UK Pay generated an `agreement_id` when you created the agreement.\n\ntry {\n    $result = $apiInstance-\u003egetAnAgreement($agreement_id);\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling AgreementsApi-\u003egetAnAgreement: ', $e-\u003egetMessage(), PHP_EOL;\n}\n\n\n$apiInstance = new Swagger\\Client\\Api\\AgreementsApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n$reference = \"reference_example\"; // string | Returns agreements with a `reference` that exactly matches the value you sent. This parameter is not case sensitive. A `reference` was associated with the agreement when that agreement was created.\n$status = \"status_example\"; // string | Returns agreements in a matching `status`. `status` reflects where an agreement is in its lifecycle. You can [read more about the meanings of the different agreement status values](https://docs.payments.service.gov.uk/recurring_payments/#understanding-agreement-status).\n$page = \"page_example\"; // string | Returns a specific page of results. Defaults to `1`. You can [read about search pagination](https://docs.payments.service.gov.uk/api_reference/#pagination)\n$display_size = \"display_size_example\"; // string | The number of agreements returned per results page. Defaults to `500`. Maximum value is `500`. You can [read about search pagination](https://docs.payments.service.gov.uk/api_reference/#pagination)\n\ntry {\n    $result = $apiInstance-\u003esearchAgreements($reference, $status, $page, $display_size);\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling AgreementsApi-\u003esearchAgreements: ', $e-\u003egetMessage(), PHP_EOL;\n}\n?\u003e\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://publicapi.payments.service.gov.uk*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AgreementsApi* | [**cancelAnAgreement**](docs/Api/AgreementsApi.md#cancelanagreement) | **POST** /v1/agreements/{agreementId}/cancel | Cancel an agreement for recurring payments\n*AgreementsApi* | [**createAnAgreement**](docs/Api/AgreementsApi.md#createanagreement) | **POST** /v1/agreements | Create an agreement for recurring payments\n*AgreementsApi* | [**getAnAgreement**](docs/Api/AgreementsApi.md#getanagreement) | **GET** /v1/agreements/{agreementId} | Get information about a single agreement for recurring payments\n*AgreementsApi* | [**searchAgreements**](docs/Api/AgreementsApi.md#searchagreements) | **GET** /v1/agreements | Search agreements for recurring payments\n*AuthoriseCardPaymentsApi* | [**authoriseAMOTOPayment**](docs/Api/AuthoriseCardPaymentsApi.md#authoriseamotopayment) | **POST** /v1/auth | Send card details to authorise a MOTO payment\n*CardPaymentsApi* | [**cancelAPayment**](docs/Api/CardPaymentsApi.md#cancelapayment) | **POST** /v1/payments/{paymentId}/cancel | Cancel payment\n*CardPaymentsApi* | [**captureAPayment**](docs/Api/CardPaymentsApi.md#captureapayment) | **POST** /v1/payments/{paymentId}/capture | Take a delayed payment\n*CardPaymentsApi* | [**createAPayment**](docs/Api/CardPaymentsApi.md#createapayment) | **POST** /v1/payments | Create a payment\n*CardPaymentsApi* | [**getAPayment**](docs/Api/CardPaymentsApi.md#getapayment) | **GET** /v1/payments/{paymentId} | Get information about a single payment\n*CardPaymentsApi* | [**getEventsForAPayment**](docs/Api/CardPaymentsApi.md#geteventsforapayment) | **GET** /v1/payments/{paymentId}/events | Get a payment\u0026#x27;s events\n*CardPaymentsApi* | [**searchPayments**](docs/Api/CardPaymentsApi.md#searchpayments) | **GET** /v1/payments | Search payments\n*DisputesApi* | [**searchDisputes**](docs/Api/DisputesApi.md#searchdisputes) | **GET** /v1/disputes | Search disputes\n*RefundingCardPaymentsApi* | [**getAPaymentRefund**](docs/Api/RefundingCardPaymentsApi.md#getapaymentrefund) | **GET** /v1/payments/{paymentId}/refunds/{refundId} | Check the status of a refund\n*RefundingCardPaymentsApi* | [**getAllRefundsForAPayment**](docs/Api/RefundingCardPaymentsApi.md#getallrefundsforapayment) | **GET** /v1/payments/{paymentId}/refunds | Get information about a payment’s refunds\n*RefundingCardPaymentsApi* | [**searchRefunds**](docs/Api/RefundingCardPaymentsApi.md#searchrefunds) | **GET** /v1/refunds | Search refunds\n*RefundingCardPaymentsApi* | [**submitARefundForAPayment**](docs/Api/RefundingCardPaymentsApi.md#submitarefundforapayment) | **POST** /v1/payments/{paymentId}/refunds | Refund a payment\n\n## Documentation For Models\n\n - [Address](docs/Model/Address.md)\n - [Agreement](docs/Model/Agreement.md)\n - [AgreementSearchResults](docs/Model/AgreementSearchResults.md)\n - [AuthorisationRequest](docs/Model/AuthorisationRequest.md)\n - [AuthorisationSummary](docs/Model/AuthorisationSummary.md)\n - [CardDetails](docs/Model/CardDetails.md)\n - [CardDetailsFromResponse](docs/Model/CardDetailsFromResponse.md)\n - [CreateAgreementRequest](docs/Model/CreateAgreementRequest.md)\n - [CreateCardPaymentRequest](docs/Model/CreateCardPaymentRequest.md)\n - [CreatePaymentResult](docs/Model/CreatePaymentResult.md)\n - [DisputeDetailForSearch](docs/Model/DisputeDetailForSearch.md)\n - [DisputeLinksForSearch](docs/Model/DisputeLinksForSearch.md)\n - [DisputesSearchResults](docs/Model/DisputesSearchResults.md)\n - [EmbeddedRefunds](docs/Model/EmbeddedRefunds.md)\n - [ErrorResponse](docs/Model/ErrorResponse.md)\n - [Exemption](docs/Model/Exemption.md)\n - [ExternalMetadata](docs/Model/ExternalMetadata.md)\n - [Link](docs/Model/Link.md)\n - [Outcome](docs/Model/Outcome.md)\n - [PaymentDetailForSearch](docs/Model/PaymentDetailForSearch.md)\n - [PaymentEvent](docs/Model/PaymentEvent.md)\n - [PaymentEventLink](docs/Model/PaymentEventLink.md)\n - [PaymentEvents](docs/Model/PaymentEvents.md)\n - [PaymentInstrument](docs/Model/PaymentInstrument.md)\n - [PaymentLinks](docs/Model/PaymentLinks.md)\n - [PaymentLinksForEvents](docs/Model/PaymentLinksForEvents.md)\n - [PaymentLinksForSearch](docs/Model/PaymentLinksForSearch.md)\n - [PaymentRefundRequest](docs/Model/PaymentRefundRequest.md)\n - [PaymentSearchResults](docs/Model/PaymentSearchResults.md)\n - [PaymentSettlementSummary](docs/Model/PaymentSettlementSummary.md)\n - [PaymentState](docs/Model/PaymentState.md)\n - [PaymentWithAllLinks](docs/Model/PaymentWithAllLinks.md)\n - [PostLink](docs/Model/PostLink.md)\n - [PrefilledCardholderDetails](docs/Model/PrefilledCardholderDetails.md)\n - [Refund](docs/Model/Refund.md)\n - [RefundDetailForSearch](docs/Model/RefundDetailForSearch.md)\n - [RefundForSearchResult](docs/Model/RefundForSearchResult.md)\n - [RefundLinksForSearch](docs/Model/RefundLinksForSearch.md)\n - [RefundSearchResults](docs/Model/RefundSearchResults.md)\n - [RefundSettlementSummary](docs/Model/RefundSettlementSummary.md)\n - [RefundSummary](docs/Model/RefundSummary.md)\n - [RefundsResponse](docs/Model/RefundsResponse.md)\n - [RequestError](docs/Model/RequestError.md)\n - [SearchNavigationLinks](docs/Model/SearchNavigationLinks.md)\n - [SettlementSummary](docs/Model/SettlementSummary.md)\n - [ThreeDSecure](docs/Model/ThreeDSecure.md)\n\n## Documentation For Authorization\n\n\n## BearerAuth\n\n- **Type**: HTTP bearer authentication\n\n\n## Author\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalgovdrupal%2Fgovuk-pay-client-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flocalgovdrupal%2Fgovuk-pay-client-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalgovdrupal%2Fgovuk-pay-client-php/lists"}