---
title: "PayX"
slug: "payx"
updated: 2025-08-29T09:16:20Z
published: 2025-08-29T09:16:20Z
canonical: "docs.apcopay.com/payx"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apcopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PayX

## Supported Transaction Types

- [ ] Authorisation
- [ ] Capture
- [x] Purchase
- [ ] Refund
- [x] Withdrawal
- [ ] Void
- [x] [ApplePay](/v1/docs/payx#applepay)
- [x] [GooglePay](/v1/docs/payx#googlepay)

## Integrations Supported

**Deposit**

- [x] [Hosted Payment Page](https://apcopay.redoc.ly/#tag/Hosted-Payment-Page)
- [ ] [Direct Connect ( server-to-server)](https://apcopay.redoc.ly/#operation/PaymentOperationAUTHPURC)

**Withdrawal**

- [ ] [Hosted Payment Page](https://apcopay.redoc.ly/#tag/Hosted-Payment-Page)
- [x] [Direct Connect ( server-to-server)](https://apcopay.redoc.ly/#operation/PaymentOperationAUTHPURC)

## Currencies & Countries Supported

| Title | Description |
| --- | --- |
| **Currencies Supported** | Various |

## 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.

| Description | Hosted Payment Page | Direct Connect (Withdrawals) |
| --- | --- | --- |
| **Transaction type** | "TransactionType": "PURC", | "TransactionType": "ORIGINALCREDIT", |
| **Client** | "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" } | "Client": { "FirstName": "Joe", "LastName": "Bloggs", "Country": "MLT", "Street": "High Street", "City": "MagicCity", "Email": "apcotest@test.com", "IPAddress": "214.21.134.79", "ClientAccount": "123456" } |
| **Force Transaction Routing** | "Routing": { "ForcePayment": "PAYX" } | "Routing": { "ForcePayment": "PAYX" } |
| **Payment Destination Data** |  | "PaymentDestination": { "PaymentMethodData": { "PaymentMethod": "OPEN_BANKING", "BeneficiaryAccountNumber": "123456" } |
| **Test Indicator** (required in Sandbox Environment only) | "IsTest": True |

**Sample Deposit Request**

Refer to our API Reference Document [here](https://apcopay.redoc.ly/#tag/Hosted-Payment-Page) to create a Hosted Payment Page, use the below mandatory tags to process a deposit.

Below is a sample deposit request.

```json
{
  "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](https://apcopay.redoc.ly/#operation/PaymentOperationAUTHPURC).

Below is a sample Withdrawal request.

```json
{
  "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:

| Description | Hosted Payment Page |
| --- | --- |
| **Transaction type** | "TransactionType": "PURC", |
| **Client** | "Client": { "email": "[test@apcopay.com](mailto: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" } |
| **Force Transaction Routing** | "Routing": { "ForcePayment": "PAYX" } |
| **Payment Method Data** | "PaymentMethodData": { "PaymentMethod": "APPLEPAY" }, |

Below is a sample Withdrawal request.

```json
{
  "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:

| Description | Hosted Payment Page |
| --- | --- |
| **Transaction type** | "TransactionType": "PURC", |
| **Client** | "Client": { "email": "[test@apcopay.com](mailto: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" } |
| **Force Transaction Routing** | "Routing": { "ForcePayment": "PAYX" } |
| **Payment Method Data** | "PaymentMethodData": { "PaymentMethod": "GOOGLEPAY" }, |

Below is a sample Withdrawal request.

```json
{
  "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"
  }
}
```