Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix mobile and fax sub-model // rebrand #3

Merged
merged 1 commit into from
Oct 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2017 RatePAY GmbH
Copyright (c) 2023 Ratepay GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# RatePAY GmbH - PHP SDK
# Ratepay GmbH - PHP SDK
============================================

|Module | RatePAY PHP SDK
|Module | Ratepay PHP SDK
|------|----------
|Author | Aarne Welschlau
|Version | `0.9.3.2`
|Link | http://www.ratepay.com
|Version | `0.9.4.0`
|Link | http://docs.ratepay.com
|Mail | integration@ratepay.com

### Installation
Expand All @@ -16,26 +16,26 @@ composer install
### How to start

Find the basic usage of the different API calls and operations of the API library explained in the example files. The *example.php* explains the basic usage of the library.
###### To run the examples, insert your (received by RatePAY Customer Integration Team) credentials into 'ratepay_credentials.php'.
###### To run the examples, insert your (received by Ratepay Merchant Onboarding Team) credentials into 'ratepay_credentials.php'.
Following table describes the basic (transaction-driven) operations in chronological order.

|#|File|Operation/+*Subtype*|Information|Description|
|-|-|-|-|-|
|1|example.php|Payment Init|Head|Shows the basic functionality of the RatePAY library|
|1|example.php|Payment Init|Head|Shows the basic functionality of the Ratepay library|
|2|example.paymentRequest.*.php|Payment Request|Head, customer, shopping basket, payment|Call for authorization. Different examples for all payment methods|
|3|example.paymentChange.cancellation.php|Payment Change - *Cancellation*|Head, shopping basket|Informs RatePAY of a cancelled basket or article|
|4|example.confirmationDeliver.php|Confirmation Deliver|Head, shopping basket|Informs RatePAY of a shipped basket or article|
|5|example.paymentChange.return.php|Payment Change - *Return*|Head, shopping basket|Informs RatePAY of a returned basket or article|
|6|example.paymentChange.changeOrder.php|Payment Change - *Change Order*|Head, shopping basket|Informs RatePAY of a totally changed shopping basket|
|7|example.paymentChange.credit.php|Payment Change - *Credit*|Head, shopping basket|Informs RatePAY of a subsequent refund or fee|
|3|example.paymentChange.cancellation.php|Payment Change - *Cancellation*|Head, shopping basket|Informs Ratepay of a cancelled basket or article|
|4|example.confirmationDeliver.php|Confirmation Deliver|Head, shopping basket|Informs Ratepay of a shipped basket or article|
|5|example.paymentChange.return.php|Payment Change - *Return*|Head, shopping basket|Informs Ratepay of a returned basket or article|
|6|example.paymentChange.changeOrder.php|Payment Change - *Change Order*|Head, shopping basket|Informs Ratepay of a totally changed shopping basket|
|7|example.paymentChange.credit.php|Payment Change - *Credit*|Head, shopping basket|Informs Ratepay of a subsequent refund or fee|

Following table describes optional and transaction-independent operations.

|File|Operation/+*Subtype*|Description|
|-|-|-|
|example.PaymentInit.php|Payment Init|**Optional** call before *Payment Request*. Opens new transaction. Returns RatePAY transaction id. If *Payment Request* is called without transaction id *Payment Init* is called automatically by library|
|example.PaymentQuery.php|Payment Query|Identical to *Payment Request*. Returns all admitted RatePAY payment methods for this transaction|
|example.PaymentInit.php|Payment Init|**Optional** call before *Payment Request*. Opens new transaction. Returns Ratepay transaction id. If *Payment Request* is called without transaction id *Payment Init* is called automatically by library|
|example.PaymentQuery.php|Payment Query|Identical to *Payment Request*. Returns all admitted Ratepay payment methods for this transaction|
|example.PaymentConfirm.php|Payment Confirm|**Optional** call which is called between *Payment Request* and *Confirmation Deliver* to confirm authorization and transmit additional order information|
|example.configurationRequest.php|Configuration Request|Returns the merchant installment configuration from RatePAY|
|example.configurationRequest.php|Configuration Request|Returns the merchant installment configuration from Ratepay|
|example.calculationRequest.php|Calculation Request - *calculation-by-time*/*calculation-by-rate*|Calculates an installment plan. Subtype has to be *calculation-by-rate* which calculates by a rate defined by the customer or *calculation-by-time* which calculates by a duration chosen by the customer|
|example.profileRequest.php|Profile Request|Returns the merchant configuration from RatePAY, includes the installment configuration|
|example.profileRequest.php|Profile Request|Returns the merchant configuration from Ratepay, includes the installment configuration|
8 changes: 4 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{
"name": "ratepay/php-sdk",
"description": "RatePAY PHP SDK",
"version": "0.9.3.1",
"description": "Ratepay PHP SDK",
"version": "0.9.4.0",
"license": "MIT",
"type": "library",
"homepage": "https://dev.ratepay.com",
"homepage": "https://docs.ratepay.com",
"support": {
"email": "integration@ratepay.com",
"source": "https://github.com/ratepay/php-sdk"
},
"authors": [
{
"name": "Aarne Welschlau",
"email": "aarne.welschlau@ratepay.com"
"email": "integration@ratepay.com"
}
],
"require": {
Expand Down
10 changes: 8 additions & 2 deletions example.paymentRequest.directDebit.php
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,18 @@
],
'Contacts' => [
'Email' => "alice@umbrella.tld",
//'Mobile' => "0123 4567890",
//'Mobile' => [
//'AreaCode' => "0172",
//'DirectDial' => "0172 3456789"
//],
'Phone' => [
//'AreaCode' => "012",
'DirectDial' => "012 3456789"
],
//'Fax' => "012 3456777",
//'Fax' => [
//'AreaCode' => "012",
//'DirectDial' => "012 3456789"
//],
],
'BankAccount' => [ // In case of payment method 'elv'
'Owner' => "Alice Nobodyknows",
Expand Down
10 changes: 8 additions & 2 deletions example.paymentRequest.installment.bankTransfer.php
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,18 @@
],
'Contacts' => [
'Email' => "alice@umbrella.tld",
//'Mobile' => "0123 4567890",
//'Mobile' => [
//'AreaCode' => "0172",
//'DirectDial' => "0172 3456789"
//],
'Phone' => [
//'AreaCode' => "012",
'DirectDial' => "012 3456789"
],
//'Fax' => "012 3456777",
//'Fax' => [
//'AreaCode' => "012",
//'DirectDial' => "012 3456789"
//],
],
// 'CompanyName' => "Umbrella Corp.",
// 'CompanyType' => "AG",
Expand Down
10 changes: 8 additions & 2 deletions example.paymentRequest.installment.directDebit.php
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,18 @@
],
'Contacts' => [
'Email' => "alice@umbrella.tld",
//'Mobile' => "0123 4567890",
//'Mobile' => [
//'AreaCode' => "0172",
//'DirectDial' => "0172 3456789"
//],
'Phone' => [
//'AreaCode' => "012",
'DirectDial' => "012 3456789"
],
//'Fax' => "012 3456777",
//'Fax' => [
//'AreaCode' => "012",
//'DirectDial' => "012 3456789"
//],
],
'BankAccount' => [ // In case of payment method 'elv'
'Owner' => "Alice Nobodyknows",
Expand Down
10 changes: 8 additions & 2 deletions example.paymentRequest.invoice.php
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,18 @@
],
'Contacts' => [
'Email' => "alice@umbrella.tld",
//'Mobile' => "0123 4567890",
//'Mobile' => [
//'AreaCode' => "0172",
//'DirectDial' => "0172 3456789"
//],
'Phone' => [
//'AreaCode' => "012",
'DirectDial' => "012 3456789"
],
//'Fax' => "012 3456777",
//'Fax' => [
//'AreaCode' => "012",
//'DirectDial' => "012 3456789"
//],
],
// 'CompanyName' => "Umbrella Corp.",
// 'CompanyType' => "AG",
Expand Down