Download the PHP package paypayue/paypay-soap-php without Composer
On this page you can find all versions of the php package paypayue/paypay-soap-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download paypayue/paypay-soap-php
More information about paypayue/paypay-soap-php
Files in paypayue/paypay-soap-php
Package paypay-soap-php
Short Description PHP helper library for PayPay SOAP API integration.
License MIT
Homepage https://github.com/paypayue/paypay-soap-php
Informations about the package paypay-soap-php
Repo has been discontinued, please check out the REST API documentation
PayPay PHP SOAP Library
Official library for PayPay SOAP API integrations written in PHP.
Requirements
- The library requires PHP version 5.4.0 or higher and the SOAP extension.
Installation
We recommend that you use Composer a package manager for PHP. In the composer.json file in your project add:
In your project folder run the following command:
Then add the following line at the beginning of your code:
If you can't use Composer simply download our PHP library by hitting the link below then integrate it into your project.
Getting started
Configure the environment with your platform credentials, or use the following for testing:
Creating a payment reference
Use this method to quickly obtain a payment reference that you can send to your customer.
(Optional) Specify the destination bank account for the payment
(Optional) Specify the payment options your customer may use to pay. Otherwise we will use the options configured on your PayPay account.
Refer to the following files for allowed parameters:
- Codes
- Types
Payment with redirect
This method is recommended for instances where the payment is made straight away, such as during a checkout process.
(Optional) Specify the destination bank account for the payment
(Optional) Specify the payment options, default is credit card.
Additional payment information
(Optional) If you choose to send the customer info we can email them the payment receipt
(Optional) If you choose to send the billing address add them the payment receipt
(Optional) If you choose to send the shipping address add them the payment receipt
Send references generated locally
Use the following method to send references generated locally with a configured reference range. The reference range must be previously configured in PayPay only references that are within the configured range will be accepted.
schedule for retry and/or discard submitted references
Cancel payment
Use this method to quickly cancel a payment that is no longer valid according to your business context. All payment methods will be cancelled currently only the following methods support cancellation:
- Multibanco Real-time;
- Credit/debit card;
- MB WAY.
(Optional) Some methods cannot be cancelled (Eg.: Multibanco Normal) but you may bypass this and still mark the payment as cancelled.
Process incoming payments by Webhook
Use the following method to supply a url that will process all successful payments.
PayPay will make an HTTP request to your url with POST data of the payments that were confirmed. You can use the following code to jump start your payment processing.
Additional Notes
- PayPay expects a header in response to the webhook request. This signals that the payments we're received successfully. Otherwise, we will retry calling your url 3 times within 30 minute intervals.
- Since PayPay may have to do repeat requests, as a failsafe you should check that each payment is not already processed on your side.
- The request has a 30s timeout so it's not recommended that you do any "heavy lifting" (eg. sending emails, slow queries, etc.) during this process.
Documentation
- Official Documentation (portuguese)