PayX

Supported Transaction Types

• Authorisation

• Capture

• Purchase

• Refund

• Withdrawal

• Void

• ApplePay

• GooglePay

Integrations Supported

Deposit

• Hosted Payment Page

• Direct Connect ( server-to-server)

Withdrawal

• Hosted Payment Page

• Direct Connect ( server-to-server)

Currencies & Countries Supported

Additional attributes to process PayX

You must include the following JSON Attributes to the payload. These attributes inform us to redirect to Paystack to finalise the payment process.

Sample Deposit Request

Refer to our API Reference Document here to create a Hosted Payment Page, use the below mandatory tags to process a deposit.

Below is a sample deposit request.

{
  "TransactionType": "PURC",
  "Amount": "12.34",
  "Currency": "USD",
  "Country": "MLT",
  "OrderReference": "MerchantOrder1",
  "RedirectionURL": "https://www.yourURLhere.com/Redirect/",
  "CallBackURL": "https://www.yourURL.com/Listener",
  "Routing": {
    "ForcePayment": "PAYX"
  },
  "IsTest": "True",
  "Profile": "showandedit",
  "Client": {
    "email": "test@apcopay.com",
    "clientAccount": "testing",
    "firstName": "John",
    "lastName": "Doe",
    "country": "EN",
    "mobileNo": "3567789963",
    "street": "High Street",
    "city": "MagicCity",
    "ZIPCode": "BGGC1234",
    "state": "UK",
    "dateOfBirth": "1977-12-31",
    "IPAddress": "127.0.0.1"
  }
}

Withdrawals

Withdrawals are processed via Direct Connect. The API reference to request a payout can be found here.

Below is a sample Withdrawal request.

{
  "TransactionType": "ORIGINALCREDIT",
  "Amount": "1.00",
  "Currency": "USD",
  "OrderReference": "Orange Money test payout",
  "PaymentDestination": {
    "PaymentMethodData": {
      "PaymentMethod": "OPEN_BANKING",
      "BeneficiaryAccountNumber": "123456"
    }
  },
  "Routing": {
    "ForcePayment": "PAYX"
  },
  "Client": {
    "FirstName": "Joe",
    "LastName": "Bloggs",
    "Country": "MLT",
    "Street": "High Street",
    "City": "MagicCity",
    "Email": "apcotest@test.com",
    "IPAddress": "214.21.134.79",
    "ClientAccount": "123456"
  },
  "RedirectionURL": "https://yoururl.com/Redirect/",
  "CallBackURL": "https://yoururl.com/Listener",
  "IsTest": "True"
}

ApplePay

For Apple Pay, the following attributes are required for our Hosted Payment Page flow:

Below is a sample Withdrawal request.

{
  "TransactionType": "PURC",
  "Amount": "1.21",
  "Currency": "USD",
  "Country": "MLT",
  "OrderReference": "MerchantOrder1",
  "RedirectionURL": "https://yoururl.com/Redirect/",
  "CallBackURL": "https://yoururl.com/Listener",
  "PaymentMethodData": {
    "PaymentMethod": "APPLEPAY"
  },
  "Routing": {
    "ForcePayment": "PAYX"
  },
  "IsTest": "True",
  "Profile": "showandedit",
  "Client": {
    "email": "test@apcopay.com",
    "clientAccount": "testing",
    "firstName": "John",
    "lastName": "Doe",
    "country": "EN",
    "mobileNo": "3567789963",
    "street": "High Street",
    "city": "MagicCity",
    "ZIPCode": "BGGC1234",
    "state": "UK",
    "dateOfBirth": "1977-12-31",
    "IPAddress": "127.0.0.1"
  }
}

GooglePay

For GooglePay, the following attributes are required for our Hosted Payment Page flow:

Below is a sample Withdrawal request.

{
  "TransactionType": "PURC",
  "Amount": "1.21",
  "Currency": "USD",
  "Country": "MLT",
  "OrderReference": "MerchantOrder1",
  "RedirectionURL": "https://yoururl.com/Redirect/",
  "CallBackURL": "https://yoururl.com/Listener",
  "PaymentMethodData": {
    "PaymentMethod": "GOOGLEPAY"
  },
  "Routing": {
    "ForcePayment": "PAYX"
  },
  "IsTest": "True",
  "Profile": "showandedit",
  "Client": {
    "email": "test@apcopay.com",
    "clientAccount": "testing",
    "firstName": "John",
    "lastName": "Doe",
    "country": "EN",
    "mobileNo": "3567789963",
    "street": "High Street",
    "city": "MagicCity",
    "ZIPCode": "BGGC1234",
    "state": "UK",
    "dateOfBirth": "1977-12-31",
    "IPAddress": "127.0.0.1"
  }
}