Difference between revisions of "Payment Methods"
(→PayPal Tab: Added eWay options.) |
m (corrections made) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | = List Payment Methods = | + | ===In This Section=== |
| + | This section will list the different payment methods and how to set them up. | ||
| + | |||
| + | === '''List Payment Methods''' === | ||
The default view on this section is the payment method list, it displays all of the relevant details of all payment methods setup on the system. | The default view on this section is the payment method list, it displays all of the relevant details of all payment methods setup on the system. | ||
| − | = Create New Methods (and Edit an Existing one) = | + | = '''Create New Methods (and Edit an Existing one)''' = |
| − | == Details Tab == | + | == '''Details Tab''' == |
'''Method Type'''<br /> | '''Method Type'''<br /> | ||
Select the appropriate type for the payment method being created.<br /> | Select the appropriate type for the payment method being created.<br /> | ||
| + | |||
'''Method Name'''<br /> | '''Method Name'''<br /> | ||
Enter the "Name" to use for the payment method, this is used internally.<br /> | Enter the "Name" to use for the payment method, this is used internally.<br /> | ||
| + | |||
'''Put Orders on Hold Over this Value'''<br /> | '''Put Orders on Hold Over this Value'''<br /> | ||
If you wish to put orders on hold automatically over a certain value, enter it here.<br /> | If you wish to put orders on hold automatically over a certain value, enter it here.<br /> | ||
| + | |||
'''Default Status for New Orders'''<br /> | '''Default Status for New Orders'''<br /> | ||
| − | Default is "Released", but for things like "Cheque" or "Cash" you may wish to put them "On Hold" first.<br /> | + | Default is "Released", but for things like "Cheque" or "Cash," you may wish to put them "On Hold" first.<br /> |
| + | |||
'''Active'''<br /> | '''Active'''<br /> | ||
Make this option "Green" to activate the payment method.<br /> | Make this option "Green" to activate the payment method.<br /> | ||
| + | |||
'''Default Method'''<br /> | '''Default Method'''<br /> | ||
Make this option "Green" if this is going to be the default payment method.<br /> | Make this option "Green" if this is going to be the default payment method.<br /> | ||
| + | |||
'''SagePay MOTO Payment Method'''<br /> | '''SagePay MOTO Payment Method'''<br /> | ||
If this is going to be used as the SagePay MOTO method, make this "Green".<br /> | If this is going to be used as the SagePay MOTO method, make this "Green".<br /> | ||
| + | |||
'''Available during Point of Sale'''<br /> | '''Available during Point of Sale'''<br /> | ||
If you would like this method available during the Point of Sale screen, make this "Green".<br /> | If you would like this method available during the Point of Sale screen, make this "Green".<br /> | ||
| + | |||
'''Associated Bank Account'''<br /> | '''Associated Bank Account'''<br /> | ||
To auto-create bank transactions, select the bank to associate this payment with.<br /> | To auto-create bank transactions, select the bank to associate this payment with.<br /> | ||
| + | |||
'''Associated with Site'''<br /> | '''Associated with Site'''<br /> | ||
| − | Select the "Site" to associate this payment with, or leave as "--- Select Site ---" if it's only going to be used in the back office.<br /> | + | Select the "Site" to associate this payment with, or leave it as "--- Select Site ---" if it's only going to be used in the back office.<br /> |
| + | |||
'''Site Description'''<br /> | '''Site Description'''<br /> | ||
Enter the description to be displayed to customers on the website. If you are setting up a method for Amazon, enter "Other" here.<br /> | Enter the description to be displayed to customers on the website. If you are setting up a method for Amazon, enter "Other" here.<br /> | ||
| − | == PayPal Tab == | + | === '''PayPal / eWay Tab''' === |
| − | Please Note: Some SagePay and eWay options are set here as well!<br /> | + | <u>Please Note</u>: Some SagePay and eWay options are set here as well!<br /><br /> |
| + | |||
'''Email Address'''<br /> | '''Email Address'''<br /> | ||
Enter your PayPal email address here.<br /> | Enter your PayPal email address here.<br /> | ||
| + | |||
'''API Type'''<br /> | '''API Type'''<br /> | ||
Unless advised by support, select "Signature".<br /> | Unless advised by support, select "Signature".<br /> | ||
| − | '''API Username'''<br /> | + | |
| + | '''API Username / Key'''<br /> | ||
Your API Username as specified by PayPal/SagePay, this is not your email address. If setting up eWay, this is the "API Key"<br /> | Your API Username as specified by PayPal/SagePay, this is not your email address. If setting up eWay, this is the "API Key"<br /> | ||
| + | |||
'''API Password'''<br /> | '''API Password'''<br /> | ||
Your API Password as specified by PayPal/SagePay/eWay, this is not your account password.<br /> | Your API Password as specified by PayPal/SagePay/eWay, this is not your account password.<br /> | ||
| + | |||
'''Sandbox Mode Active'''<br /> | '''Sandbox Mode Active'''<br /> | ||
During testing, set this to "Green", but remember to set it to "Red" when going live! This is also used for eWay.<br /> | During testing, set this to "Green", but remember to set it to "Red" when going live! This is also used for eWay.<br /> | ||
| + | |||
'''API Action'''<br /> | '''API Action'''<br /> | ||
Unless advised by support, select "Sale" for PayPal and "Authorisation" for SagePay.<br /> | Unless advised by support, select "Sale" for PayPal and "Authorisation" for SagePay.<br /> | ||
| + | |||
'''Transfer Cart Lines to PayPal'''<br /> | '''Transfer Cart Lines to PayPal'''<br /> | ||
| − | Make this "Green" | + | Make this "Green" transfer cart lines to PayPal, this is the default action.<br /> |
| + | |||
'''Allow Guest Checkout'''<br /> | '''Allow Guest Checkout'''<br /> | ||
| − | Make this "Green" | + | Make this "Green" allow guest checkout on PayPal, this is the default action.<br /> |
| + | |||
'''Internal Test Mode'''<br /> | '''Internal Test Mode'''<br /> | ||
Only make this "Green" if advised by support.<br /> | Only make this "Green" if advised by support.<br /> | ||
=== Getting Details from PayPal === | === Getting Details from PayPal === | ||
| − | 1. Log in to the Developer Dashboard with your PayPal account. (You may need to agree to some stuff here) - URL is https://www.paypal.com/signin?returnUri=https%3A%2F%2Fdeveloper.paypal.com%2Fdeveloper%2Fapplications<br /> | + | '''1'''. Log in to the Developer Dashboard with your PayPal account. (You may need to agree to some stuff here) - URL is https://www.paypal.com/signin?returnUri=https%3A%2F%2Fdeveloper.paypal.com%2Fdeveloper%2Fapplications<br /> |
| − | 2. Under the DASHBOARD menu, select My Apps & Credentials.<br /> | + | '''2'''. Under the DASHBOARD menu, select My Apps & Credentials.<br /> |
| − | 3. Make sure you're on the Sandbox tab to get the API credentials you'll use while you're developing code. After you test and before you go live, switch to the Live tab to get live credentials.<br /> | + | '''3'''. Make sure you're on the Sandbox tab to get the API credentials you'll use while you're developing code. After you test and before you go live, switch to the Live tab to get live credentials.<br /> |
| − | 4. Under the App Name column, select Default Application, which PayPal creates with a new Developer Dashboard account. Select Create App if you don't see the default app.<br /> | + | '''4'''. Under the App Name column, select Default Application, which PayPal creates with a new Developer Dashboard account. Select Create App if you don't see the default app.<br /> |
| − | 5. Click on the "Live" tab and "Create App", call it whatever you like, ideally something related to your website name.<br /> | + | '''5'''. Click on the "Live" tab and "Create App", call it whatever you like, ideally something related to your website name.<br /> |
| − | 6. Back to the list and click the app you've just created, you will see "PayPal Account", "Client ID" and "Secret" here, these are the details required for the above settings.<br /> | + | '''6'''. Back to the list and click the app you've just created, you will see "PayPal Account", "Client ID" and "Secret" here, these are the details required for the above settings.<br /> |
Please contact support if you need assistance. | Please contact support if you need assistance. | ||
| − | == SagePay Tab == | + | === '''Getting Details from eWay''' === |
| + | Please contact your eWay account manager to obtain the relevant API Details required for the settings in this section. | ||
| + | |||
| + | == '''SagePay Tab''' == | ||
| + | |||
'''Vendor ID'''<br /> | '''Vendor ID'''<br /> | ||
Enter your Vendor ID provided by SagePay here.<br /> | Enter your Vendor ID provided by SagePay here.<br /> | ||
| + | |||
'''API Type'''<br /> | '''API Type'''<br /> | ||
Unless advised by Support, specify "Form" here.<br /> | Unless advised by Support, specify "Form" here.<br /> | ||
| + | |||
'''API Action'''<br /> | '''API Action'''<br /> | ||
Unless advised by Support, specify "Authorise and Capture" here.<br /> | Unless advised by Support, specify "Authorise and Capture" here.<br /> | ||
| + | |||
'''API Mode'''<br /> | '''API Mode'''<br /> | ||
You can specify "Test" here whilst testing the payments, but make sure you change it to "Live" before your website goes public.<br /> | You can specify "Test" here whilst testing the payments, but make sure you change it to "Live" before your website goes public.<br /> | ||
| + | |||
'''Description passed to API'''<br /> | '''Description passed to API'''<br /> | ||
As advised by SagePay.<br /> | As advised by SagePay.<br /> | ||
| + | |||
'''AVS/CV2 Option'''<br /> | '''AVS/CV2 Option'''<br /> | ||
Select the appropriate option here as advised by SagePay.<br /> | Select the appropriate option here as advised by SagePay.<br /> | ||
| + | |||
'''3D Secure Option'''<br /> | '''3D Secure Option'''<br /> | ||
| − | + | select the appropriate option here as advised by SagePay.<br /> | |
| + | |||
'''Timeout Message'''<br /> | '''Timeout Message'''<br /> | ||
Unless advised by SagePay, default is 30.<br /> | Unless advised by SagePay, default is 30.<br /> | ||
| + | |||
'''Verify Peer'''<br /> | '''Verify Peer'''<br /> | ||
Unless advised by SagePay, set this to "Red".<br /> | Unless advised by SagePay, set this to "Red".<br /> | ||
| + | |||
'''Internal Test Mode'''<br /> | '''Internal Test Mode'''<br /> | ||
Only make this "Green" if advised by support.<br /> | Only make this "Green" if advised by support.<br /> | ||
| − | == Xero Tab == | + | |
| + | == '''Xero Tab''' == | ||
| + | |||
'''Map to Bank Account'''<br /> | '''Map to Bank Account'''<br /> | ||
If your system is linked to Xero, select the bank account to map it against here.<br /> | If your system is linked to Xero, select the bank account to map it against here.<br /> | ||
| − | = Delete Payment Method = | + | = '''Delete Payment Method''' = |
This option is available from the "List Payment Methods" and will permanently delete the payment method. | This option is available from the "List Payment Methods" and will permanently delete the payment method. | ||
| − | Please Note: Payment Methods cannot be deleted if | + | Please Note: Payment Methods cannot be deleted if the orders or payments are assigned to them. These must be changed before deleting the payment method. |
Latest revision as of 10:22, 4 November 2021
Contents
In This Section
This section will list the different payment methods and how to set them up.
List Payment Methods
The default view on this section is the payment method list, it displays all of the relevant details of all payment methods setup on the system.
Create New Methods (and Edit an Existing one)
Details Tab
Method Type
Select the appropriate type for the payment method being created.
Method Name
Enter the "Name" to use for the payment method, this is used internally.
Put Orders on Hold Over this Value
If you wish to put orders on hold automatically over a certain value, enter it here.
Default Status for New Orders
Default is "Released", but for things like "Cheque" or "Cash," you may wish to put them "On Hold" first.
Active
Make this option "Green" to activate the payment method.
Default Method
Make this option "Green" if this is going to be the default payment method.
SagePay MOTO Payment Method
If this is going to be used as the SagePay MOTO method, make this "Green".
Available during Point of Sale
If you would like this method available during the Point of Sale screen, make this "Green".
Associated Bank Account
To auto-create bank transactions, select the bank to associate this payment with.
Associated with Site
Select the "Site" to associate this payment with, or leave it as "--- Select Site ---" if it's only going to be used in the back office.
Site Description
Enter the description to be displayed to customers on the website. If you are setting up a method for Amazon, enter "Other" here.
PayPal / eWay Tab
Please Note: Some SagePay and eWay options are set here as well!
Email Address
Enter your PayPal email address here.
API Type
Unless advised by support, select "Signature".
API Username / Key
Your API Username as specified by PayPal/SagePay, this is not your email address. If setting up eWay, this is the "API Key"
API Password
Your API Password as specified by PayPal/SagePay/eWay, this is not your account password.
Sandbox Mode Active
During testing, set this to "Green", but remember to set it to "Red" when going live! This is also used for eWay.
API Action
Unless advised by support, select "Sale" for PayPal and "Authorisation" for SagePay.
Transfer Cart Lines to PayPal
Make this "Green" transfer cart lines to PayPal, this is the default action.
Allow Guest Checkout
Make this "Green" allow guest checkout on PayPal, this is the default action.
Internal Test Mode
Only make this "Green" if advised by support.
Getting Details from PayPal
1. Log in to the Developer Dashboard with your PayPal account. (You may need to agree to some stuff here) - URL is https://www.paypal.com/signin?returnUri=https%3A%2F%2Fdeveloper.paypal.com%2Fdeveloper%2Fapplications
2. Under the DASHBOARD menu, select My Apps & Credentials.
3. Make sure you're on the Sandbox tab to get the API credentials you'll use while you're developing code. After you test and before you go live, switch to the Live tab to get live credentials.
4. Under the App Name column, select Default Application, which PayPal creates with a new Developer Dashboard account. Select Create App if you don't see the default app.
5. Click on the "Live" tab and "Create App", call it whatever you like, ideally something related to your website name.
6. Back to the list and click the app you've just created, you will see "PayPal Account", "Client ID" and "Secret" here, these are the details required for the above settings.
Please contact support if you need assistance.
Getting Details from eWay
Please contact your eWay account manager to obtain the relevant API Details required for the settings in this section.
SagePay Tab
Vendor ID
Enter your Vendor ID provided by SagePay here.
API Type
Unless advised by Support, specify "Form" here.
API Action
Unless advised by Support, specify "Authorise and Capture" here.
API Mode
You can specify "Test" here whilst testing the payments, but make sure you change it to "Live" before your website goes public.
Description passed to API
As advised by SagePay.
AVS/CV2 Option
Select the appropriate option here as advised by SagePay.
3D Secure Option
select the appropriate option here as advised by SagePay.
Timeout Message
Unless advised by SagePay, default is 30.
Verify Peer
Unless advised by SagePay, set this to "Red".
Internal Test Mode
Only make this "Green" if advised by support.
Xero Tab
Map to Bank Account
If your system is linked to Xero, select the bank account to map it against here.
Delete Payment Method
This option is available from the "List Payment Methods" and will permanently delete the payment method.
Please Note: Payment Methods cannot be deleted if the orders or payments are assigned to them. These must be changed before deleting the payment method.
