---
title: "CoinPayments"
slug: "coinpayments"
updated: 2025-08-18T13:42:53Z
published: 2025-08-18T13:42:53Z
canonical: "docs.apcopay.com/coinpayments"
---

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

# CoinPayments

**CoinPayments** is a comprehensive cryptocurrency payment gateway that allows merchants to accept Bitcoin, Ethereum, and over 2,000 altcoins in one unified platform. With robust API support, secure wallet solutions, and global reach, CoinPayments simplifies crypto transactions for businesses of all sizes.

## Supported Transaction Types

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

## Integrations Supported

**Deposit**

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

**Withdrawal**

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

## Deposit - Additional attributes to process via Coinpayments

The following JSON attributes need to be included in the payload for Deposits.

| Description | Hosted Payment Page |
| --- | --- |
| **Force Transaction Routing”** | "Routing": { "ForcePayment": "COINPAYMENTS" |
| **Client Information** | "Client": { "Email": "[test@email.com](mailto:test@email.com)", "ClientAccount": "CliAcc01002", "FirstName": "John", "LastName": "Doe", "Country": "MLT", "MobileNo": "1231212", "Street": "High Street", "City": "MagicCity", "ZIPCode": "MSU123", "State": "UK", "DateOfBirth": "1977-12-31", "IPAddress": "127.0.0.1" |
| **Payment Method Data** | "PaymentMethodData": { "CryptoCurrency": "LTCT" |
| **Test Indicator** (required in Sandbox Environment only) | "isTest": true |

**Sample Deposit Request**

```json
{
  "TransactionType": "PURC",
  "Currency": "EUR",
  "Amount": "1",
  "OrderReference": "test",
  "RedirectionURL": "https://yoururl.com/Redirect/",
  "CallBackURL": "https://yoururl.com/Listener",
  "FailRedirectionURL": "https://yoururl.com/Redirect/",
  "Language": "en",
  "Client": {
    "Email": "test@email.com",
    "ClientAccount": "CliAcc01002",
    "FirstName": "John",
    "LastName": "Doe",
    "Country": "MLT",
    "MobileNo": "1231212",
    "Street": "High Street",
    "City": "MagicCity",
    "ZIPCode": "MSU123",
    "State": "UK",
    "DateOfBirth": "1977-12-31",
    "IPAddress": "127.0.0.1"
  },
   "PaymentMethodData": {
    "CryptoCurrency": "LTCT"
  },
  "Routing": {
    "ForcePayment": "COINPAYMENTS"
  },
  "IsTest": "True",
  "Configuration": {
    "Profile": "showandedit"
  }
}
```

## Withdrawal - Additional attributes to process via Coinpayments

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

| Description | Hosted Payment Page |
| --- | --- |
| **Force Transaction Routing** | " "Routing": { "ForcePayment": "COINPAYMENTS" |
| **Client Information** | "Client": { "Email": "[johndoe@gmail.com](mailto:johndoe@gmail.com)", "FirstName": "John", "LastName": "Doe", "City": "Valletta", "DateOfBirth": "1980-01-01", "IPAddress": "1.1.1.1" |
| **Payment Method Data** | "PaymentMethodData": { "CryptoCurrency": "LTCT", "CryptoAddress": "mkjAuszK2G7MbWHm897Tap5iEJbJDef1WT" |
| **Test Indicator** (required in Sandbox Environment only) | "isTest": true |

**Sample Withdrawal Request**

```json
{
  "TransactionType": "ORIGINALCREDIT",
  "Currency": "EUR",
  "Amount": "1",
  "OrderReference": "test",
  "RedirectionURL": "https://yoururl.com/Redirect/",
  "CallBackURL": "https://yoururl.com/Listener",
  "FailRedirectionURL": "https://yoururl.com/Redirect/",
  "Language": "en",
  "Client": {
   "Email": "johndoe@gmail.com",
    "FirstName": "John",
    "LastName": "Doe",
    "City": "Valletta",
    "DateOfBirth": "1980-01-01",
    "IPAddress": "1.1.1.1"
  },
  "Routing": {
    "ForcePayment": "COINPAYMENTS"
  },
  "PaymentMethodData": {
    "CryptoCurrency": "LTCT",
    "CryptoAddress": "mkjAuszK2G7MbWHm897Tap5iEJbJDef1WT"
  },
  "IsTest": "True",
  "Configuration": {
    "Profile": "showandedit"
  }
}
```

## Test Credentials

A test simulator is available when using the dev environment. The test environment is only available when using LTCT CryptoCurrency.