1.1 General information about PayPal
1.2.1 PayPal process flow from merchant’s perspective
1.2.2 PayPal Shortcut process flow from merchant’s perspective
2.1 Create and configure the PayPal business account
2.2 Settings for Payment Receiving Preferences
2.3 Setting up PayPal-API permissions for Sandbox
2.4 Einstellungen für den Zahlungsempfang vornehmen
3 1cs Online Payment System interface
3.3 Calling the interface for method “shortcut”
3.4 Calling the interface for a separate authorization
3.5 Calling the interface for a capture
3.6 Calling the interface for a credit with reference
3.7 Calling the interface for credits without reference
3.8 Calling the interface for reversals
3.9 Calling the interface for subscriptions
3.9.4 Capture on demand (capture=manual + txtype=Order or Auth)
3.9.5 Deleting BillingAgreementID
PayPal is one of the world’s leading eWallets for e- and m-Commerce. Around 179 million active members in over 200 countries pay for their online orders with PayPal. Customers in Germany can pay via direct debit, giropay or credit card (American Express, Diners Club, Discover, MasterCard, Visa). Along with the above payment methods, PayPal PLUS offers purchase on account and purchase by instalment. Members log into their PayPal account with their email address and a password during checkout and choose the preferred payment method (direct debit, PayPal credit, credit card and, if applicable purchase on account or by instalment). The amount payable is then immediately credited to their own PayPal account. The usual direct debit periods for transfers or the delay resulting from distribution to collecting services do not apply. This allows real-time payments processing on the Internet.
The 1cs Online Payment System offers the PayPal Express Checkout to shorten the order process: Your customer does not need to enter any address data but rather click on Checkout with PayPal in the shopping cart area, log on and select the invoice- and delivery address retained by PayPal. The 1cs Online Payment System then sends the delivery address as a result parameter back to your shop.
PayPal offers buyers and merchants extensive buyer / vendor protection. Buyers are able to claim money back from PayPal in the event of non-fulfilment of a contract of sale. With address verification and PayPal seller protection PayPal removes the merchant of the risk of payment failures in the case of direct debit payments, German credit card payments and unjustified customer complaints. Vendor protection is always linked to PayPal rules and conditions. PayPal risk management with buyer protection and address verification is provided to you via the 1cs Online Payment System.
PayPal is particularly beneficial for overseas customer acquisition. The 1cs Online Payment System supports all currencies and markets offered by PayPal. In many countries PayPal offers customers typical payment methods for their country. Customers abroad can often use typical payment methods such as prepaid cards in Italy or debit cards in the UK. Integrating PayPal into your shop provides your customers with several payment methods at once.
Logo
| Info | Type |
| First Cash Solution also processes PayPal payments, which offers you worldwide merchant protection and a potential of 179 million international customers in more than 200 countries. PayPal is one of the most popular online payment methods and it can be used in e- and m-Commerce. | Payments by eWallet |
Further information can be found on the webpage of PayPal (http://www.paypal.com).
Process flow PayPal Shortcut
Please note that, unlike our currency table, the currencies HUF (Hungarian – Forints) and TWD (Republic of China – Taiwan-Dollars) must be given without decimal places.
Example: To transfer 100.00 HUF one enters the amount=100
This exception applies only for the PayPal payment method.
If you want to use the MassPay functionality, please contact the 1cs Helpdesk to activate this function for you.
To process PayPal transactions via the 1cs Online Payment System as merchant you need to have a PayPal business account. You also need to enable the PayPal interface for use via the 1cs Online Payment System and to make the necessary settings for receiving payments.
1. Please call the PayPal URL of your country, e.g. http://www.paypal.co.uk.
2. Use the Button „Sign Up“ to open a new business account
3. The following page shows possible account types which can be created.
4. Please choose “Business Account” and press “Continue”.
5. Now you are forwarded to the page “Create Business Account”. Please enter your email address, which will be used for your PayPal Account and press “Continue”.
6. Please enter here your Business information. Accept the User Agreement and press the button “Agree and Continue”.
7. Please complete the required information about your company on the next pages.
8. In the next step you will get an email to confirm your email address. Please confirm your email address.
9. Please add the further required information about your company.
In order to process PayPal transactions through the 1cs Online Payment System you will need to setup an API permission Therefore please complete the six steps explained below.
1. Please go to the menu -> Profile -> Profile and Settings
2. Please go to „Activity“ and then select “API access”
3. Inside the API Access area, please choose “Grant API permission”
4. Please enter the following API Third Party Username and press the button “Lookup” frank.arnoldt_api1.computop.de
5. Please check the following API Access Level boxes, all other boxes remain unchecked. Press “Add” to confirm and finish API permission settings.
– Use Express Checkout to process payments
– Issue a refund for a specific transaction
– Authorise and capture your PayPal transactions
– Obtain information about a single transaction
– Search your transactions for items that match specific criteria and display the results
6. You will get the confirmation, that the third party supplier „frank.arnoldt_api1.computop.de“ was added.
For the PayPal Sandbox you can set up API permissions with the following steps.
1. At https://developer.paypal.com below “Accounts” –> (Accountname) –> “Manage accounts” –> “View/ edit account” you will find the credentials of the respective merchant account.
2. With this credentials please login at https://sandbox.paypal.com.
3. Click on the name on the upper right and go to “Account settings”.
4. Click on “API access” –> “Set up API permission” –> Enter “test_paypal_api_api1.computop.com”.
5. Please check the boxes for following permissions:
– Use PayPal Express to process payments
– Issue a refund for a specific transaction
– Authorise and capture your PayPal transactions
– Obtain information about a single transaction
– Search your transactions for items the match specific criteria and display the results
1. Please go to “Profile” and click on “Profile and Settings”.
2. Below “My selling preferences” please select “Block payments” with the link “Update”.
3. Please use the following settings.
– Block payments sent in a currency not provided
– Block accidental payments with duplicate invoice IDs
– Set up automatic payments for eBay-refunds.
– Display “Add Instructions to Seller” text input field
Please confirm your selected options by clicking on the “Save” button.
| Format | Description |
| a | alphabetical |
| as | alphabetical with special characters |
| n | numeric |
| an | alphanumeric |
| ans | alphanumeric with special characters |
| ns | numeric with special characters |
| bool | boolean expression (true or false) |
| 3 | fixed length with 3 digits/characters |
| ..3 | variable length with maximum 3 digits/characters |
| enum | enumeration of allowed values |
| dttm | ISODateTime (YYYY-MM-DDThh:mm:ss) |
| Abbreviation | Description | Comment |
| CND | condition | |
| M | mandatory | If a parameter is mandatory, then it must be present |
| O | optional | If a parameter is optional, then it can be present, but it is not required |
| C | conditional | If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional |
Notice: Please note that the names of parameters can be returned in upper or lower case.
Use the following URL and parameters to initiate a PayPal payment in the 1cs Online Payment System form:
With this URL the 1cs Online Payment System supports two different PayPal methods: One the one hand you can offer PayPal quite normally as an additional payment method for the conclusion of a sale. Otherwise you can use PayPal Express Checkout Shortcut, which connects the customers from the shopping cart directly to PayPal, where they can then select their delivery and invoicing address. The customer saves having to re-enter address details and you, as the merchant, enjoy PayPal vendor protection.
The 1cs Online Payment System also supports the separation of authorisation and capture for PayPal Express Checkout. You can set parameters via the 1cs Online Payment System to control whether the amount on the customer’s PayPal account should be blocked or captured immediately.
Notice: Please note that a PayPal connection in the shop via i-Frame is not possible due to PayPal-Regulations. Express Checkout always connects the Customer directly to PayPal.
Notice: One of the following conditions must be fulfilled to enable you to benefit from PayPal seller protection. Either the customer uses PayPal Express Checkout and selects a delivery address which it has saved previously with PayPal, which the 1cs Online Payment System transmits to your shop. Or your shop transmits the already known delivery address to PayPal. Seller protection applies only if the goods have been supplied to this specified address. There may be no more than 3 days between the authorisation of the amount in the customer’s PayPal account and capture if you wish to benefit from seller protection. the 1cs Online Payment System therefore supports several alternatives for the processing of PayPal payments: we shall be happy to advise you about the implementation of PayPal.
Notice: For security reasons, the 1cs Online Payment System rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | Format | CND | Description |
| MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain language too. |
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the 1cs support, if you want to capture amounts <100 (smallest currency unit). |
| Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
| MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
| TransID | ans..64 | M | TransactionID which should be unique for each payment |
| RefNr | ans..30 | O | Merchant´s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
| Capture | a..6 | O | Auto or Manual: determines whether the requested amount is settled immediately or at a later stage. Important Note: Please contact First Cash Solution Support for Manual, to discuss different possibilities of usage. |
| TxType | ans..5 | C | Obligatory for Capture=Manual: Transaction type with possible values Order or Auth and BAID (BillingAgreementID) |
| PayPalMethod | enum | O | The “shortcut” value selects the changed transaction procedure which takes the customer back to the shop for payment confirmation and e.g. in the case of purchase by instalment, displays the instalment purchase data which the customer then has to confirm. You then need to call up the interface paypalcomplete.aspx to complete the sale. |
| RTF | ans1 | O | For repeat payments (subscriptions): I = Initial payment of a new subscription R = Routine payment (Recurring) In this case only RTF=I is allowed, other subscription payments are carried out via the separate paypalAbo.aspx interface. |
| OrderDesc | ans..127 | M | Description of purchased goods, unit prices etc. – If OrderDesc(n) is used, there must be valid: Amount=ItemTotal+TaxTotal+SHAmount |
| OrderDesc(n) | ans..2048 | O | Customers shopping basket in the form: OrderDesc(n)=Name,Amount,Number,Quantity,Description,Tax OrderDesc2 to max. OrderDesc99 permissible For correct execution of displaying function all OrderDesc(n) Amounts must equal to the 1cs Online Payment System parameter Amount. |
| TaxTotal | n..10 | C | Mandatory, if +Tax is given in description of OrderDesc(n): Total amount of taxes of all single articles in the smallest currency unit (e.g. EUR Cent) = Sum(Tax*Number) |
| ItemTotal | n..10 | C | Mandatory, if +tax is given in description of OrderDesc(n): Gross amount of all single articles in the smallest currency unit (e.g. EUR Cent) = Sum(Amount*Number) |
| ShAmount | n..10 | O | Shipping costs in the smallest currency unit (e.g. EUR Cent). Can be uses only in connection with parameters ItemTotal and TaxTotal. |
| URLSuccess | ans..256 | M | Complete URL which calls up the 1cs Online Payment System if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between the 1cs Online Payment System and shop, please use the parameter UserData. Common notes: We recommend to use parameter “response=encrypt” to get an encrypted response by the 1cs OPS. However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the “code”-value which indicates success/failure of the action. Only a result of “code=00000000” should be considered successful. |
| URLFailure | ans..256 | M | Complete URL which calls up the 1cs Online Payment System if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between the 1cs Online Payment System and shop, please use the parameter UserData. Common notes: We recommend to use parameter “response=encrypt” to get an encrypted response by the 1cs OPS However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the “code”-value which indicates success/failure of the action. Only a result of “code=00000000” should be considered successful. |
| Response | a7 | O | Status response sent by the 1cs Online Payment System to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
| URLNotify | ans..256 | M | Complete URL which the 1cs Online Payment System calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead. Common notes: We recommend to use parameter “response=encrypt” to get an encrypted response by the 1cs OPS However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the “code”-value which indicates success/failure of the action. Only a result of “code=00000000” should be considered successful. |
| UserData | ans..1024 | O | If specified at request, the 1cs Online Payment System forwards the parameter with the payment result to the shop |
| ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the 1cs Online Payment System will not carry out the payment, but will just return the status of the original transaction. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the 1cs Online Payment System. |
| Account | ans..128 | O | For managing multiple PayPal accounts, Merchant account: ID or e-Mail address for which the request should be submitted to PayPal |
| LandingPage | ans | O | Controls how the PayPal page is displayed. Possible values are “Login” or “Billing” |
| Language | an2 | O | AU, DE, FR, IT, GB, ES, US ; default DE |
| FirstName | ans..50 | OC | (obligatory for USA and Canada): Either the first name only or first and second name if a company name is used as a delivery address. |
| LastName | ans..50 | OC | (obligatory for USA and Canada): Surname or name of the company of the delivery address |
| AddrStreet | ans..100 | OC | (obligatory for USA and Canada): Street in the delivery address |
| AddrStreet2 | ans..100 | O | Street in the delivery address that contains additional information e.g. packing station or similar. In order to receive this as a response parameter, it needs to be activated separately by the 1cs OPS Helpdesk. |
| AddrCity | ans..40 | OC | (obligatory for USA and Canada): Town/city in the delivery address |
| AddrState | ans..40 | OC | (obligatory for USA and Canada): Federal state of the delivery address. The town submitted in AddrCity must be located in the given federal state, otherwise PayPal refused this payment. For possible values please refer to the PayPal-API-reference documentation. |
| AddrZip | ans..20 | OC | (obligatory for USA and Canada): Postcode in the delivery address |
| AddrCountryCode | an2 | O | Country code of the delivery country |
| Phone | n..20 | O | Telephone number |
| NoShipping | n1 | O | Handover NoShipping=1 prevents the delivery address registered with Paypal from being displayed The 1cs Online Payment System also offers the option to permanently suppress the delivery address for you on your MID. Please note that the delivery address should only be suppressed in the case of digital goods, as the seller protection is also linked to this. Please contact the 1cs OPS Helpdesk for this. |
| AllowNote | ans..2 | O | The value “no” prevents the option of sending a message to the merchant. As standard a possible message is returned in the Infotext parameter. |
| BuyerEMail | ans..127 | OC | Pre-completion of an email address on the PayPal login page |
| NoteToBuyer | ans..165 | O | Notice for the buyer |
Parameters for PayPal payments
The following table gives the result parameters which the 1cs Online Payment System transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
be prepared to receive additional parameters at any time and do not check the order of parameters
the parameters (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description | |
| MID | ans..30 | M | MerchantID, assigned by First Cash Solution | |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System | |
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment | |
| Status | a..30 | M | OK, AUTHORIZE_REQUEST or Timeout (only if Capture=Manual) on the URLSuccess page or FAILED on the URLFailure page. AUTHORIZE_REQUEST – Is returned actively only for request parameter “TxType=auth” or “PayPalMethod=shortcut”. When using TxType=auth or without TxType the final status is returned directly. Timeout – All open payments with status AUTHORIZE_REQUEST will be closed ~ 3hours later automatically and are reported as Timeout. | |
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | |
| Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file | |
| MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) | |
| RefNr | ans..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). | |
| UserData | ans..1024 | O | If specified at request, the 1cs Online Payment System forwards the parameter with the payment result to the shop | |
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with the First Cash Solution Support | |
| Name | ans..32 | M | First name and surname joined | |
| FirstName | ans..50 | M | First name of payer (PayerInfo, may differ from the account name) | |
| LastName | ans..50 | M | Last name of payer (PayerInfo, may differ from the account name) | |
| ans..100 | M | Email address of the purchaser. | ||
| AddrStreet | ans..100 | O | Street in the delivery address | |
| AddrStreet2 | ans..100 | O | 2. Street name in the delivery address,that contains additional information e.g. packing station or similar. In order to receive this as a response parameter, it needs to be activated separately by the First Cash Solution | |
| AddrCity | ans..40 | O | Town/city in the delivery address | |
| AddrState | ans..40 | O | Federal State in the delivery address | |
| AddrZIP | ans..20 | O | Postcode in the delivery address | |
| AddrCountryCode | an2 | O | Country code of the delivery country | |
| Phone | n..20 | O | Telephone number | |
| BillingAgreementID | an19 | M | Identification number of the invoice agreement. When the buyer confirms the invoice agreement it is validated and remains valid until revoked by the buyer. | |
| BillingName | ans..32 | O | First name and surname joined | |
| BillingAddrStreet | ans..100 | O | Street name of the invoicing address lodged with PayPal | |
| BillingAddrStreet2 | ans..100 | O | 2. Street name of the invoicing address lodged with PayPal, that contains additional information e.g. packing station or similar. In order to receive this as a response parameter, it needs to be activated separately by the First Cash Solution | |
| BillingAddrCity | ans..40 | O | Town/city name of the invoicing address saved with PayPal | |
| BillingAddrState | ans..40 | O | Federal state of the invoicing address saved with PayPal | |
| BillingAddrZIP | ans..20 | O | Postcode of the invoicing address saved with PayPal | |
| BillingAddrCountryCode | an2 | O | Country code of the delivery country | |
| TransactionID | an..19 | O | Unique transaction number from PayPal for a transaction (Paypal Order) | |
| TID | an..19 | O | Unique transaction number from PayPal for an authorisation (PayPal Auth): Only for automatic PayPal configuration or if TxType=Auth | |
| payerStatus | an..10 | O | Status of buyer with possible values “verified” or “unverified” | |
| InfoText | ans..255 | M | Message to the merchant | |
| PayerID | ans..13 | O | Unique identification number of customer account at PayPal. (Additional response has to be first activated. Please contact the support@1cs.de, if you need the additional values in the response) | |
| GrossAmount | an..9 | O | Final amount charged, including any shipping and taxes from your Merchant Profile | |
| FeeAmount | an..9 | O | PayPal fee amount charged for the transaction | |
| SettleAmount | an..9 | O | Amount deposited in your PayPal account after a currency conversion | |
| TaxAmount | an..9 | O | Tax charged on the transaction | |
| ExchangeRate | an..17 | O | Exchange rate if a currency conversion occurred. Relevant only if you are billing in their non-primary currency. If the buyer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the buyer’s account | |
| mc_fee | an..9 | C | Only in case of separate Notify from PayPal: Transaction fee associated with the payment. mc_gross minus mc_fee equals the amount deposited into the receiver_email account. Equivalent to payment_fee for USD payments. If this amount is negative, it signifies a refund or reversal, and either of those payment statuses can be for the full or partial amount of the original transaction fee | |
| mc_gross | an..9 | C | Only in case of separate Notify from PayPal: Full amount of the customer’s payment, before transaction fee is subtracted. Equivalent to payment_gross for USD payments. If this amount is negative, it signifies a refund or reversal, and either of those payment statuses can be for the full or partial amount of the original transaction. |
Return parameters for URLSuccess, URLFailure and URLNotify with PayPal
Notice: The address parameters are always transmitted to the shop but are empty if no address data has been exchanged.
The PayPal “shortcut” method enables a changed transaction procedure which takes the customer back to the shop for payment confirmation and e.g. in the case of purchase by instalment, displays the instalment purchase data which the customer then has to confirm. To complete this PayPal payment in the next step, use the following URL and parameters:
Notice: For security reasons, the 1cs OPS rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | Format | CND | Description |
| MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter has to be passed in plain language too. |
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the 1cs support, if you want to capture amounts <100 (smallest currency unit). |
| Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP.Please find an overview here: A1 Currency table EN |
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment Enter the PayID from the response from paypal.aspx received in the previous transaction procedure. |
| RefNr | ns..30 | O | Merchant´s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
| OrderDesc(n) | ans..2048 | O | Customers shopping basket in the form: OrderDesc(n)=Name,Amount,Number,Quantity,Description,Tax OrderDesc2 to max. OrderDesc99 permissible For correct execution of displaying function all OrderDesc(n) Amounts must equal to the 1cs Online Payment System parameter Amount. If OrderDesc(n) is used, there must be valid: Amount=ItemTotal+TaxTotal+SHAmount Notice: If OrderDesc(n) is changed also the Amount has to be modified. |
| Address information. When you transfer these values you can also change an address. Notice: If transferring FirstName, all other values should also be entered. If not transferring FirstName, other address parameters are not taken into account. | |||
| FirstName | ans..50 | C | Mandatory in order to transfer address information Either the first name only or first and second name if a company name is used as a delivery address. |
| LastName | ans..50 | C | Obligatory if FirstName is transmitted: Surname or name of the company of the delivery address |
| AddrStreet | ans..100 | C | Obligatory if FirstName is transmitted: Street in the delivery address |
| AddrStreet2 | ans..100 | C | Obligatory if FirstName is transmitted: 2. Street name in the delivery address that contains additional information e.g. packing station or similar. In order to receive this as a response parameter, it needs to be activated separately by the 1cs OPS |
| AddrCity | ans..40 | C | Obligatory if FirstName is transmitted: Town/city in the delivery address |
| AddrState | ans..40 | C | Obligatory if FirstName is transmitted: Federal state of the delivery address. The town submitted in AddrCity must be located in the given federal state, otherwise PayPal refused this payment. For possible values please refer to the PayPal-API-reference documentation. |
| AddrZip | ans..20 | C | Obligatory if FirstName is transmitted: Postcode in the delivery address |
| AddrCountryCode | an2 | C | Obligatory if FirstName is transmitted: Country code of the delivery country |
| Phone | n..20 | C | Obligatory if FirstName is transmitted: Telephone number |
Parameters for PayPal payments with method “shortcut”
The following table describes the result parameters with which the 1cs online payment system responds to your system
be prepared to receive additional parameters at any time and do not check the order of parameters
the parameters (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
| MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| XID | an32 | M | ID assigned by the 1cs Online Payment System for all single transactions (order, sale, authorization, capture, credit), for one payment assigned by the 1cs OPS |
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Status | a..50 | M | OK URL(Success) or FAILED URL(Failure) |
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
| RefNr | ans..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with the First Cash Solution Support |
Response parameters for PayPal with method “shortcut”
For a PayPal payment the ORDER can be separated from the subsequent authorization and the following steps. Separate authorization is only possible after the order (TxType=Order) is completed.
For a separate authorization with PayPal, call the following URL:
The following table describes the encrypted payment request parameters:
| Key | Format | CND | Description |
| MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter has to be passed in plain language too. |
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the 1cs support, if you want to capture amounts <100 (smallest currency unit). |
| Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| TxType | ans..5 | M | Transaction type Auth |
| FirstName | ans..50 | O | Either the first name only or first and second name if a company name is used as a delivery address. |
| LastName | ans..50 | O | Surname or name of the company of the delivery address |
| AddrStreet | ans..100 | O | Street in the delivery address |
| AddrStreet2 | ans..100 | O | 2. Street name in the delivery address that contains additional information e.g. packing station or similar. In order to receive this as a response parameter, it needs to be activated separately by the First Cash Solution |
| AddrCity | ans..40 | O | Town/city in the delivery address |
| AddrState | ans..40 | O | Federal state of the delivery address. The town submitted in AddrCity must be located in the given federal state, otherwise PayPal refused this payment. For possible values please refer to the PayPal-API-reference documentation. |
| AddrZip | ans..20 | O | Postcode in the delivery address |
| AddrCountryCode | an2 | O | Country code of the delivery country |
| Phone | n..20 | O | Telephone number |
Parameters for PayPal authorization
The following table describes the result parameters with which the 1cs online payment system responds to your system
be prepared to receive additional parameters at any time and do not check the order of parameters
the parameters (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters for PayPal authorization
To carry out a Capture for PayPal via a Server-to-Server connection please use the following URL:
Notice: For security reasons, the 1cs Online Payment System rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | Format | CND | Description |
| MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain language too. |
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the 1cs support, if you want to capture amounts <100 (smallest currency unit). |
| Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
| ReqId | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, 1cs OPS will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the 1cs OPS must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the 1cs OPS. |
| RefNr | ans..30 | O | Merchant reference number: here a separate reference number, e.g. an invoice number, can be transferred Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
| TID | ans..17 | O | PayPal unique transaction number Required for part postings to previous authorisations. |
| CompleteType | ans..3 | O | If <YES> is transferred, the possible open order of PayPal is closed on capture. (Reason: a 115% capture is permissible on the part of PayPal. If a capture reached 100%, the 1cs Online Payment System automatically sends a request to close the payment). |
Parameters for PayPal captures
The following table describes the result parameters with which the 1cs online payment system responds to your system
be prepared to receive additional parameters at any time and do not check the order of parameters
the parameters (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
| MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System. |
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
| TID | ans..17 | O | PayPal unique transaction number Required for part postings to previous authorisations. |
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with First Cash Solution Support |
Result parameters for PayPal captures
To carry out a credit with a reference transaction for PayPal, please use the following URL:
Notice: For security reasons, the 1cs Online Payment System rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | Format | CND | Description |
| MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain language too. |
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the 1cs OPS, if you want to capture amounts <100 (smallest currency unit). |
| Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
| ReqId | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, 1cs OPS will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the 1cs OPS must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the 1cs Online Payment System |
| RefNr | ans..30 | O | Merchant reference number: here a separate reference number, e.g. an invoice number, can be transferred Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
| TID | ans..17 | O | PayPal unique transaction number Required for part credit notes to prior partial captures. |
| Note | ans..768 | C | Explanatory text for recipient |
| Subject | ans..255 | C | MassPay: E-Mail subject to recipient. If you want to use the MassPay functionality, please contact the 1cs OPS Helpdesk to activate this function for you. |
Parameters for PayPal credits with reference transaction
The following table describes the result parameters with which the 1cs online payment system responds to your system
be prepared to receive additional parameters at any time and do not check the order of parameters
the parameters (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
| MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs OPS |
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
| TID | ans..17 | O | PayPal unique transaction number. Required for part postings to previous authorisations. |
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with the First Cash Solution Support |
| FeeRefundAmount | n..10 | O | The refunded amount of the PayPal transaction fees. Required for part credit notes to prior partial captures. |
| GrossRefundAmount | n..10 | O | Amount refunded to the buyer in this refund transaction. Required for part credit notes to prior partial captures. |
| NetRefundAmount | n..10 | O | Amount deducted from your PayPal account to make this refund. Required for part credit notes to prior partial captures. |
Response parameters for PayPal credits with reference transaction
Use the following URL and parameters to initiate a credit without reference transaction for PayPal payment in the 1cs Online Payment System form:
https://www.computop-paygate.com/paypalcreditEx.aspx
The following table describes the encrypted payment request parameters:
| Key | Format | CND | Description |
| MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain language too. |
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the 1cs support, if you want to capture amounts <100 (smallest currency unit). |
| Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
| TransID | ans..64 | M | TransactionID which should be unique for each payment |
| MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
| ReqId | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, 1cs OPS will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the 1cs OPS must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the 1cs Online Payment System. |
| RefNr | ns..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
| Account | ans..128 | O | For managing multiple PayPal accounts, Merchant account: ID or e-Mail address for which the request should be submitted to PayPal |
| Note | ans..768 | C | MassPay: Explanatory text for recipient If you want to use the MassPay functionality, please contact the 1cs OPS Helpdesk to activate this function for you. |
| Subject | ans..255 | C | MassPay: E-Mail subject to recipient If you want to use the MassPay functionality, please contact the 1cs OPS Helpdesk to activate this function for you. |
| Payer | ans..100 | O | MassPay: Email address of the purchaser If you want to use the MassPay functionality, please contact the 1cs OPS Helpdesk to activate this function for you. |
Parameters for PayPal credits without reference transaction
The following table describes the result parameters with which the 1cs online payment system responds to your system
be prepared to receive additional parameters at any time and do not check the order of parameters
the parameters (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
| MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System. |
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with the First Cash Solution Support |
| FeeRefundAmount | n..10 | O | The refunded amount of the PayPal transaction fees. Required for part credit notes to prior partial captures. |
| GrossRefundAmount | n..10 | O | Amount refunded to the buyer in this refund transaction. Required for part credit notes to prior partial captures. |
| NetRefundAmount | n..10 | O | Amount deducted from your PayPal account to make this refund. Required for part credit notes to prior partial captures. |
Response parameters for PayPal credits without reference transaction
To cancel a transaction with PayPal, please use the following URL:
The following table describes the encrypted payment request parameters:
| Key | Format | CND | Description |
| MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain language too. |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| TransID | ans..64 | M | TransactionID which should be unique for each payment |
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
| Currency | a..3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
| MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
| ReqId | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, 1cs OPS will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the 1cs OPS must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the 1cs OPS. |
| TID | ans..17 | O | PayPal unique transaction number Required for part cancellations of prior part authorisations. |
Parameters for PayPal reversals
The following table describes the result parameters with which the 1cs online payment system responds to your system
be prepared to receive additional parameters at any time and do not check the order of parameters
the parameters (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
| MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs OPS |
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with the First Cash Solution Support |
| TID | ans..17 | O | PayPal unique transaction number Required for part cancellations of prior part authorisations. |
Result parameters for PayPal reversals
1. In order to process the initial recurring payment use paypal.aspx and add the parameter “RTF=I”. The additional parameter triggers a recurring flag to be recognized by PayPal. If you want to get the „BillingAgreementID“ only with the first request without to show the original amount to the customer, please submit the parameter “txtype=BAID” to the 1cs Online Payment System. If txtype=BAID is submitted, the 1cs Online Payment System sets the value automatically to 0,00.
Please note, that the merchant never may send an amount of 0,00€, because the 1cs Online Payment System cannot process this.
That means the merchant has to specify an amount X >0,00 an the 1cs Online Payment System changes this for PayPal to 0,00.
2. You will receive PayPal`s standard parameters as well as the additional parameter “BillingAgreementID” in First Cash Solution´s response. Please add and save this parameter in your system.
3. In order to process the second/recurring payment, please use the URL https://www.computop-paygate.com/paypalAbo.aspx. In this server-to-server based request, please use the regular parameters as well as the parameter “BillingAgreementID”. The additional parameter triggers the second/recurring payment with reference to the initial recurring payment. This way amount withdrawals are available without the need of a customer login into PayPal.
The following addition will be displayed during payment process within the customer`s PayPal account (example):
“Hereby you authorise –merchant name– for future direct withdrawals from your PayPal account without any action on your part. You can revoke this authorisation at any time within your profile.”
The customer can obtain information about this function within his PayPal account.
If you are initiating payments including txtype=Order or Auth First Cash Solution returns the “BillingAgreementID” for this action already within the notification. The “BillingAgreementID” is not necessary for the subsequent action capture. Only if a new payment is initiated it is necessary as a referral.
The customer can revoke the BillingAgreementID in his PayPal account. The merchant will only be informed about the cancellation if the additional option IPN “instant payment notification” is activated for his account. The activation has to be done in the First Cash Solution as well as PayPal account. Please keep in mind that by activating IPN the merchant receives a notification for each status change of a PayPal payment.
If a customer revokes the BillingAgreementID no further recurring payments are possible. It is also not possible to reactivate a BillingAgreementID.
The processing of PayPal payments by subscription requires an initial transaction to have been processed via the normal interface. Also, the possibility of subscriptions must have been activated previously with both PayPal and First Cash Solution. Therefore, the option “Reference transaction” muss be arranged with First Cash Solution and PayPal. Besides following 3 API Access Level boxes options must be checked in the section “Available permissions” during setup (see section Setting up the API permission above):
Use the following URL and parameters to initiate a PayPal subscription payment in the 1cs Online Payment System form:
The following table describes the encrypted payment request parameters:
| Key | Format | CND | Description |
| MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain language too. |
| TransID | ans..64 | M | TransactionID which must be unique for each payment |
| RefNr | ns..30 | O | Merchant’s unique reference number which must be unique for each payment Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
| Currency | a..3 | M | Currency code, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
| OrderDesc | ans..30 | Description of purchased goods, unit prices etc. | |
| Capture | a..6 | M | Auto or Manual determines whether the requested amount is settled immediately or at a later stage. Important Note: Please contact First Cash Solution Support for Manual, to discuss different possibilities of usage. |
| TxType | ans..5 | M | Obligatory for Capture=Manual: Transaction type with possible values Order and Auth |
| BillingAgreementID | an19 | M | Identification number of the invoice agreement. When the buyer confirms the invoice agreement it is validated and remains valid until revoked by the buyer. |
| RTF | ans1 | O | For repeat payments (subscriptions): I = Initial payment of a new subscription R = Routine payment (Recurring) |
| FirstName | ans..50 | OC | (obligatory for USA and Canada): Either the first name only or first and second name if a company name is used as a delivery address. |
| LastName | ans..50 | OC | (obligatory for USA and Canada): Surname or name of the company of the delivery address |
| AddrStreet | ans..100 | OC | (obligatory for USA and Canada): Street in the delivery address |
| AddrCity | ans..40 | OC | (obligatory for USA and Canada): Town/city in the delivery address |
| AddrState | ans..40 | OC | (obligatory for USA and Canada): Federal state of the delivery address. The town submitted in AddrCity must be located in the given federal state, otherwise PayPal refused this payment. For possible values please refer to the PayPal-API-reference documentation. |
| AddrZip | ans..20 | OC | (obligatory for USA and Canada): Postcode in the delivery address |
| AddrCountryCode | an2 | O | Country code of the delivery country |
| Phone | n..20 | O | Telephone number |
Parameters for PayPal subscriptions
The following table describes the result parameters with which the 1cs online payment system responds to your system
be prepared to receive additional parameters at any time and do not check the order of parameters
the parameters (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
| MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs OPS. |
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with First Cash Solution Support |
| BillingAgreementID | an19 | M | Identification number of the invoice agreement. When the buyer confirms the invoice agreement it is validated and remains valid until revoked by the buyer. |
Result parameters for PayPal subscriptions
Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.
This section describes the parameters which must be transferred within the data set (Record) for executing a PayPal payment and which information can be found within the response file about the payment status.
For Batch calls there must be considered batch versions, from which optional parameters depend. All version designations starting with „2.“ pertain calls for a group of enterprises. That means within a batch file for a particular MerchantID can be transferred transactions for other merchants with a separate Sub-MID.
Following table gives an overview of all batch versions that are possible for a specific action and their specialities:
| Action | Version | Description |
| Authorize | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.4 / 2.4 | with TID | |
| Capture | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2.x | with RefNr (valid for all versions other than 1.0) | |
| 1.4 / 2.4 | with TID | |
| Credit | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2.x | with RefNr (valid for all versions other than 1.0) | |
| 1.4 / 2.4 | with TID | |
| CreditEx | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2.x | with RefNr (valid for all versions other than 1.0) | |
| Reverse | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.4 / 2.4 | with TID | |
| Abo | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2.x | with RefNr (valid for all versions other than 1.0) |
Description of the possible batch versions
The structure for a PayPal payment within a Batch file to be submitted is the following:
HEAD,<MerchantID>,<Date>,<Version>
PAYPAL,Authorize,<Amount>,<Currency>,<TransID>,<PayID>
PAYPAL,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<TID>) PAYPAL,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<TID>) PAYPAL,CreditEx,<TransID>,(<RefNr>,)<Amount>,<Currency>,<payer>,<note> PAYPAL,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<TID>) PAYPAL,ABO,<Amount>,<Currency>,<TransID>,(<RefNr>),(<OrderDesc>),(<Capture>),(<TxType>,)<BillingAgreementId>
FOOT,<CountRecords>,<SumAmount>
Example for Master MID Funktion:
HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount
Notice: In Version 1.4 it is also possible to transfer CompleteType together with a Capture action:
PAYPAL,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>(,<CompleteType>,<TID>)
The following table describes the individual fields and values used within the data set (record) in the batch file:
| Key | Format | CND | Description |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the 1cs support, if you want to capture amounts <100 (smallest currency unit). |
| Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
| Type | a..11 | M | HEAD for Header, FOOT for Footer, PAYPAL for PayPal |
| Action | a..20 | M | The parameter Action defines the type of transaction: Authorize Capture Credit CreditEx (credit note without previous capture; please agree this with First Cash Solution Support beforehand) Reverse (cancellation) Abo (subscription) |
| RefNr | ans..30 | O | Unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
| payer | ans..100 | O | MassPay: Email address of the purchaser: In this case you transfer the received email parameter from the Response. If you want to use the MassPay functionality, please contact the 1cs OPS Helpdesk to activate this function for you. |
| note | ans..758 | O | Explanatory text for recipient |
| TID | ans..17 | O | PayPal unique transaction number Required for a number of authorisations or part captures, part credit notes or part cancellations. |
| OrderDesc | ans..127 | O | Description of purchased goods, unit prices etc. |
| Capture | a..6 | O | Auto or Manual: determines whether the requested amount is settled immediately or at a later stage. |
| TxType | ans..5 | OC | Obligatory for Capture=Manual: Transaction type with possible values Order and Auth |
| BillingAgreementID | an19 | M | Identification number of the invoice agreement. When the buyer confirms the invoice agreement it is validated and remains valid until revoked by the buyer. |
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks as follows:
HEAD,<MerchantID>,<Date>,<Version>
PAYPAL,Authorize,<Amount>,<Currency>,<TransID>,<PayID>,<Status>,<Code>,<CodeExt>
PAYPAL,Capture,<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,(TID,)<Status>,<Code>,<CodeExt> PAYPAL,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,(TID,)<Status>,<Code>,<CodeExt> PAYPAL,CreditEx,<TransID>,(<RefNr>,)<Amount>,<Currency>,<payer>,<note>,<Status>,<Code>,<CodeExt> PAYPAL,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>,<CodeExt> PAYPAL,ABO,<Amount>,<Currency>,<TransID>,(<RefNr>),(<OrderDesc>),(<Capture>),(<TxType>,)<BillingAgreementId>,<CodeExt>,<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount>
The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):
| Parameter | Format | CND | Description |
| Action | a..20 | M | The parameter Action defines the type of transaction like capture or credit. |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
| CodeExt | n..10 | O | Error code from external partner. Needs to be agreed with the 1cs Online Payment System |
Description of result parameters within the record for Batch files
Wir informieren Dich darüber, dass wir seit 10:23 Uhr eine Störung in der Verarbeitung der Online-Transaktionen im E-Commerce beobachten.
Wir arbeiten mit Hochdruck an einer Lösung und melden uns sobald wir mehr Informationen haben.
Interchange-Gebühr:
Wird von der kartenherausgebenden Bank bzw. Issuer in Rechnung gestellt. Sie wird auch Interchange Fee (ICF) genannt.
Gebühr der Kartenorganisationen:
Werden bin den Kreditkartenorganisationen wie Visa oder Mastercard erhoben, sie werden auch Card Scheme Fees (CSF) genannt.
Bearbeitungsgebühr:
Wird von Deinem Zahlungsanbieter/Acquirer berechnet. In Deinem Fall von uns (1cs) Sie wird auch Acquirer Service Fee (ASF) genannt.
“Hier wird uns bei jedem Anliegen kompetent, unkompliziert und schnell geholfen! Daher können wir die First Cash Solution nur empfehlen.”
Sandra von Bargen, Hachez CHOCOVERSUM GmbH
„Die unkomplizierte schnelle Betreuung passt 100% zu uns und unserem Abrechnungssystem.“
Markus Tanger, Road House Paderborn
“Wir setzen bei Fahrrad XXL auf den verlässlichen Service der First Cash Solution und fühlen uns hier bestens aufgehoben!”
Peter Hürter, Fahrrad XXL