Skip to content

ciltocruz/swagger-bankstore-api-rest

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
docs
docs
 
 
lib
lib
 
 
test
test
 
 
.php_cs
.php_cs
 
 
.travis.yml
.travis.yml
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
git_push.sh
git_push.sh
 
 
phpunit.xml.dist
phpunit.xml.dist
 
 

Repository files navigation

SwaggerClient-php

PAYCOMET API REST for customers.

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

  • API version: 2.37.0
  • Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen For more information, please visit https://www.paycomet.com

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/ciltocruz/swagger-bankstore-api-rest.git"
    }
  ],
  "require": {
    "ciltocruz/swagger-bankstore-api-rest": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/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 API key authorization: paycometApiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('PAYCOMET-API-TOKEN', 'YOUR_API_KEY');
$apiInstance = new Swagger\Client\Api\BalanceApi(
    // 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()
);
$body = new \Swagger\Client\Model\V1BalanceBody(); // \Swagger\Client\Model\V1BalanceBody | 
$paycomet_api_token = "paycomet_api_token_example"; // string | PAYCOMET API key (Query privilege required)

try {
    $result = $apiInstance->productBalance($body, $paycomet_api_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BalanceApi->productBalance: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://rest.paycomet.com

Class Method HTTP request Description
BalanceApi productBalance POST /v1/balance Get balance info
CardsApi addUser POST /v1/cards Tokenizes a card. Either card number and CVC2 or jetToken are required. For you to send directly the card data you should be PCI certified or the accepting the requirement to submit quarterly SAQ-AEP and get ASV scans. For most users is strongly recommended getting the jetToken with JETIFRAME or using GET integration to register the cards instead of REST.
CardsApi editUser POST /v1/cards/edit Changes the expiry date, cvc2 or both
CardsApi infoUser POST /v1/cards/info Get card info
CardsApi physicalAddCard POST /v1/cards/physical Tokenize a card by physical encrypted data
CardsApi removeUser POST /v1/cards/delete Removes a card
DccApi dccPurchaseConfirm POST /v1/payments/dcc/{order}/confirm Confirm previous DCC payment
DccApi dccPurchaseCreate POST /v1/payments/dcc Create an DCC payment
ErrorApi infoError POST /v1/errors Gets an error description
ExchangeApi exchange POST /v1/exchange Converts a certain amount from a currency to another.
FormApi form POST /v1/form Create form view for user capture
HeartbeatApi heartbeat POST /v1/heartbeat Check the system
IVRApi checkSession POST /v1/ivr/session-state Checks an IVR session
IVRApi getSession POST /v1/ivr/get-session Creates an IVR session
IVRApi sessionCancel POST /v1/ivr/session-cancel Cancel an IVR session
IpApi getCountrybyIP POST /v1/ip Retrieves country info by IP
LaunchpadApi launchAuthorization POST /v1/launchpad/authorization Creates a payment link and sends it to customer
LaunchpadApi launchPreauthorization POST /v1/launchpad/preauthorization Executes a preauthorization link and sends it to customer
LaunchpadApi launchSubscription POST /v1/launchpad/subscription Creates a subscription link and sends it to customer
MarketplaceApi splitTransfer POST /v1/marketplace/split-transfer Make a transfer to other accounts on PAYCOMET
MarketplaceApi splitTransferReversal POST /v1/marketplace/split-transfer-reversal Run a split transfer reversal based on a previous split transfer
MarketplaceApi transfer POST /v1/marketplace/transfer Run a transfer
MarketplaceApi transferReversal POST /v1/marketplace/transfer-reversal Make a transfer reversal based on a previous transfer
MethodsApi getUserPaymentMethods POST /v1/methods Retrieves product methods
MiraklApi miraklInvoicesSearch POST /v1/invoices Search Mirakl invoices
PaymentsApi executePurchase POST /v1/payments Executes a payment
PaymentsApi executePurchaseRtoken POST /v1/payments/rtoken Executes a payment by refence
PaymentsApi operationInfo POST /v1/payments/{order}/info Get info of a order
PaymentsApi operationSearch POST /v1/payments/search Search orders
PreauthorizationsApi cancelPreauthorization POST /v1/payments/{order}/preauth/cancel Cancel previous preauthorization
PreauthorizationsApi confirmPreauthorization POST /v1/payments/{order}/preauth/confirm Confirm previous preauthorization
PreauthorizationsApi createPreauthoritation POST /v1/payments/preauth Create preauthorization
PreauthorizationsApi createPreauthorizationRtoken POST /v1/payments/preauthrtoken Creates a preauthorization by reference
RefundApi executeRefund POST /v1/payments/{order}/refund Perform a refund
SepaApi addDocument POST /v1/sepa/add-document Adds a SEPA document
SepaApi checkCustomer POST /v1/sepa/check-customer Check a customers SEPA documentation
SepaApi checkDocument POST /v1/sepa/check-document Check a SEPA document
SepaApi sepaOperations POST /v1/sepa/operations Send SEPA operations
SusbcriptionsApi createSubscription POST /v1/subscription Create susbcription payment
SusbcriptionsApi editSubscription POST /v1/subscription/{order}/edit Edit susbcription payment.
SusbcriptionsApi executeSubscription POST /v1/subscription/{order}/execute Excute a susbcription payment.
SusbcriptionsApi removeSubscription POST /v1/subscription/{order}/remove Remove susbcription payment. If the susbscription is not a card subscription only the idUser is need. TokenUser is just for card subscriptions.

Documentation For Models

Documentation For Authorization

paycometApiKey

  • Type: API key
  • API key parameter name: PAYCOMET-API-TOKEN
  • Location: HTTP header

Author

[email protected]

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases 3

versión 3.0 Latest
Oct 13, 2021
+ 2 releases

Packages

No packages published

Languages