Package: pagacollect
Paga Collect Python libraryThe Paga Collect API allows anyone to initiate a payment request to a third party and automatically get notified when the payment request is fulfilled. This library makes it easier and faster for developers to integrate the API1. InstallationMake sure you havepipinstalled, then run the command belowpipinstallpagacollect2. UsageOnce installed to use the library see sample code below:frompagacollect.paga_collectimportCollectprincipal="public_key"credentials="private"hash_key="hash_key"collect=Collect(principal,credentials,hash_key,False)Paga Collect API OperationsNow that you have created a collect api object you easily call its operationsRequest PaymentRegister a new request for payment between a payer and a payee. Once a payment request is initiated successfully, the payer is notified by the platform (this can be suppressed) and can proceed to authorize/execute the payment. Once the payment is fulfilled, a notification is sent to the supplied callback URL. See the callback notification section for more details.To make a payment request see sample code below:payment_request_payload={"referenceNumber":"6020000011z","amount":"100","currency":"NGN","payer":{"name":"John Doe","phoneNumber":"07033333333","bankId":"3E94C4BC-6F9A-442F-8F1A-8214478D5D86"},"payee":{"name":"Payee Tom","accountNumber":"1188767464","bankId":"40090E2F-7446-4217-9345-7BBAB7043C4C","bankAccountNumber":"0000000000","financialIdentificationNumber":"03595843212"},"expiryDateTimeUTC":"2021-05-27T00:00:00","isSuppressMessages":"true","payerCollectionFeeShare":"0.5","payeeCollectionFeeShare":"0.5","isAllowPartialPayments":"true","callBackUrl":"http://localhost:9091/test-callback","paymentMethods":["BANK_TRANSFER","FUNDING_USSD"],"displayBankDetailToPayer":False}response=collect.payment_request(payment_request_payload)Register Persistent Payment AccountAn operation for business to create Persistent Payment Account Numbers that can be assigned to their customers for payment collection.To create a persistent payment account see sample code below:register_persistent_payment_account_payload={"referenceNumber":"test123451","phoneNumber":"07022222222","accountName":"Joh Doe","firstName":"John","lastName":"Doe","email":"john@doe.com","accountReference":"22222222222220","financialIdentificationNumber":"22182799077","creditBankId":"3E94C4BC-6F9A-442F-8F1A-8214478D5D86","creditBankAccountNumber":"0000000000","callbackUrl":"http://localhost:9091/test-callback"}response=collect.register_persistent_payment_account(register_persistent_payment_account_payload)Query StatusQuery the current status of a submitted requestTo check the status of a submitted request see sample code below:status_payload={"referenceNumber":"82000001109",}response=collect.get_status(status_payload)Query HistoryGet payment requests for a period between given start and end dates. The period window should not exceed 1 month.See sample code below:history_payload={"referenceNumber":"82000001109","startDateTimeUTC":"2021-05-13T19:15:22","endDateTimeUTC":"2021-05-20T19:15:22"}response=collect.get_history(history_payload)Get BanksRetrieve a list of supported banks and their complementary unique ids on the bank. This is required for populating the payer (optional) and payee objects in the payment request model.See usage sample code below:banks_payload={"referenceNumber":"0001109"}response=collect.get_banks(banks_payload)Payment Request RefundThis end-point can be used to either cancel or initiate a refund if we were unable to fulfill the request for one reason or the other.See usage sample code below:refund_payload={"referenceNumber":"12345","refundAmount":1000.0,"currency":"NGN","reason":"no particular reason"}response=collect.payment_request_refund(refund_payload)Delete Persistent Payment AccountThis endpoint allows for deleting a persistent payment account.See usage sample code below:delete_payload={"referenceNumber":"23402359879879997","accountIdentifier":"0830202843","reason":"off-boarded account"}response=collect.delete_persistent_payment_account(delete_payload)Get Persistent Payment AccountA method to query the properties associated with an existing persistent payment account.See usage sample code below:get_payload={"referenceNumber":"23402359879879997","accountIdentifier":"2806605308"}response=collect.get_persistent_payment_account(get_payload)Update Persistent Payment AccountThis endpoint allows for changing any of the account properties except theaccountNumber (NUBAN)and theaccounReferenceproperties which cannot be changed.See usage sample code below:update_payload={"referenceNumber":"23402359879879996","accountIdentifier":"0830202843","phoneNumber":"0910220042","firstName":"Renamed","lastName":"Customer","accountName":"Renamed Customer","financialIdentificationNumber":"12345454666","callbackUrl":"http://77d761893689.ngrok.io/persistent/000000000009/Password6","creditBankId":"40090E2F-7446-4217-9345-7BBAB7043C4C","creditBankAccountNumber":"0000000031"}response=collect.update_persistent_payment_account(update_payload)