---
title: "FLEXEPIN"
slug: "flexepin"
updated: 2026-05-06T08:01:12Z
published: 2026-05-06T08:01:12Z
canonical: "docs.apcopay.com/flexepin"
---

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

# FLEXEPIN

## Supported Transaction Types

- [ ] Authorisation
- [ ] Capture
- [x] Purchase
- [ ] Refund
- [x] Withdrawal
- [ ] Void

## Integrations Supported

**Deposit**

- [x] Hosted Payment Page
- [ ] Direct Connect ( server-to-server)

**Withdrawal**

- [ ] Hosted Payment Page
- [x] Direct Connect ( server-to-server) ##

## Additional attributes to process Flexepin

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

| Description | Hosted Payment Page | Direct Connect (Withdrawals) |
| --- | --- | --- |
| **Transaction type** | "TransactionType": "PURC", | "TransactionType": "ORIGINALCREDIT", |
| **Client** | "Client": { **"Email": "test@email.com",** "FirstName": "John", "LastName": "Doe", "Country": "NGA", "MobileNo": "10449262289", "Street": "Street Name, 1", "City": "London", "IPAddress": "127.0.0.1" }, | "Client": { **"Email": "test@email.com",** **"FirstName": "John",** **"LastName": "Doe",** "Country": "NGA", "MobileNo": "10449262289", "Street": "Street Name, 1", "City": "London", "IPAddress": "127.0.0.1" }, |
| **Force Transaction Routing** | "Routing": { "ForcePayment": "FLEXEPIN" }, |
| **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": "250",
  "Currency": "CAD",
  "OrderReference": "flexepinMerchantOrder1",
  "RedirectionURL": "https://google.com/Redirect/",
  "CallBackURL": "https://google.com/Listener",
  "Routing": {
    "ForcePayment": "FLEXEPIN"
  },
  "IsTest": "True",
  "Client": {
    "Email": "testing@swiffy.com",
    "clientAccount": "testing",
    "firstName": "Joe",
    "lastName": "Bloggs",
    "country": "MLT",
    "mobileNo": "00441234567",
    "street": "High Street",
    "city": "MagicCity",
    "ZIPCode": "BGGC1234",
    "state": "UK",
    "dateOfBirth": "1977-12-31",
    "IPAddress": "159.20.26.60"
  },
  "Configuration": {
    "Profile": "showandedit"
  }
}
```

**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",
  "Currency": "CAD",
  "Amount": "1",
  "OrderReference": "Test",
  "RedirectionURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Redirect/",
  "CallBackURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Listener",
  "Client": {
    "Email": "testing@flexepin.com",
    "clientAccount": "testing",
    "firstName": "Joe",
    "lastName": "Bloggs",
    "country": "MLT",
    "mobileNo": "00441234567",
    "street": "High Street",
    "city": "MagicCity",
    "ZIPCode": "BGGC1234",
    "state": "UK",
    "dateOfBirth": "1977-12-31",
    "IPAddress": "127.0.0.1"
  },
  "Routing": {
    "ForcePayment": "FLEXEPIN"
  },
  "PaymentMethodData": {
    "FlexepinVoucherQuantity": "1",
    "VoucherCode": "FLEXCAD001"
  },
  "IsTest": "True", 
  }
}
```