yapily

To access endpoints that require authentication, use your application key and secret created in the Dashboard (https://dashboard.yapily.com)

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 0.0.161
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/mscodemonkey/yapily.git"
    }
  ],
  "require": {
    "mscodemonkey/yapily": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/yapily/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
$config = Yapily\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: tokenAuth
$config = Yapily\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Yapily\Api\AccountsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$account_id = "account_id_example"; // string | accountId
$consent = "consent_example"; // string | Consent Token
$limit = 56; // int | Use this parameter to limit account's direct debit results

try {
    $result = $apiInstance->getAccountDirectDebitsUsingGET($account_id, $consent, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getAccountDirectDebitsUsingGET: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.yapily.com

Class	Method	HTTP request	Description
AccountsApi	getAccountDirectDebitsUsingGET	GET /accounts/{accountId}/direct-debits	Get account direct debits
AccountsApi	getAccountPeriodicPaymentsUsingGET	GET /accounts/{accountId}/periodic-payments	Get account payments detail
AccountsApi	getAccountScheduledPaymentsUsingGET	GET /accounts/{accountId}/scheduled-payments	Get account scheduled payments
AccountsApi	getAccountUsingGET	GET /accounts/{accountId}	Get account
AccountsApi	getAccountsUsingGET	GET /accounts	Get accounts
AccountsApi	initiateAccountRequestUsingPOST	POST /account-auth-requests	Initiate a new account request for user to authorize
AccountsApi	reAuthoriseAccountUsingPATCH	PATCH /account-auth-requests	Re-authorize account request
ApplicationUsersApi	addUserUsingPOST	POST /users	Add an application user
ApplicationUsersApi	deleteUserUsingDELETE	DELETE /users/{userUuid}	Delete an application user and sub-resources (including consent resources on institution APIs if they exist)
ApplicationUsersApi	getDeleteUsersJobUsingGET	GET /delete-users/{job-id}	Get details of a user deletion job
ApplicationUsersApi	getDeleteUsersJobsUsingGET	GET /delete-users	Get details of all user deletion jobs
ApplicationUsersApi	getUserUsingGET	GET /users/{userUuid}	Get an application user
ApplicationUsersApi	getUsersUsingGET	GET /users	Get application users
ApplicationUsersApi	startDeleteUsersJobUsingPOST	POST /delete-users	Start a job to delete application users by specifying their identifiers
ApplicationsApi	getApplicationMeUsingGET	GET /me	Returns the details of the application that owns the request credentials
ApplicationsApi	getJwksUsingGET	GET /jwks	JSON Web Key Set (JWKS) for authenticated application
ApplicationsApi	revokeTokensUsingPOST	POST /revoke-tokens	Revoke existing access tokens for application, which will also generate a new public key discoverable via /jwks
ConsentsApi	addConsentUsingPOST	POST /users/{userUuid}/consents	Post consent
ConsentsApi	createConsentWithCodeUsingPOST	POST /consent-auth-code	Post auth-code and auth-state
ConsentsApi	deleteUsingDELETE	DELETE /consents/{consentId}	Delete consent
ConsentsApi	getConsentByIdUsingGET	GET /consents/{consentId}	Get consent
ConsentsApi	getConsentBySingleAccessConsentUsingPOST	POST /consent-one-time-token	Post one time token
ConsentsApi	getConsentsUsingGET	GET /consents	Get consents sorted by creation date
ConsentsApi	getUserConsentsUsingGET	GET /users/{userUuid}/consents	Get latest user consents
IdentityApi	getIdentityUsingGET	GET /identity	Get identity
InstitutionsApi	getFeatureDetailsUsingGET	GET /features	Retrieve details for Yapily's institution features
InstitutionsApi	getInstitutionUsingGET	GET /institutions/{institutionId}	Retrieves details of a specific institution available in Yapily
InstitutionsApi	getInstitutionsUsingGET	GET /institutions	Retrieves the list of institutions available in Yapily
InstitutionsOpenDataApi	getATMDataUsingGET	GET /institutions/{institutionId}/atms	Retrieves data about all ATMs of the selected institution
InstitutionsOpenDataApi	getPersonalCurrentAccountsUsingGET	GET /institutions/{institutionId}/personal-current-accounts	Retrieves details of personal current accounts for an institution
OAuthApi	oauthToken	POST /oauth/token	Retrieve Access Token
PaymentsApi	createPaymentAuthorisationUsingPOST	POST /payment-auth-requests	Initiate a payment for user to authorise
PaymentsApi	createPaymentAuthorisationWithSortCodeUsingPOST	POST /payment-sortcode-auth-requests	Initiate a new single payment for user to authorise
PaymentsApi	createPaymentUsingPOST	POST /payments	Create a payment
PaymentsApi	createPaymentWithSortCodeUsingPOST	POST /payment-sortcode	Create a new single payment
PaymentsApi	getPaymentStatusUsingGET	GET /payments/{paymentId}	Get status of a payment
PaymentsApi	getPaymentsUsingGET	GET /payments/{paymentId}/details	Get payments detail
StatementsApi	getStatementFileUsingGET	GET /accounts/{accountId}/statements/{statementId}/file	Get account statement file
StatementsApi	getStatementUsingGET	GET /accounts/{accountId}/statements/{statementId}	Get account statement
StatementsApi	getStatementsUsingGET	GET /accounts/{accountId}/statements	Get account statements
TransactionsApi	getTransactionsUsingGET	GET /accounts/{accountId}/transactions	Get account transactions
TransfersApi	transferUsingPUT	PUT /accounts/{accountId}/transfer	Transfer money from one account to another account accessible with the same consent

Documentation For Models

• ATMMapServiceLinks
• ATMOpenData
• ATMOpenDataBrand
• ATMOpenDataResponse
• Account
• AccountAuthorisationRequest
• AccountBalance
• AccountIdentification
• AccountName
• AccountRequest
• AccountStatement
• Address
• AddressDetails
• AgeEligibility
• Amount
• ApiError
• ApiListResponseOfAccount
• ApiListResponseOfAccountStatement
• ApiListResponseOfBulkUserDelete
• ApiListResponseOfConsent
• ApiListResponseOfFeatureDetails
• ApiListResponseOfInstitution
• ApiListResponseOfPaymentResponse
• ApiListResponseOfTransaction
• ApiResponseOfAccount
• ApiResponseOfAccountStatement
• ApiResponseOfAuthorisationRequestResponse
• ApiResponseOfBulkUserDeleteDetails
• ApiResponseOfConsent
• ApiResponseOfConsentDeleteResponse
• ApiResponseOfIdentity
• ApiResponseOfListOfATMOpenDataResponse
• ApiResponseOfListOfPersonalCurrentAccountData
• ApiResponseOfPaymentAuthorisationRequestResponse
• ApiResponseOfPaymentResponse
• ApiResponseOfPaymentResponses
• ApiResponseOfTransferResponse
• ApiResponseOfUserDeleteResponse
• Application
• ApplicationUser
• AuthorisationRequestResponse
• Balance
• Branch
• BulkUserDelete
• BulkUserDeleteDetails
• ChargeDetails
• Consent
• ConsentAuthCodeRequest
• ConsentDeleteResponse
• CoreProduct
• Country
• CreateConsentAccessToken
• CreditCheck
• CreditInterest
• CreditInterestCreditInterestEligibility
• CreditInterestTierBand
• CreditInterestTierBandSet
• CreditLine
• CurrencyExchange
• Eligibility
• EligibilityOtherEligibility
• ExchangeRateInformation
• ExchangeRateInformationResponse
• FeatureDetails
• File
• FilterAndSort
• FrequencyRequest
• FrequencyResponse
• GeoLocation1
• GeographicCoordinates1
• IDVerificationCheck
• Identity
• IdentityAddress
• InlineResponse2001ATM
• InlineResponse2001OtherATMServices
• InlineResponse2001OtherAccessibility
• InputStream
• Institution
• InstitutionConsent
• InternationalPaymentRequest
• IsoBankTransactionCode
• IsoCodeDetails
• Location
• LocationOtherLocationCategory
• Media
• Merchant
• MerchantInfo
• MonitoringFeatureStatus
• MultiAuthorisation
• NewApplicationUser
• Next
• OneTimeTokenRequest
• OtherApplicationFrequency
• OtherBankInterestType
• OtherCalculationFrequency
• OtherFeeRateType
• OtherFeeType
• OtherResidencyType
• OtherType
• Overdraft
• OverdraftOtherFeeType
• OverdraftOverdraftFeeChargeCap
• OverdraftOverdraftFeeChargeDetail
• OverdraftOverdraftFeesCharges
• OverdraftOverdraftFeesCharges1
• OverdraftOverdraftTierBand
• OverdraftOverdraftTierBandSet
• Pagination
• Payee
• PaymentAuthorisationRequest
• PaymentAuthorisationRequestResponse
• PaymentRequest
• PaymentResponse
• PaymentResponses
• PaymentStatusDetails
• PeriodicPaymentRequest
• PersonalCurrentAccountBrand
• PersonalCurrentAccountData
• PersonalCurrentAccountPCA
• PersonalCurrentAccountPCAMarketingState
• PostalAddress1
• ProprietaryBankTransactionCode
• ResidencyEligibility
• Resource
• ResponseEntity
• ResponseListMeta
• ResponseMeta
• Site
• SortCodePaymentAuthRequest
• SortCodePaymentRequest
• StatementReference
• Transaction
• TransferRequest
• TransferResponse
• URI
• URL
• UserDeleteRequest
• UserDeleteResponse
• YapilyAccessToken

Documentation For Authorization

basicAuth

• Type: HTTP basic authentication

tokenAuth

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Author