Paypal

Supported Transaction Types

• Authorisation

• Purchase

• Capture

• Void

• Refunds

• Withdrawals

Integrations Supported

• Hosted Payment Page

• Direct Connect

Withdrawals and Refunds

• Hosted Payment Page

• Direct Connect

A merchant registration with PayPal is required in order to begin processing. This process can be completed by obtaining a Brand Code, Client ID and Client Secret from Apco Support (support@apcopay.com) and completing the registration via the link below. Please replace {brandcode} in the URL with the code provided.

Merchant Registration URL:
https://payments.apcopay.tech/paypal/Registration?BrandCode={brandcode}

The Client ID and Secret are required on the second screen of the setup, as shown in the screenshot below:

Currencies & Countries Supported

Additional attributes required for Deposits

You must include the following JSON Attributes in the payload. These attributes inform us to proceed with the redirection to finalise the payment process.

Sample request below

{
  "TransactionType": "PURC",
  "Currency": "USD",
  "Amount": "1.23",
  "OrderReference": "MerchantOrder1",
  "RedirectionURL": "https://www.yourURLhere.com/technicalsupporttool-fe/Redirect/",
  "CallBackURL": "https://www.yourURLhere.com/technicalsupporttool-fe/Redirect/",
  "FailRedirectionURL": "https://www.yourURLhere.com/technicalsupporttool-fe/Listener",
  "Language": "en",
  "IsTest": "True",
  "Routing": {
    "ForcePayment": "PAYPAL"
  },
  "Client": {
    "Email": "test123@gmail.com",
    "ClientAccount": "testing",
    "Country": "MLT",
    "City": "City",
    "State": "State",
    "ZIPCode": "ZIP",
    "Street": "Street",
    "FirstName": "Apco",
    "LastName": "Test",
    "MobileNo": "3561234567",
    "IPAddress": "127.0.0.1"
  },
  "Configuration": {
    "Profile": "showandedit"
  }
}

Additional attributes are required for deposits for Airline Companies.

Airline companies are required to pass the below mandatory information in the payload containing certain flight details.

Sample request below

{
  "TransactionType": "PURC",
  "Currency": "GBP",
  "Amount": "1.23",
 "OrderReference": "MerchantOrder1",
  "RedirectionURL": "https://www.yourURLhere.com/technicalsupporttool-fe/Redirect/",
  "CallBackURL": "https://www.yourURLhere.com/technicalsupporttool-fe/Redirect/",
  "FailRedirectionURL": "https://www.yourURLhere.com/technicalsupporttool-fe/Listener",
  "Language": "en",
  "IsTest": "True",
  "Routing": {
    "ForcePayment": "PAYPAL"
  },
  "Client": {
    "Email": "test123@gmail.com",
    "ClientAccount": "testing",
    "Country": "MLT",
    "City": "City",
    "State": "State",
    "ZIPCode": "ZIP",
    "Street": "Street",
    "FirstName": "Apco",
    "LastName": "Test",
    "MobileNo": "3561234567",
    "IPAddress": "127.0.0.1"
  },
  "Configuration": {
    "Profile": "showandedit"
  },
  "PaymentMethodData": {
    "ShowSkrillMethod": "WLT,ACC"
  },
  "AirlineDetails": {
    "FlightLegDetails": [
      {
        "flightArrivalDate": "2025-06-18",
        "flightDepartureDate": "2025-06-17",
        "flightDepartureTime": "19:20",
        "flightArrivalTime": "22:20",
        "airlineCode": "LZ",
        "airlineFlightNumber": "101",
        "paymentType": "",
        "departureCountry": "BG",
        "departureCity": "SOF",
        "departureAirport": "SIA",
        "destinationCountry": "TV",
        "destinationCity": "TVC",
        "destinationAirport": "TIA",
        "stopOverCode": "X",
        "fareBasisCode": "Discounted",
        "serviceClass": "A"
      },
      {
        "flightArrivalDate": "2025-06-17",
        "flightDepartureDate": "2025-06-17",
        "flightDepartureTime": "19:20",
        "flightArrivalTime": "22:20",
        "airlineCode": "BN",
        "airlineFlightNumber": "103",
        "paymentType": "",
        "departureCountry": "BR",
        "departureCity": "RDJ",
        "departureAirport": "RIA",
        "destinationCountry": "RM",
        "destinationCity": "BUC",
        "destinationAirport": "BIA",
        "stopOverCode": "X",
        "fareBasisCode": "Regular",
        "serviceClass": "B"
      }
    ],
    "PassengerDetails": [
      {
        "passportNumber": "G7MMOGWFWF",
        "title": "Mr",
        "firstName": "Joe",
        "lastName": "Doe",
        "passengerName": "Passenger NNameN",
        "middleName": "G",
        "dateOfBirth": "2000-06-30",
        "countryCode": "DE"
      }
    ],
    "ReservationDetails": {
      "pnrCode": "MF8919WL3Q",
      "bookingSystemUniqueId": "YCWOP57IZK",
      "computerizedReservationSystem": "Galileo",
      "ticketNumber": "0299593814",
      "documentType": "BoardingPass",
      "flightDateUTC": "2025-06-17",
      "issueDate": "2025-02-10",
      "travelAgencyName": "NuveiSunnyTravel",
      "travelAgencyCode": "01",
      "issuingCarrierCode": "AI",
      "restrictedTicket": "1",
      "salesSource": ""
    }
  }
}

Additional attributes are required for withdrawals - Direct Connect.

Sample request below

{
  "TransactionType": "ORIGINALCREDIT",
  "Amount": "1.23",
  "Currency": "EUR",
  "OrderReference": "Paypal - Payout",
  "IsTest": true,
   "RedirectionURL": "https://www.yourURLhere.com/technicalsupporttool-fe/Redirect/",
  "CallBackURL": "https://www.yourURLhere.com/technicalsupporttool-fe/Redirect/",
  "Client": {
    "Email": "johndoe@gmail.com",
    "FirstName": "mU",
    "LastName": "sd",
    "City": "Valletta",
    "IPAddress": "1.1.1.1",
    "Country": "MT"
  },
  "Routing": {
    "ForcePayment": "PAYPAL"
  }
}

Additional attributes are required for refunds - Direct Connect.

Sample request below

{
  "TransactionType": "PARTIALREFUND",
  "Amount": "1.00",
  "Currency": "EUR",
  "OrderReference": "Paypal - Refund",
  "RedirectionURL": "https://www.yourURLhere.com/technicalsupporttool-fe/Redirect/",
  "CallBackURL": "https://www.yourURLhere.com/technicalsupporttool-fe/Redirect/",
  "IsTest": true,
  "PspId": "928748"
}