Skip to content

Latest commit

 

History

History
206 lines (157 loc) · 6.82 KB

README.md

File metadata and controls

206 lines (157 loc) · 6.82 KB

CAPSPAYMENT PYTHON SDK

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

Requirements

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

  • Python >= v3.8
  • Modules => requirements.txt  

Install

python setup.py install

or

pip install -r requirements.txt

 

Quick Start

  • 1 - Init Api
    ex: Payment Account API

    from api import CAPSPaymentAPI  
api_request = CAPSPaymentAPI(
    api_url,
    token_url,
    token_user,
    token_password,
).payment_account_api()

    or

    from api import CAPSPaymentAPI  
api_main = CAPSPaymentAPI(
    api_url,
    token_url,
    token_user,
    token_password,
)
api_request = api_main.payment_account_api()

  • 2 - Call API method
    ex: call payment_account

    payload = {'accountNumber': '1300600000EUR01004110'}  
response = api_request.payment_account(payload)

 

API links:

API Method
Account Holder account_holder_api
Mandate mandate_api
Operations operations_api
Payin payin_api
Payment Account payment_account_api
Payment Method payment_method_api
Payout payout_api
SelfCare selfcare_api
Transfer transfer_api

 

List SDK functions to use for API AccountHolder

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

AccountHolder Endpoint SDK Functions Method
/accountHolder/register ApiAccountHolder.register(payload) POST
/accountHolder/unregister ApiAccountHolder.unregister(payload) POST
/accountHolder/update ApiAccountHolder.update(payload) POST
/accountHolder/uploadDocument ApiAccountHolder.upload_document(payload) POST
/accountHolder/registrationDetails ApiAccountHolder.registration_details(payload) GET

 

List SDK functions to use for API Mandate

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

Mandate Endpoint SDK Functions Method
/mandate/create ApiMandate.create(payload) POST
/mandate/update ApiMandate.update(payload) POST

 

List SDK functions to use for API Operation

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

Operation Endpoint SDK Functions Method
/operations/list ApiOperations.operation_list(payload) POST

 

List SDK functions to use for API Payin

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

Payin Endpoint SDK Functions Method
/payin/payment ApiPayin.payment(payload) POST
/payin/paymentDetails ApiPayin.payment_details(payload) POST
/payin/paymentMethods ApiPayin.payment_methods(payload) POST
/payin/capture ApiPayin.capture(payload) POST
/payin/cancel ApiPayin.cancel(payload) POST
/payin/orderDetails ApiPayin.order_details(payload) GET
/payin/adjustPayment ApiPayin.adjust_payment(payload) POST
/payin/paymentIframe ApiPayin.payment_iframe(payload) POST
/payin/refund ApiPayin.refund(payload) POST
/payin/mandate ApiPayin.mandate(payload) GET
/payin/ticket ApiPayin.ticket(payload) GET
/payin/reload ApiPayin.reload(payload) POST

 

List SDK functions to use for API PaymentAccount

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

PaymentAccount Endpoint SDK Functions Method
/paymentAccount/setFloorLimit ApiPaymentAccount.set_floor_limit(payload) POST
/paymentAccount/setIBAN ApiPaymentAccount.set_iban(payload) POST
/paymentAccount/disableIBAN ApiPaymentAccount.disable_iban(payload) POST
/paymentAccount/List ApiPaymentAccount.payment_account_list(payload) POST
/paymentAccount/recharge ApiPaymentAccount.recharge(payload) POST
/paymentAccount ApiPaymentAccount.payment_account(payload) GET
/paymentAccount/payoutAuto ApiPaymentAccount.payout_auto(payload) POST
/paymentAccount/credit ApiPaymentAccount.credit(payload) POST
/paymentAccount/create ApiPaymentAccount.create(payload) POST
/paymentAccount/report ApiPaymentAccount.report(payload) GET

 

List SDK functions to use for API Payment Method

You will find in this table which function to use for each API "Payment Method" endpoint :

Payment Method Endpoint SDK Functions Method
/paymentMethod/removeAlias ApiPaymentMethod.remove_alias(payload) POST
/paymentMethod/getAlias ApiPaymentMethod.get_alias(payload) POST
/paymentMethod/list ApiPaymentMethod.payment_method_list(payload) POST
/paymentMethod/getIBAN ApiPaymentMethod.get_iban(payload) POST

 

List SDK functions to use for API Payout

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

Payout Endpoint SDK Functions Method
/payout/create ApiPayout.create(payload) POST

 

List SDK functions to use for API SelfCare

You will find in this table which function to use for each API "SelfCare" endpoint :

SelfCare Endpoint SDK Functions Method
/selfcare/init ApiSelfCare.init(payload) POST

 

List SDK functions to use for API Transfer

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

Transfer Endpoint SDK Functions Method
/transfer/create ApiTransfer.create(payload) POST