scnd-sas/agorapay-php-sdk

There is no license information available for the latest version (dev-main) of this package.

PHP SDK for CAPSPAYMENT API

Maintainers

Details

github.com/scnd-sas/agorapay-php-sdk

Source

Installs: 50

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 2

dev-main 2025-03-12 10:01 UTC

Requires

Requires (Dev)

Unknown License f51615409174c190aadfac9641664ebb6e8e3c51

This package is not auto-updated.

Last update: 2025-06-04 10:59:08 UTC

README

CAPSPAYMENT API SDK is a PHP client library to work with CAPSPAYMENT REST API.

Requirements

To use this SDK, you will need (as a minimum):

  • PHP >= v7.2
  • cURL (included and enabled in a standard PHP distribution)

This SDK provide an autoloader. You need to use it in your project :

require_once '/absolute/path/sdk/api/vendor/autoload.php';

After require_once , you can instantiate the main class :

$api = new CAPSPaymentApi\Main();

Base Configuration

Set a base url for calling API :

<?php
$api->Config->BaseUrl = 'https://hostname:port/version';
?>

Getting token

Before calling API, you need to get a token. Set the following variables for getting one

Set url for getting authentication token

<?php
$api->Config->TokenUrl = 'https://your_url_authentication';
?>

Set user

<?php
$api->Config->TokenUser = 'your_user';
?>

Set password

<?php
$api->Config->TokenPassword = 'your_password';
?>

Example

<?php
require_once '/absolute/path/to/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';

$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

// Call paymentMethods from PayIn API
$result = $api->PayIn->paymentMethods($object);

?>

List SDK functions to use for API Payin

You will find in this table which function to used for each API "Payin" endpoint :

Payin Endpoint SDK Functions Method
/payin/payment $api->Payin->payment($object) POST
/payin/paymentDetails $api->Payin->paymentDetails($object) POST
/payin/paymentMethods $api->Payin->paymentMethods($object) POST
/payin/capture $api->Payin->capture($object) POST
/payin/cancel $api->Payin->cancel($object) POST
/payin/orderDetails $api->Payin->orderDetails($object) GET
/payin/adjustPayment $api->Payin->adjustPayment($object) POST
/payin/paymentIframe $api->Payin->paymentIframe($object) POST
/payin/refund $api->Payin->refund($object) POST
/payin/mandate $api->Payin->mandate($object) GET
/payin/ticket $api->Payin->ticket($object) GET
/payin/reload $api->Payin->reload($object) POST

Examples

Here, we call API with payin/payment (Method POST)

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();
$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

//transaction amount object creation
$transactionAmountObj = new \CAPSPaymentApi\Amount('', '');
//valuation of the object
$transactionAmountObj->value = '70.10';
$transactionAmountObj->currency = 'EUR';

//transaction payment method object creation
$transPaymentMethodObj = new \CAPSPaymentApi\TransPaymentMethod('');
//valuation of the object
$transPaymentMethodObj->id = '4';

//payment object creation
$paymentObj = new \CAPSPaymentApi\PaymentPayinsOptions('','');
//valuation of the object
$paymentObj->orderId = '2987721';
$paymentObj->transactionAmount = $transactionAmountObj;
$paymentObj->urlRedirect = 'http://www.url.fr';
$paymentObj->transPaymentMethod = $transPaymentMethodObj;

// call API with payin/payment
$result = $api->PayIn->payment($paymentObj);
?>

Here, we call API with payin/paymentMethods (Method POST)

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();
$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

//transaction amount object creation
$amountObj = new \CAPSPaymentApi\Amount('', '');
//valuation of the object
$amountObj->value = '100';
$amountObj->currency = 'EUR';

//payer object creation
$payerObj = new \CAPSPaymentApi\Payer("192.168.0.1", "testPayer", "", "FR");
//valuation of the object
$payerObj->IPAddress = '192.168.0.1';
$payerObj->reference = 'testPayer';
$payerObj->userAgent = '';
$payerObj->language = 'FR';


//payment methods object creation
$paymentMethodsObj = new \CAPSPaymentApi\PaymentMethodPayinsOptions('', '', '', '');
//valuation of the object
$paymentMethodsObj->orderReference = 'OrderTestPayin';
$paymentMethodsObj->orderCountryCode = 'FRA';
$paymentMethodsObj->amount = $amountObj;
$paymentMethodsObj->payer = $payerObj;

// call API with payin/paymentMethods
$result = $api->PayIn->paymentMethods($paymentMethodsObj);
?>

Here, we call API with payin/orderDetails (Method GET)

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

// call API with payin/orderDetails
$orderDetails = new \CAPSPaymentApi\OrderDetailsPayinsOptions('4596521');
$result = $api->PayIn->orderDetails($orderDetails);
?>

List SDK functions to use for API Operation

You will find in this table which function to used for each API "Operation" endpoint :

Operation Endpoint SDK Functions Method
/operations/list $api->Operation->operationList($object) POST

Example

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

$listOperationOptions = new \CAPSPaymentApi\ListOperationOptions('10', '1', '010820101000', '281020101900', '150.00', '100.00', '123456', 'EUR', '123456', 'SDD', '234567', '345678');

// call API with /operations/list
$result = $api->Operation->operation_list($listOperationOptions);

?>

List SDK functions to use for API PaymentAccount

You will find in this table which function to used for each API "PaymentAccount" endpoint :

PaymentAccount Endpoint SDK Functions Method
/paymentAccount/setFloorLimit $api->PaymentAccount->setFloorLimit($payload) POST
/paymentAccount/setIBAN $api->PaymentAccount->setIBAN($payload) POST
/paymentAccount/List $api->PaymentAccount->List($payload) POST
/paymentAccount $api->PaymentAccount->paymentAccount(payload) GET
/paymentAccount/payoutAuto $api->PaymentAccount->payoutAuto(payload) POST
/paymentAccount/credit $api->PaymentAccount->credit(payload) POST
/paymentAccount/disableIBAN $api->PaymentAccount->disableIBAN(payload) POST
/paymentAccount/report $api->PaymentAccount->report(payload) GET

Examples

Here, we call API with paymentAccount/List (Method POST)

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

// encode array to json object
$listPaymentAccountOptions = new \CAPSPaymentApi\ListPaymentAccountOptions('1300600000EUR01005110', 'EUR', 'A', '123456');

// call API with paymentAccount/modifyIBAN
$result = $api->PaymentAccount->List($listPaymentAccountOptions);

?>

Here, we call API with /paymentAccount (Method GET)

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

// call API with /paymentAccount
$paymentAccount = new \CAPSPaymentApi\PaymentAccountOptions('1300600000EUR01005110');
$result = $api->PaymentAccount->payment_account($paymentAccount);

?>

List SDK functions to use for API Payout

You will find in this table which function to used for each API "Payout" endpoint :

Payout Endpoint SDK Functions Method
/payout/create $api->Payout->create(payload) POST

Example

Here, we call API with /payout/create

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

$createPayoutsOptions = new \CAPSPaymentApi\CreatePayoutsOptions("RefEndToEnd1", new \CAPSPaymentApi\Amount("50.00", "EUR"), "PM2021011300GLR1100", "", "test", "1300600000EUR01006110", new \CAPSPaymentApi\Comission("50.00", "1300600000EUR60002411"), "123456");

// call API with /payout/create
$result = $api->Payout->create($createPayoutsOptions);

?>

List SDK functions to use for API Transfer

You will find in this table which function to used for each API "Transfert" endpoint :

Transfer Endpoint SDK Functions Method
/transfer/create $api->Transfer->create(payload) POST

Example

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

$createTransfersOptions = new \CAPSPaymentApi\CreateTransfersOptions("1300600000EUR01006110", new \CAPSPaymentApi\Amount("50.00", "EUR"), "", "Operation label", "1300600000EUR01004110", "ref178623786");

// call API with /transfert/create
$result = $api->Transfer->create($createTransfersOptions);

?>

List SDK functions to use for API AccountHolder

You will find in this table which function to used for each API "AccountHolder" endpoint :

Transfer Endpoint SDK Functions Method
/accountHolder/register $api->AccountHolder->register(payload) POST
/accountHolder/update $api->AccountHolder->update(payload) POST
/accountHolder/uploadDocument $api->AccountHolder->uploadDocument(payload) POST
/accountHolder/registrationDetails $api->AccountHolder->registrationDetails(payload) GET
/accountHolder/unregister $api->AccountHolder->unregister(payload) POST

Example

Here, we call API with /accountHolder/register (Method POST)

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

$registerAccountHolder = new \CAPSPaymentApi\RegisterAccountHolderOptions("123456", "reason", "compagny", "FRA", "SA", "4252378780001", new \CAPSPaymentApi\RegisterAddress("5 rue de blabla", 'City', '75019', 'FRA'), new \CAPSPaymentApi\RegisterAddress("5 rue de blabla", 'City', '75019', 'FRA'), "2020", "Y", new \CAPSPaymentApi\RegisterPerson('moi', 'moi', 'F', 'email@email.fr', '010101010101', array(new \CAPSPaymentApi\Role('BE'), new \CAPSPaymentApi\Role('MD')), '19800101'), new \CAPSPaymentApi\RegisterAccount('FRA', 'EUR', 'FR7611808009101234567890147', '230.00'));

// call API with /accountHolder/register
$result = $api->AccountHolder->register($registerAccountHolder);

?>

Here, we call API with /accountHolder/registrationDetails (Method GET)

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

// call API with /accountHolder/registrationDetails
$registrationDetails = new \CAPSPaymentApi\RegistrationDetailsAccountHolderOptions('CAPS202201120YYEX1');
$result = $api->AccountHolder->registrationDetails($registrationDetails);

?>

List SDK functions to use for API Selfcare

You will find in this table which function to used for each API "Selfcare" endpoint :

Selfcare Endpoint SDK Functions Method
/selfcare/init $api->Selfcare->init(payload) POST

Example

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

$initSelfcareOptions = new \CAPSPaymentApi\InitSelfcareOptions("Olivier", "GARIN", "olivier.garin@email.fr", "0123456789", "GARIN & Fils", "100.00", "FR");

// call API with /selfcare/init
$result = $api->Selfcare->init($initSelfcareOptions);

?>

List SDK functions to use for API Mandate

You will find in this table which function to used for each API "Mandate" endpoint :

Mandate Endpoint SDK Functions Method
/mandate/create $api->Mandate->create(payload) POST
/mandate/update $api->Mandate->update(payload) POST

Example 1 (SDD B2C mandate generation)

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

$obj_transPaymentMethod = new \CAPSPaymentApi\TransPaymentMethod('');
$obj_payer              = new \CAPSPaymentApi\Payer('','','','');
$obj_details            = new \CAPSPaymentApi\Details('','','','','','','','','','','','','','','');
$str_urlRedirect        = '';

$obj_transPaymentMethod->id =  '37';

$obj_payer->reference = 'customer1';

$obj_details->gender      = 'M';
$obj_details->firstName   = 'John';
$obj_details->lastName    = 'Smith';
$obj_details->email       = 'js@mycompagny.com';
$obj_details->address     = 'Rue d\'ici';
$obj_details->postalCode  = '75000';
$obj_details->city        = 'Ville';
$obj_details->country     = 'FRA';
$obj_details->iban        = 'FR7611808009101234567890147';
$obj_details->sequence    = 'OOF';


$createMandateOptions = new \CAPSPaymentApi\CreateMandateOptions($obj_transPaymentMethod, $obj_payer, $obj_details, $str_urlRedirect);

// call API with /selfcare/init
$result = $api->Mandate->create($createMandateOptions);

?>

Example 2 (SDD B2B mandate generation)

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

$obj_transPaymentMethod = new \CAPSPaymentApi\TransPaymentMethod('');
$obj_payer              = new \CAPSPaymentApi\Payer('','','','');
$obj_details            = new \CAPSPaymentApi\Details('','','','','','','','','','','','','','','');
$str_urlRedirect        = '';

$obj_transPaymentMethod->id =  '20';

$obj_payer->reference = 'customer1';

$obj_details->socialReason  = 'My compagny';
$obj_details->email         = 'js@mycompagny.com';
$obj_details->address       = 'Rue d\'ici';
$obj_details->postalCode    = '75000';
$obj_details->city          = 'Ville';
$obj_details->country       = 'FRA';
$obj_details->iban          = 'FR7611808009101234567890147';
$obj_details->sequence      = 'RCUR';


$createMandateOptions = new \CAPSPaymentApi\CreateMandateOptions($obj_transPaymentMethod, $obj_payer, $obj_details, $str_urlRedirect);

// call API with /selfcare/init
$result = $api->Mandate->create($createMandateOptions);

?>

Example 3 update

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

$updateMandateOptions = new \CAPSPaymentApi\UpdateMandateOptions('', '');
$updateMandateOptions->reference = '2020110907201100Y0H1102';
$updateMandateOptions->mandateId = '5120';

// call API with /selfcare/init
$result = $api->Mandate->update($updateMandateOptions);

?>

List SDK functions to use for API PaymentMethod

You will find in this table which function to used for each API "PaymentMethod" endpoint :

PaymentMethod Endpoint SDK Functions Method
/paymentMethod/removeAlias $api->PaymentMethod->removeAlias(payload) POST
/paymentMethod/getAlias $api->PaymentMethod->getAlias(payload) POST
/paymentMethod/list $api->PaymentMethod->list(payload) POST
/paymentMethod/getIBAN $api->PaymentMethod->getIBAN(payload) POST

Examples

<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

$obj_payer              = new \CAPSPaymentApi\Payer('','','','');
$obj_transPaymentMethod = new \CAPSPaymentApi\TransPaymentMethod('');
$obj_alias = new \CAPSPaymentApi\Alias('');

$obj_payer->reference = 'payer_123';
$obj_transPaymentMethod->id =  '83964924';
$obj_alias->id = '228202063053068462';


$removeAliasPaymentMethodOptions = new \CAPSPaymentApi\RemoveAliasPaymentMethodOptions($obj_payer, $obj_transPaymentMethod, $obj_alias);

// call API with /selfcare/init
$result = $api->PaymentMethod->removeAlias($removeAliasPaymentMethodOptions);

?>
<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

$obj_payer              = new \CAPSPaymentApi\Payer('','','','');
$obj_transPaymentMethod = new \CAPSPaymentApi\TransPaymentMethod('');

$obj_payer->reference = 'payer_ref';
$obj_transPaymentMethod->id =  '83964924';


$getAliasPaymentMethodOptions = new \CAPSPaymentApi\GetAliasPaymentMethodOptions($obj_payer, $obj_transPaymentMethod);

// call API with /selfcare/init
$result = $api->PaymentMethod->getAlias($getAliasPaymentMethodOptions);

?>
<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

$obj_payer      = new \CAPSPaymentApi\Payer('','','','');
$obj_contryCode = 'FRA';
$obj_amount     = new \CAPSPaymentApi\Amount('', '');

$obj_payer->language = 'FR';
$obj_payer->reference = 'CREF_20210203180537464';
$obj_payer->IPAddress = '192.168.0.1';

$obj_amount->value = '70';
$obj_amount->currency = 'EUR';

$listPaymentMethodOptions = new \CAPSPaymentApi\ListPaymentMethodOptions($obj_contryCode, $obj_amount, $obj_payer);

// call API with /selfcare/init
$result = $api->PaymentMethod->list($listPaymentMethodOptions);

?>
<?php
require_once '/absolute/path/sdk/api/vendor/autoload.php';

$api = new CAPSPaymentApi\Main();

$api->Config->BaseUrl = 'http://hostname:port/version';
$api->Config->TokenUrl = 'your_url';
$api->Config->TokenUser = 'your_username';
$api->Config->TokenPassword = 'your_password';

$getIBANPaymentMethodOptions = new \CAPSPaymentApi\GetIBANPaymentMethodOptions('PM202310230V3FG1100');

// call API with /selfcare/init
$result = $api->PaymentMethod->getIBAN($getIBANPaymentMethodOptions);

?>