Payment Methods

Paypal

                                                            
{
   "id": "7bb6f1f3-d280-4b0c-a74f-90471ea69426", // Auto-generated UUID
   "paymentMethod": "paypal", // Payment method of use
   "returnUrl": "https://example.com", // URL to return after payment completion.
   "webhookUrl": "https://example.com", // URL to receive webhook notification.
   "transaction":{
      "reference": "test-1111", // Max 20 characters
      "currency": "EUR", // ISO4217 format
      "amount": 2000, // The amount is in cents, 2000 = 20 EUR. Has to be sum of amounts * quantity in lines.
      "description": "test-1444",
      "lines":[
         {
            "name": "Some Voucher - 20 EUR", // Max 100 characters. Name of product.
            "category": "PREPAID-VOUCHER", // Max 100 characters.
            "brand": "alphacomm", // Max 100 characters.
            "quantity": 1, // Number of items
            "amount": 2000 // The amount is in cents, 2000 = 20 EUR
         }
      ]
   },
   "provider": "paypal"
}
                                                         
                                                        

Sandbox Testing

For sandbox PayPal payments, contact Protectmaxx team to get a testing account.

Important note: There is a limit on test accounts created on the Paypal side in number amount and in limit for paying, in case there is no amount response in payments on the testing account it is needed to be added on the Paypal dashboard side contact Paymexx Team.


Negative testing
For sandbox, use specific codes provided by Paypal. Use values as described in Test error conditions with negative testing to trigger errors. For triggering an error with code 10755 send it like 10755 in request, because Protectmaxx accept cents as amount so decimal will be moved for 2 spots.
"amount":"10755",
Important note: In order for negative testing to work, it has to be enabled in playpal developer account.

Anti-fraud Check

Anti-fraud check (Cynic) is supported for this Provider.

Beside configuration set for fraud check. It is required for payer data to be sent along with request. Example below.


                                                            
{
   "id": "7bb6f1f3-d280-4b0c-a74f-90471ea69426", // Auto-generated UUID
   "paymentMethod": "paypal",
   "returnUrl": "https://example.com", // URL to return after payment completion.
   "webhookUrl": "https://example.com", // URL to receive webhook notification.
   "transaction":{
      "reference": "test-1111", // Max 20 characters
      "currency": "EUR", // ISO4217 format
      "amount": 2000, // The amount is in cents, 2000 = 20 EUR. Has to be sum of amounts * quantity in lines.
      "description": "test-1444",
      "lines":[
         {
            "name": "Some Voucher - 20 EUR", // Max 100 characters. Name of product.
            "category": "PREPAID-VOUCHER", // Max 100 characters.
            "brand": "alphacomm", // Max 100 characters.
            "quantity": 1, // Number of items
            "amount": 2000 // The amount is in cents, 2000 = 20 EUR
         }
      ]
   },
   "payer": {
        "id": "1337", // Unique numeric value specific per payer
        "email": "john@alphacomm.nl", // Max 64 characters.
        "deviceId": "a80d683678514df2b3c952f48b095266", // Max 50 characters.
        "billing": {
            "firstName": "Jhon", // Max 128 characters. To test decline of Fruad check flow set value to DECLINE
            "lastName": "Doe", // Max 128 characters
            "street": "Scheepmakerspassage 183", // Max 128 characters. Billing street with number.
            "city": "Rotterdam",
            "zip": "3011VH", // Max 50 characters. Customer postal code.
            "phone": "+31612345678", // Phone number with Country code.
            "email": "john@alphacomm.nl",  // Max 64 characters.
            "country": "NL" // Country code ISO3166 format
        },
        "shipping": {
            "firstName": "John", // Max 128 characters.
            "lastName": "Doe", // Max 128 characters.
            "street": "Scheepmakerspassage 183", // Shipping street with number.
            "city": "Rotterdam",
            "zip": "3011VH", // Max 50 characters. Customer postal code.
            "phone": "+31612345678", // Phone number with Country code.
            "email": "john@alphacomm.nl",  // Max 64 characters.
            "country": "NL" // Country code ISO 3166 format
        },
        "ipAddress": "127.0.0.1", // Support only ipv4
        "language": "nl", // Language code ISO 639-1 format
        "status": "registered", // Can be "guest", "registered", "registered-unconfirmed"
        "verificationStatus": "phone", // Can be "identification", "phone", "trusted", "otherwise"
        "dateRegistration": "2016-01-01T13:56:48+0100", // Date format ISO 8601
        "dateLastUpdated": "2016-01-01T13:56:48+0100", // Date format ISO 8601
        "dateFirstPurchase": "2016-01-01T13:56:48+0100", // Date format ISO 8601
        "channel": "web"  // Can be "web" or "app"
   },
    "provider":"paypal",
 }
}
                                                            
                                                        

Merchant Configuration

  • Client ID - set Paypal account client ID from your business account
  • clientSecret - Set Paypal acounnt clientSecret from your business account