README

Documentation of the early finverse services

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/FinversePhp/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure OAuth2 access token for authorization: Oauth2
$config = FinversePhp\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new FinversePhp\Api\CustomerApi(
    // 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
);
$mandate_id = 'mandate_id_example'; // string | The mandate_id that is being authorized
$authorize_mandate_request = new \FinversePhp\Model\AuthorizeMandateRequest(); // \FinversePhp\Model\AuthorizeMandateRequest | request body for authorizing a mandate

try {
    $result = $apiInstance->authorizeMandate($mandate_id, $authorize_mandate_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->authorizeMandate: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.sandbox.finverse.net

Class	Method	HTTP request
CustomerApi	authorizeMandate	POST /mandates/{mandateId}/authorize
CustomerApi	createMandate	POST /mandates
CustomerApi	createPayment	POST /payments
CustomerApi	createPaymentAccount	POST /payment_accounts
CustomerApi	createPaymentInstruction	POST /payments/instruction
CustomerApi	createPaymentUser	POST /payment_users
CustomerApi	deletePaymentAccount	DELETE /payment_accounts/{paymentAccountId}
CustomerApi	generateLinkToken	POST /link/token
CustomerApi	getInstitution	GET /institutions/{institutionId}
CustomerApi	getLineItemsForDisplay	GET /calculate/line_items/{paymentType}
CustomerApi	getLoginIdentityById	GET /login_identity/{loginIdentityId}
CustomerApi	getLoginIdentityHistory	GET /login_identity/{loginIdentityId}/history
CustomerApi	getMandate	GET /mandates/{mandateId}
CustomerApi	getMandateAuth	GET /mandates/auth
CustomerApi	getMandateAuthLink	POST /mandates/link
CustomerApi	getPayment	GET /payments/{paymentId}
CustomerApi	getPaymentInstruction	GET /payments/instruction/{paymentInstructionId}
CustomerApi	getPaymentUser	GET /payment_users/{paymentUserId}
CustomerApi	listInstitutions	GET /institutions
CustomerApi	listPaymentAccounts	GET /payment_users/{paymentUserId}/payment_accounts
CustomerApi	listPaymentAccountsWithEnrichedData	GET /payment_accounts
CustomerApi	refreshToken	POST /auth/token/refresh
CustomerApi	setMandateInstitution	POST /mandates/institution_selection
CustomerApi	submitAuthChecklist	POST /mandates/auth
CustomerApi	updatePayment	POST /payments/{paymentId}
CustomerApi	updateTestPaymentStatus	POST /testing/payments/{paymentId}/status
DefaultApi	cancelPaymentLink	POST /payment_links/{paymentLinkId}/cancel
DefaultApi	cancelPayout	POST /payouts/{payoutId}/cancel
DefaultApi	changePaymentMethodPaymentLink	POST /payment_link/fvlink/payment_method/change
DefaultApi	confirmManualPayment	POST /payments/manual_payment
DefaultApi	confirmPayment	POST /payment_links/confirm
DefaultApi	createFpsToken	POST /payment_links/fps/token
DefaultApi	createMandateForExistingSender	POST /mandates/sender_account
DefaultApi	createPaymentLink	POST /payment_links
DefaultApi	createPaymentLinkCardPayment	POST /payment_links/card
DefaultApi	createPaymentLinkMandate	POST /payment_links/mandates
DefaultApi	createPaymentMethod	POST /payment_users/{paymentUserId}/payment_methods
DefaultApi	createScheduledPayout	POST /payouts/scheduled
DefaultApi	demotePaymentAttempt	POST /payment_link/fvlink/payment_attempt/demote
DefaultApi	downloadBalanceStatement	GET /ledger/statement
DefaultApi	getFpsQrCode	GET /payment_links/fps/qr_code
DefaultApi	getInstitutionsForCustomer	GET /institutions/customer
DefaultApi	getPaymentLink	GET /payment_links/{paymentLinkId}
DefaultApi	getPaymentMethod	GET /payment_methods/{paymentMethodId}
DefaultApi	getPaymentMethodPaymentLink	GET /payment_link/fvlink/payment_method
DefaultApi	getPaymentPaymentLink	GET /payment_link/fvlink/payment
DefaultApi	getPayoutById	GET /payouts/{payoutId}
DefaultApi	getSenderPaymentUser	GET /payment_link/fvlink/payment_user/sender
DefaultApi	listDetokenizedMandates	GET /mandates/details
DefaultApi	listMandates	GET /mandates
DefaultApi	listPaymentMethods	GET /payment_users/{paymentUserId}/payment_methods
DefaultApi	listPayments	GET /payments
DefaultApi	listPayouts	GET /payouts
DefaultApi	refreshPaymentAttempt	POST /payment_link/fvlink/payment_attempt/refresh
DefaultApi	setAutopayConsent	POST /payment_link/fvlink/payment_user/autopay
DefaultApi	updatePaymentUser	POST /payment_users/{paymentUserId}
LinkApi	createLink	POST /link
LinkApi	createLinkWoauth	POST /link/woauth
LinkApi	linkAction	POST /link/action/{loginIdentityId}
LinkApi	linkStatus	GET /link/status/{loginIdentityId}
LinkApi	linkStatusNonSensitive	GET /link/fvlink/status/{loginIdentityId}
LinkApi	relink	POST /link/relink
LinkApi	relinkV2	POST /link/relink/{loginIdentityId}
LinkApi	token	POST /auth/token
LoginIdentityApi	deleteLoginIdentity	DELETE /login_identity
LoginIdentityApi	generateLinkToken	POST /link/token
LoginIdentityApi	getAccount	GET /accounts/{accountId}
LoginIdentityApi	getAccountNumber	GET /account_numbers/{accountId}
LoginIdentityApi	getBalanceHistory	GET /balance_history/{accountId}
LoginIdentityApi	getCompositeStatement	GET /composite_statement
LoginIdentityApi	getIdentity	GET /identity
LoginIdentityApi	getIncomeEstimateByLoginIdentityId	GET /income
LoginIdentityApi	getLoginIdentity	GET /login_identity
LoginIdentityApi	getStatement	GET /statements/{statementId}
LoginIdentityApi	getStatements	GET /statements
LoginIdentityApi	listAccounts	GET /accounts
LoginIdentityApi	listCardDetails	GET /card_details
LoginIdentityApi	listTransactionsByAccountId	GET /transactions/{accountId}
LoginIdentityApi	listTransactionsByLoginIdentityId	GET /transactions
LoginIdentityApi	refreshLoginIdentity	POST /login_identity/refresh
PublicApi	authCallback	GET /auth/callback
PublicApi	generateCustomerAccessToken	POST /auth/customer/token
PublicApi	getCredSubmitJwks	GET /jwks
PublicApi	getPaymentsJwks	GET /payments/jwks

Models

Authorization

Authentication schemes defined for the API:

Oauth2

Type: OAuth
Flow: application
Authorization URL: ``
Scopes:
- test: Test
- account: Account
- balance: Balance
- transaction: Transaction
- credit: Credit
- investment: Investment
- institution: Institution
- link: Link

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

info@finverse.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 0.0.1
- Generator version: 7.13.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

rewards-wise / finverse-sdk-php

Maintainers

Details