├── .gitignore ├── LICENSE ├── README.md ├── _config.yml ├── composer.json ├── src ├── Base.php ├── CURL.php ├── Transaction.php └── Utility │ ├── Debug.php │ ├── Http.php │ └── Text.php └── test ├── callback.php └── index.php /.gitignore: -------------------------------------------------------------------------------- 1 | composer.phar 2 | /vendor/ 3 | 4 | # Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file 5 | # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file 6 | # composer.lock 7 | 8 | /.idea -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # matscode/paystack-php 2 | 3 | 4 | This currently repository development has been discontinued. Development of `v2.0.0` and above has now moved to [matscode/paystack-php-sdk](https://github.com/matscode/paystack-php-sdk) with new improved structure, documentation, demo and overall dev experience. 5 | 6 | #### TODO - RoadMap 7 | - `Use GuzzleHttp` 8 | - `Customers` 9 | - `Plans` 10 | - `Subscription` 11 | - `Transfers` 12 | - `Charges` 13 | - `others...` 14 | 15 | ###### This package is for communicating with PAYSTACK RESTful API. [Paystack](https://paystack.com/) 16 | Having other resource point available on PAYSTACK API, Resources like; 17 | - Transaction 18 | - Customers 19 | - Plans 20 | - Subscription 21 | - Transfers 22 | - Charges 23 | - and many more 24 | 25 | Just to name a few, it is only the Transaction Resource that is made available currently in this package. Development is ongoing while releases are Stable. Incase you find a BUG/Security Issue, Please, do be kind to open an issue or email [matscode at Gmail dot Com](mailto://matscode@gmail.com). 26 |
27 | **PS**: This library also works for you if you use paystack inline. You just have to use the `verify()` method, passing in your transaction `$reference|$token|$id` is compulsory. 28 | 29 | ## Requirements 30 | - Curl 31 | 32 | ## Install 33 | 34 | ### Via Composer 35 | 36 | ``` bash 37 | $ composer require matscode/paystack 38 | ``` 39 | If you use a Framework, check your documentation for how vendor packages are autoloaded else Add this to the top of your source file; 40 | 41 | ``` php 42 | require_once __DIR__ . "/vendor/autoload.php"; 43 | ``` 44 | 45 | ## Making Transactions/Recieving Payment 46 | 47 | ### Starting Up Paystack Transaction 48 | 49 | ``` php 50 | use Matscode\Paystack\Transaction; 51 | use Matscode\Paystack\Utility\Debug; // for Debugging purpose 52 | use Matscode\Paystack\Utility\Http; 53 | 54 | $secretKey = 'sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'; 55 | 56 | // creating the transaction object 57 | $Transaction = new Transaction( $secretKey ); 58 | ``` 59 | 60 | ### Initializing Transaction 61 | 62 | Set data/payload/requestBody to post with initialize request. Minimum required data are email and amount. 63 | 64 | ``` php 65 | // Set data to post using array 66 | $data = 67 | [ 68 | 'email' => 'customer@email.com', 69 | 'amount' => 500000 // amount is treated in kobo using this method 70 | ]; 71 | $response = $Transaction->initialize($data); 72 | ``` 73 | OR 74 | ``` php 75 | // Set data to post using this method 76 | $response = 77 | $Transaction 78 | ->setCallbackUrl('http://michaelakanji.com') // to override/set callback_url, it can also be set on your dashboard 79 | ->setEmail( 'matscode@gmail.com' ) 80 | ->setAmount( 75000 ) // amount is treated in Naira while using this method 81 | ->setMetadata(['custom_field1' => 'value1', 'custom_field2' => 'value2']) 82 | ->initialize(); 83 | ``` 84 | If you want to get the 200OK raw Object as it is sent by Paystack, Set the 2nd argument of the `initialize()` to `true`, example below 85 | ``` php 86 | // Set data to post using this method 87 | $response = 88 | $Transaction 89 | ->setEmail( 'matscode@gmail.com' ) 90 | ->setAmount( 75000 ) // amount is treated in Naira while using this method 91 | ->initialize([], true); 92 | ``` 93 | Now do a redirect to payment page (using authorization_url) 94 |
95 | NOTE: Recommended to Debug `$response` or check if authorizationUrl is set, and save your Transaction reference code. useful to verify Transaction status 96 | 97 | ``` php 98 | // recommend to save Transaction reference in database and do a redirect 99 | $reference = $response->reference; 100 | // redirect 101 | Http::redirect($response->authorizationUrl); 102 | ``` 103 | Using a Framework? It is recommended you use the reverse routing/redirection functions provided by your Framework 104 | 105 | 106 | ### Verifying Transaction 107 | This part would live in your callback file i.e `callback.php` or `whatsoever_you_name.php` 108 |
109 | It is also imperative that you create Transaction Obj once more. 110 |
111 | This method would return the Transaction Obj but `false` if saved `$reference` is not passed in as argument and also cant be guessed. Using `verify()` would require you do a manual check on the response Obj 112 | ``` php 113 | $response = $Transaction->verify(); 114 | // Debuging the $response 115 | Debug::print_r( $response); 116 | ``` 117 | OR 118 | ``` php 119 | // This method does the check for you and return `(bool) true|false` 120 | $response = $Transaction->isSuccessful(); 121 | ``` 122 | The two methods above try to guess your Transaction `$reference` but it is highly recommended you pass the Transaction `$reference` as an argument on the method as follows 123 | ``` php 124 | // This method does the check for you and return `(bool) true|false` 125 | $response = $Transaction->isSuccessful($reference); 126 | ``` 127 | Moreso, you can also compare if amount paid by customer is the amount expected. This method only works after calling `verify()` or `isSuccessful()` in the same script. It is recommended to do this if you use paystack inline to initialize the transaction. 128 | ``` php 129 | $amountExpected = 5000; // amount must be in kobo 130 | // returns `(bool) true|false` 131 | $Transaction->amountEquals($amountExpected); 132 | ``` 133 | Now you can process Customer Valuable. 134 |
135 |
136 | You might wanna save Transaction `$authorizationCode` for the current customer subsequent Transaction but not a nessecity. It would only counts to future updates of this package or if you choose to extend the package. 137 | ``` php 138 | // returns Auth_xxxxxxx 139 | $response = $Transaction->authorizationCode($reference); // can also guess Transaction $reference 140 | ``` 141 | 142 | ## Hire Me 143 | I am available on contract if you need help integrating paystack into your Business Website or something. 144 |
145 | Contact me via my email above - [michaelakanji.com](http://michaelakanji.com) 146 | 147 | ## Contributions 148 | If you seem to understand the architecture, you are welcome to fork and pull else you can wait a bit more till when i provide convention documentation. 149 | 150 | ## Licence 151 | GNU GPLV3 152 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-midnight -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "matscode/paystack", 3 | "description": "This package is for communicating with PAYSTACK API", 4 | "type": "library", 5 | "keywords": ["payment","paystack", "php"], 6 | "license": "GPL-3.0-only", 7 | "minimum-stability": "stable", 8 | "autoload": { 9 | "psr-4": {"Matscode\\Paystack\\": "src/"} 10 | }, 11 | "authors": [ 12 | { 13 | "name": "Michael Akanji", 14 | "email": "matscode@gmail.com", 15 | "homepage": "http://michaelakanji.com" 16 | } 17 | ], 18 | "require": {} 19 | } 20 | -------------------------------------------------------------------------------- /src/Base.php: -------------------------------------------------------------------------------- 1 | 9 | * @date 2017-06-26 10 | * @copyright (c) 2016 - 2017, TECRUM (http://www.tecrum.com) 11 | * 12 | */ 13 | 14 | namespace Matscode\Paystack; 15 | 16 | use Matscode\Paystack\CURL; 17 | use Matscode\Paystack\Utility\Text; 18 | 19 | class Base 20 | { 21 | 22 | private 23 | $_apiBaseUrl = 'https://api.paystack.co/', // with trailing slash 24 | $_curl, 25 | $_secretKey, 26 | $_endPoint, 27 | 28 | /*Getting Error Infomation*/ 29 | $_errorMessages = []; 30 | 31 | public 32 | $resource, 33 | $action, 34 | $args, 35 | $data, 36 | // response from the endpoint 37 | $response; 38 | 39 | public function __construct( $secretKey ) 40 | { 41 | // save key in memory 42 | $this->_secretKey = $secretKey; 43 | 44 | return $this; 45 | } 46 | 47 | public function setResource( $resource ) 48 | { 49 | $this->resource = $resource; 50 | 51 | return $this; 52 | } 53 | 54 | public function setAction( $action, array $args = [] ) 55 | { 56 | if ( ! is_array( $args ) ) { 57 | throw new \Exception( 'Action arguments can only be of datatype Array' ); 58 | } 59 | 60 | $this->action = $action; 61 | $this->args = $args; 62 | 63 | return $this; 64 | } 65 | 66 | /** 67 | * Initiate Request to the paystack RESTful API and return response Obj 68 | * 69 | * @param array $withData 70 | * @param string $requestMethod 71 | * @param bool $returnArray set to true to return response as associate array 72 | * 73 | * @todo Utilize the third argument.. 74 | * 75 | * @return mixed 76 | * @throws \Exception 77 | */ 78 | public function sendRequest( array $withData = [], $requestMethod = 'POST', $returnArray = false ) 79 | { 80 | if ( ! is_array( $withData ) ) { 81 | throw new \Exception( 'sendRequest arguments can only be of datatype Array' ); 82 | } 83 | 84 | $this->data = $withData; 85 | 86 | $this->_endPoint = $this->_apiBaseUrl . 87 | Text::removeSlashes( $this->resource ) . '/' . 88 | Text::removeSlashes( $this->action ); 89 | // append parameters to endPoint 90 | if ( count( $this->args ) > 0 ) { 91 | $this->_endPoint .= '/' . implode( '/', $this->args ); 92 | } 93 | 94 | // send the request and return result as json object 95 | $this->_curl = 96 | ( new CURL( 97 | $this->_endPoint, 98 | $requestMethod ) ) 99 | ->setRequestHeader( 'Authorization', 'Bearer ' . $this->_secretKey ); 100 | 101 | $this->response = 102 | json_decode( 103 | $this->_curl 104 | ->run( $this->data, 'json' ) ); 105 | 106 | return $this->response; 107 | } 108 | 109 | /** 110 | * @return mixed 111 | */ 112 | public function getEndPoint() 113 | { 114 | // this works only after executing sendRequest 115 | return $this->_endPoint; 116 | } 117 | 118 | /** 119 | * @param mixed $errorMessages 120 | */ 121 | public function setErrorMessages( $errorMessages ) 122 | { 123 | //if errorMessages is string 124 | if ( is_string( $errorMessages ) ) { 125 | $this->_errorMessages[] = $errorMessages; 126 | } 127 | //if errorMessages is array 128 | if ( is_array( $errorMessages ) ) { 129 | $this->_errorMessages = array_merge( $this->_errorMessages, $errorMessages ); 130 | } 131 | } 132 | 133 | /** 134 | * @param bool $toString 135 | * @param string $delimiter 136 | * 137 | * @return array|string 138 | */ 139 | public function getErrorMessages( $toString = false, $delimiter = '
' ) 140 | { 141 | $errorMessages = $this->_errorMessages; 142 | if ( $toString ) { 143 | // return errorMessage as String 144 | unset( $errorMessages ); //to avoid datatype conflict 145 | $errorMessages = join( $delimiter, $this->_errorMessages ); 146 | } 147 | 148 | return $errorMessages; 149 | } 150 | 151 | 152 | } -------------------------------------------------------------------------------- /src/CURL.php: -------------------------------------------------------------------------------- 1 | 9 | * @date 2017-06-25 10 | * @copyright (c) 2016 - 2017, TECRUM (http://www.tecrum.com) 11 | * 12 | */ 13 | 14 | namespace Matscode\Paystack; 15 | 16 | class CURL 17 | { 18 | private 19 | $_url, 20 | $_curl, 21 | $_requestWithPost = false, 22 | $_allowedReqMethodForPost = 23 | [ 24 | 'POST', 25 | 'UPDATE', 26 | 'PUT', 27 | 'PATCH', 28 | ], 29 | $_errorCode, 30 | $_errorMessage; 31 | 32 | public 33 | $requestMethod, 34 | $requestHeader = []; 35 | 36 | const 37 | USER_AGENT = 'PHP CURL/1.0 (@matscode)'; 38 | 39 | 40 | public function __construct( $url, $requestMethod = null ) 41 | { 42 | if ( ! extension_loaded( 'curl' ) ) { 43 | throw new \ErrorException( 'CURL Extension not loaded, Install libcurl php extension' ); 44 | } 45 | 46 | //initialize CUrl 47 | $this->_url = $url; 48 | $this->_curlInit( $this->_url ); 49 | 50 | //set requestMethod property 51 | $this->requestMethod = $requestMethod; 52 | 53 | //set the default request method to 'POST' 54 | if ( ! is_null( $this->requestMethod ) ) { 55 | $this->setRequestMethod( $this->requestMethod ); 56 | } 57 | 58 | return $this; 59 | } 60 | 61 | private function _curlInit( $url ) 62 | { 63 | $this->_curl = curl_init(); 64 | 65 | $this->setOption( CURLOPT_USERAGENT, self::USER_AGENT ) 66 | ->setOption( CURLOPT_URL, $url ) 67 | // return response 68 | ->setOption( CURLOPT_RETURNTRANSFER, true ); 69 | 70 | // turn off caching 71 | $this->setRequestHeader( 'Cache-Control', 'no-cache' ); 72 | 73 | return $this; 74 | } 75 | 76 | public function setOption( $option, $value ) 77 | { 78 | // Set curl option 79 | curl_setopt( $this->_curl, $option, $value ); 80 | 81 | return $this; 82 | } 83 | 84 | public function setRequestMethod( $requestMethod ) 85 | { 86 | switch ( $requestMethod ) { 87 | case 'GET' : 88 | $this->setOption( CURLOPT_HTTPGET, true ); 89 | break; 90 | case 'UPDATE' : 91 | $this->setOption( CURLOPT_CUSTOMREQUEST, 'UPDATE' ); 92 | break; 93 | case 'PUT' : 94 | $this->setOption( CURLOPT_CUSTOMREQUEST, 'PUT' ); 95 | break; 96 | case 'PATCH' : 97 | $this->setOption( CURLOPT_CUSTOMREQUEST, 'PATCH' ); 98 | break; 99 | case 'DELETE' : 100 | $this->setOption( CURLOPT_CUSTOMREQUEST, 'DELETE' ); 101 | break; 102 | case 'POST': 103 | $this->doPostRequest(); 104 | 105 | default: 106 | $this->setOption( CURLOPT_POST, true ); 107 | break; 108 | } 109 | 110 | return $this; 111 | } 112 | 113 | 114 | /** 115 | * @param null $qStringArray 116 | * 117 | * @return string 118 | */ 119 | public function getUrl( $qStringArray = null ) 120 | { 121 | if ( ! is_null( $qStringArray ) && 122 | ( is_array( $qStringArray ) || is_object( $qStringArray ) ) 123 | ) { 124 | $this->_url .= '?' . http_build_query( $qStringArray ); 125 | } 126 | 127 | return $this->_url; 128 | } 129 | 130 | /** 131 | * @param string $url 132 | * 133 | * @return $this 134 | */ 135 | public function setUrl( 136 | $url 137 | ) { 138 | $this->setOption( CURLOPT_URL, $url ); 139 | $this->_url = $url; 140 | 141 | return $this; 142 | } 143 | 144 | public function doPostRequest() 145 | { 146 | if ( in_array( $this->requestMethod, $this->_allowedReqMethodForPost ) ) { 147 | $this->_requestWithPost = true; 148 | } 149 | 150 | return $this; 151 | } 152 | 153 | public function run( $data, $as = 'urlencoded', $closeCurl = false ) // urlencoded | json | form-data 154 | { 155 | if ( $this->_requestWithPost ) { 156 | //make a post request 157 | switch ( $as ) { 158 | case 'json': 159 | if ( is_array( $data ) ) { 160 | $data = json_encode( $data ); 161 | $this->setRequestHeader( 'Content-Type', 'application/json' ); 162 | } else { 163 | throw new \ErrorException( 'Data argument passed to the run method must be of datatype Array when posting as JSON' ); 164 | } 165 | break; 166 | case 'form-data': 167 | if ( is_array( $data ) || is_object( $data ) ) { 168 | $this->setRequestHeader( 'Content-Type', 'multipart/form-data' ); 169 | } else { 170 | throw new \ErrorException( 'Data argument passed to the run method must be of datatype Array or Object when postiing as FORM-DATA' ); 171 | } 172 | break; 173 | case 'urlenconded': 174 | // convert data to queryString - Native 175 | $data = http_build_query( $data ); 176 | // continue to default 177 | default: 178 | $this->setRequestHeader( 'Content-Type', 'application/x-www-form-urlencoded' ); 179 | break; 180 | } 181 | 182 | $this->setOption( CURLOPT_POSTFIELDS, $data ); //Post Fields 183 | } else { 184 | //make a built query string and reset CURLOPT_URL 185 | $this->setOption( CURLOPT_URL, $this->getUrl( $data ) ); 186 | } 187 | 188 | // execute curl 189 | $response = curl_exec( $this->_curl ); 190 | // save error details in memory 191 | $this->_errorCode = curl_errno( $this->_curl ); 192 | $this->_errorMessage = curl_error( $this->_curl ); 193 | 194 | if ( $closeCurl ) { 195 | // close curl connection by default 196 | if ( is_resource( $this->_curl ) ) { 197 | curl_close( $this->_curl ); 198 | } 199 | } 200 | 201 | // return response from endpoint 202 | return $response; 203 | } 204 | 205 | /** 206 | * @param $key 207 | * @param $value 208 | * 209 | * @return $this 210 | */ 211 | public function setRequestHeader( $key, $value = null ) 212 | { 213 | if ( ! is_array( $key ) ) { 214 | // assist with capitalizing http header keys 215 | $headers[] = ucwords( $key ) . ': ' . $value; 216 | } else { 217 | $headers = $key; 218 | } 219 | 220 | // merge requestHeader to base header 221 | $this->requestHeader = array_merge( $headers, $this->requestHeader ); 222 | 223 | $this->setOption( CURLOPT_HTTPHEADER, $this->requestHeader ); 224 | 225 | return $this; 226 | } 227 | 228 | 229 | public function getErrorCode() 230 | { 231 | return $this->_errorCode; 232 | } 233 | 234 | public function getErrorMessage() 235 | { 236 | return $this->_errorMessage; 237 | } 238 | 239 | /** 240 | * @return array 241 | */ 242 | public function getRequestHeader() 243 | { 244 | return $this->requestHeader; 245 | } 246 | 247 | } -------------------------------------------------------------------------------- /src/Transaction.php: -------------------------------------------------------------------------------- 1 | 9 | * @date 2017-06-25 10 | * @copyright (c) 2016 - 2017, TECRUM (http://www.tecrum.com) 11 | * 12 | */ 13 | 14 | namespace Matscode\Paystack; 15 | 16 | 17 | use Matscode\Paystack\Utility\Text; 18 | 19 | class Transaction extends Base 20 | { 21 | public 22 | $amount = 0, 23 | $email = null, 24 | $reference = null, 25 | $metadata = null, 26 | $transactionResponse = 27 | [ 28 | 'verify' => null, 29 | 'initialize' => null 30 | ]; 31 | 32 | private 33 | $_callbackUrl = null; 34 | 35 | 36 | public function __construct( $secretKey = null ) 37 | { 38 | if ( ! is_null( $secretKey ) ) { 39 | parent::__construct( $secretKey ); 40 | } 41 | // set the default resource for current class 42 | $this 43 | ->setResource( 'transaction' ); 44 | 45 | return $this; 46 | } 47 | 48 | /** 49 | * This method must be called to request for payment. which return an initial transaction obj 50 | * 51 | * @param array $data 52 | * @param bool $rawResponse 53 | * 54 | * @return mixed|\stdClass 55 | */ 56 | public function initialize( array $data = [], $rawResponse = false ) 57 | { 58 | // values set via mutator 59 | $data['callback_url'] = $this->_callbackUrl; 60 | 61 | // override refernce $data['reference'] value 62 | if ( $this->reference ) { 63 | $data['reference'] = $this->reference; 64 | } elseif ( ! isset( $data['reference'] ) ) { 65 | $this->reference = $data['reference'] = Text::uniqueRef(); 66 | } else { 67 | $this->reference = $data['reference']; 68 | } 69 | 70 | // override amount $data['amount'] value 71 | if ( $this->amount ) { 72 | $data['amount'] = $this->amount; 73 | } else { 74 | // save amount in memory 75 | $this->amount = $data['amount']; 76 | } 77 | 78 | // override email $data['email'] value 79 | if ( ! is_null( $this->email ) ) { 80 | $data['email'] = $this->email; 81 | } else { 82 | // save amount in memory 83 | $this->email = $data['email']; 84 | } 85 | 86 | 87 | // add metadata if provided 88 | if ( ! is_null( $this->metadata ) ) { 89 | $data['metadata'] = $this->metadata; 90 | } 91 | 92 | $this->transactionResponse['initialize'] = 93 | $this 94 | ->setAction( 'initialize' ) 95 | ->sendRequest( $data ); 96 | 97 | 98 | if ( $rawResponse ) { 99 | $response = 100 | $this->transactionResponse['initialize']; 101 | } else { 102 | // Initialize a new Obj to save Striped response 103 | $response = new \stdClass(); 104 | if ( isset( $this->transactionResponse['initialize']->data ) && 105 | is_object( $this->transactionResponse['initialize']->data ) 106 | ) { 107 | $response->authorizationUrl = $this->transactionResponse['initialize']->data->authorization_url; 108 | $response->reference = $this->transactionResponse['initialize']->data->reference; 109 | } else { 110 | // return the raw response 111 | $response = 112 | $this->transactionResponse['initialize']; 113 | } 114 | } 115 | 116 | return $response; 117 | } 118 | 119 | /** 120 | * Is used to Check if a transaction is successful and return the transaction object datd 121 | * 122 | * @param null $reference 123 | * 124 | * @todo Use session to keep reference temporary per transaction To enhance Transaction reference guessing. 125 | * 126 | * @return mixed 127 | * @throws \Exception 128 | */ 129 | public function verify( $reference = null ) 130 | { 131 | // try to guess reference if not set 132 | if ( is_null( $reference ) ) { 133 | // guess reference 134 | if ( isset( $_GET['reference'] ) ) { 135 | $reference = $_GET['reference']; 136 | } else { 137 | // return false 138 | return false; 139 | } 140 | } 141 | 142 | $this->transactionResponse['verify'] = 143 | $this 144 | ->setAction( 'verify', [ $reference ] ) 145 | ->sendRequest( [], 'GET' ); 146 | 147 | return $this->transactionResponse['verify']; 148 | } 149 | 150 | /** 151 | * Like verify(), but it only checks to see if a transactions is successful returning boolean 152 | * 153 | * @param null $reference 154 | * 155 | * @return bool 156 | */ 157 | public function isSuccessful( $reference = null ) 158 | { 159 | // get verify response 160 | $response = $this->verify( $reference ); 161 | 162 | // Initialize as !isSuccessful 163 | $isSuccessful = false; 164 | 165 | // check if transaction is successful 166 | if ( isset($response->data) && is_object( $response->data ) && 167 | $response->status == true && 168 | $response->data->status == 'success' 169 | ) { 170 | $isSuccessful = true; 171 | } 172 | 173 | return $isSuccessful; 174 | } 175 | 176 | /** 177 | * Compares the amount paid by customer to the amount passed into it 178 | * 179 | * @param $amountExpected 180 | * 181 | * @return bool 182 | */ 183 | public function amountEquals( $amountExpected ) 184 | { 185 | // $this->verify(); // call verify() or isSuccessful() before calling this method 186 | $transactionResponse = $this->transactionResponse['verify']; 187 | if ( is_object( $transactionResponse ) ) { 188 | return 189 | ( (int) $transactionResponse->data->amount === $amountExpected ); 190 | } 191 | 192 | return false; 193 | } 194 | 195 | /** 196 | * @param null $reference 197 | * 198 | * @return string|null 199 | */ 200 | public function getAuthorizationCode( $reference = null ) 201 | { 202 | $authorizationCode = null; 203 | // get verify response 204 | if ( $this->isSuccessful( $reference ) ) { 205 | $response = $this->verify( $reference ); 206 | $authorizationCode = $response->data->authorization->authorization_code; 207 | } 208 | 209 | return $authorizationCode; 210 | } 211 | 212 | /** 213 | * @param $email 214 | * 215 | * @return $this 216 | */ 217 | public function setEmail( $email ) 218 | { 219 | // setting the email 220 | $this->email = $email; 221 | 222 | return $this; 223 | } 224 | 225 | public function getEmail( $email ) 226 | { 227 | // setting the email 228 | $this->email = $email; 229 | } 230 | 231 | /** 232 | * @param int $amount 233 | * 234 | * @todo Allow to set kobo using '.' syntax 235 | * @return $this 236 | */ 237 | public function setAmount( $amount ) 238 | { 239 | // setting amount in naira //TODO: Allow to set kobo using '.' syntax 240 | $this->amount = ( $amount * 100 ); 241 | 242 | return $this; 243 | } 244 | 245 | /** 246 | * @return int 247 | */ 248 | public function getAmount() 249 | { 250 | return $this->amount; 251 | } 252 | 253 | /** 254 | * Sets the transaction reference code/id 255 | * 256 | * @param null $reference 257 | */ 258 | public function setReference( $reference ) 259 | { 260 | $this->reference = $reference; 261 | } 262 | 263 | /** 264 | * @param bool $afterInitialize 265 | * 266 | * @return null 267 | * 268 | */ 269 | public function getReference( $afterInitialize = false ) 270 | { 271 | if ( $afterInitialize ) { 272 | $reference = $this->response->data->reference; 273 | } else { 274 | $reference = $this->reference; 275 | } 276 | 277 | return $reference; 278 | } 279 | 280 | /** 281 | * To set callback URL, can be used to override callback URL set on paystack dashboard 282 | * 283 | * @param string $callbackUrl 284 | * 285 | * @return $this 286 | */ 287 | public function setCallbackUrl( $callbackUrl ) 288 | { 289 | $this->_callbackUrl = $callbackUrl; 290 | 291 | return $this; 292 | } 293 | 294 | 295 | /** 296 | * Sets the metadata 297 | * 298 | * @param array $metadata 299 | * 300 | * @return $this 301 | */ 302 | public function setMetadata( $metadata ) 303 | { 304 | $this->metadata = $metadata; 305 | 306 | return $this; 307 | } 308 | 309 | } 310 | -------------------------------------------------------------------------------- /src/Utility/Debug.php: -------------------------------------------------------------------------------- 1 | 9 | * @date 2017-06-27 10 | * @copyright (c) 2016 - 2017, TECRUM (http://www.tecrum.com) 11 | * 12 | */ 13 | 14 | namespace Matscode\Paystack\Utility; 15 | 16 | 17 | class Debug 18 | { 19 | private 20 | static 21 | $openTag = '
',
22 | 			$closeTag = '
'; 23 | 24 | public static function printStr( $value ) 25 | { 26 | echo self::$openTag . 27 | $value . 28 | self::$closeTag; 29 | } 30 | 31 | public static function print_r( $value ) 32 | { 33 | echo self::$openTag . 34 | print_r( $value, true ) . 35 | self::$closeTag; 36 | } 37 | 38 | public static function var_dump( $value ) 39 | { 40 | echo self::$openTag; 41 | var_dump( $value ); 42 | echo self::$closeTag; 43 | } 44 | } -------------------------------------------------------------------------------- /src/Utility/Http.php: -------------------------------------------------------------------------------- 1 | 9 | * @date 2017-06-27 10 | * @copyright (c) 2016 - 2017, TECRUM (http://www.tecrum.com) 11 | * 12 | */ 13 | 14 | namespace Matscode\Paystack\Utility; 15 | 16 | class Http 17 | { 18 | public static function redirect( $location, $replace = true, $httpResponseCode = null ) 19 | { 20 | // do a redirect 21 | header( 'Location: ' . $location, $replace, $httpResponseCode ); 22 | } 23 | 24 | } -------------------------------------------------------------------------------- /src/Utility/Text.php: -------------------------------------------------------------------------------- 1 | 9 | * @date 2017-06-26 10 | * @copyright (c) 2016 - 2017, TECRUM (http://www.tecrum.com) 11 | * 12 | */ 13 | 14 | namespace Matscode\Paystack\Utility; 15 | 16 | 17 | class Text 18 | { 19 | /** 20 | * 21 | * @author Hackan 22 | * @link https://php.net/manual/en/function.uniqid.php#120123 23 | * 24 | * @param int $length 25 | * 26 | * @param int $capsMix 27 | * 28 | * @return bool|string 29 | * @throws \Exception 30 | */ 31 | public static function uniqueRef( $length = 15, $capsMix = 5 ) 32 | { 33 | // uniqid gives 15 chars, but you could adjust it to your needs. 34 | if ( function_exists( "random_bytes" ) ) { 35 | $bytes = random_bytes( ceil( $length / 2 ) ); 36 | } elseif ( function_exists( "openssl_random_pseudo_bytes" ) ) { 37 | $bytes = openssl_random_pseudo_bytes( ceil( $length / 2 ) ); 38 | } else { 39 | throw new \Exception( "No cryptographically secure random function available" ); 40 | } 41 | 42 | if ( $capsMix > 10 ) { 43 | throw new \Exception( 'capsMix can not be greater than 10' ); 44 | } 45 | $caps = substr( str_shuffle( 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' ), 1, $capsMix ); 46 | 47 | return str_shuffle( substr( bin2hex( $bytes ), 0, $length ) . $caps ); 48 | } 49 | 50 | 51 | public static function removeSlashes( $string ) 52 | { 53 | return trim( $string, '/' ); 54 | } 55 | } -------------------------------------------------------------------------------- /test/callback.php: -------------------------------------------------------------------------------- 1 | 9 | * @date 2017-06-27 10 | * @copyright (c) 2016 - 2017, TECRUM (http://www.tecrum.com) 11 | * 12 | */ 13 | require_once "../vendor/autoload.php"; 14 | 15 | use Matscode\Paystack\Transaction; 16 | use Matscode\Paystack\Utility\Debug; 17 | 18 | $secretKey = 'sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'; 19 | 20 | // creating the transaction object 21 | $Transaction = new Transaction( $secretKey ); 22 | 23 | // transaction can be verified by doing manual check on the response Obj 24 | /* 25 | $response = $Transaction->verify(); 26 | 27 | Debug::print_r( $response);*/ 28 | 29 | // OR 30 | $result = $Transaction->isSuccessful(); 31 | 32 | /* 33 | Debug::print_r( $result); 34 | */ 35 | 36 | // To check if verified amount is the expected amount before giving value to customer 37 | 38 | $result = $Transaction->amountEquals(5000); // amount in kobo 39 | 40 | Debug::printStr( $result ); 41 | 42 | 43 | // Getting AuthorizationCode 44 | /* 45 | $authorizationCode = $Transaction->getAuthorizationCode(); 46 | 47 | Debug::print_r( $authorizationCode); 48 | */ 49 | -------------------------------------------------------------------------------- /test/index.php: -------------------------------------------------------------------------------- 1 | 9 | * @date 2017-06-26 10 | * @copyright (c) 2016 - 2017, TECRUM (http://www.tecrum.com) 11 | * 12 | */ 13 | require_once "../vendor/autoload.php"; 14 | 15 | use Matscode\Paystack\Transaction; 16 | use Matscode\Paystack\Utility\Debug; 17 | use Matscode\Paystack\Utility\Http; 18 | 19 | $secretKey = 'sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'; 20 | 21 | // creating the transaction object 22 | $Transaction = new Transaction( $secretKey ); 23 | 24 | // Set data to post using this method 25 | /* 26 | $response = $Transaction->initialize( [ 27 | 'email' => 'customer@gmail.com', 28 | 'amount' => 500000 29 | ] ); 30 | */ 31 | 32 | // OR 33 | 34 | $response = 35 | $Transaction 36 | ->setEmail( 'customer@gmail.com' ) 37 | ->setAmount( 50 ) 38 | ->initialize(); 39 | 40 | // print response 41 | Debug::print_r( $response ); 42 | 43 | // save reference somewhere and do a redirect 44 | Http::redirect($response->authorizationUrl); 45 | 46 | --------------------------------------------------------------------------------