Supported Transaction Types
Authorisation
Capture
Purchase
Refund*
Void
*Direct Connect only
Integrations Supported
Deposit:
Refund:
Hosted Payment Page
Supported Wallet
GooglePay
Applepay
Additional Parameters Required for Deposit
Depending on the integration type being used, these are the additional parameters required
Description | Hosted Payment Page |
|---|---|
Force Transaction Routing | "Routing": { "ForcePayment": "CRYPTOPAY" }, |
Client Information | "Client": { "ClientAccount": "accountid123", "Email": "test@apcopay.com", "FirstName": "John", "LastName": "Doe", "MobileNo": "79290218", "City": "Marsa", "Country": "MLT", "Street": "Test Street", "IPAddress": "102.38.239.2", "DateOfBirth": "1999-01-01" }, |
Payment Method Data | "PaymentMethodData" : { "PurchaseDescription": "Test Deposit G", "CryptoProtocol": "bitcoin", "CryptoCurrency": "BTC" }, |
Test Indicator (required in Sandbox Environment) | "IsTest": "True" |
Sample Request via Hosted Payment Page
{
"TransactionType": "PURC",
"Currency": "EUR",
"Amount": "31.50",
"OrderReference": "Test Deposit CryptoPay",
"RedirectionURL": "https://URL/Redirect",
"CallBackURL": "https://URL/Listener",
"FailRedirectionURL": "https://URL/Redirect",
"Language": "en",
"Client": {
"ClientAccount": "accountid123",
"Email": "test@apcopay.com",
"FirstName": "John",
"LastName": "Doe",
"MobileNo": "79290218",
"City": "Marsa",
"Country": "MLT",
"Street": "Test Street",
"IPAddress": "102.38.239.2",
"DateOfBirth": "1999-01-01"
},
"PaymentMethodData" : {
"PurchaseDescription": "Test Deposit G",
"CryptoProtocol": "bitcoin",
"CryptoCurrency": "BTC"
},
"Routing": {
"ForcePayment": "CRYPTOPAY"
},
"IsTest": "True",
"Configuration": {
"Profile": "showandedit"
}
}Additional Parameters Required for Refund
Below are the additional tag/s required to process a refund.
Description | Hosted Payment Page |
|---|---|
Force Transaction Routing | "Routing": { "ForcePayment": "CRYPTOPAY" }, |
Client Information | "Client": { "ClientAccount": "accountid123", "Email": "test@apcopay.com", "FirstName": "John", "LastName": "Doe", "MobileNo": "79290218", "City": "Marsa", "Country": "MLT", "Street": "Test Street", "IPAddress": "102.38.239.2", "DateOfBirth": "1999-01-01" }, |
Payment Method Data | "PaymentMethodData" : { "CryptoCurrency": "BTC", "CryptoAddress": "tb1q7t22stfr0caqg4j2w02pu2fe85m66hlre9mvx6", "CryptoProtocol": "bitcoin" }, |
Test Indicator (required in Sandbox Environment) | "IsTest": "True" |
Sample Refund request:
{
"TransactionType": "ORIGINALCREDIT",
"Currency": "EUR",
"Amount": "19.50",
"OrderReference": "Test Payout CryptoPay",
"RedirectionURL": "https://URL/Redirect/",
"CallBackURL": "https://URL/Listener",
"FailRedirectionURL": "https://URL/Redirect/",
"Language": "en",
"Client": {
"Email": "test@apcopay.com",
"FirstName": "Apcopay",
"LastName": "Integrations",
"MobileNo": "79290218",
"City": "Marsa",
"Country": "MLT",
"Street": "Test Street",
"IPAddress": "102.38.239.2",
"DateOfBirth": "1999-01-01"
},
"Routing": {
"ForcePayment": "CRYPTOPAY"
},
"PaymentMethodData" : {
"CryptoCurrency": "BTC",
"CryptoAddress": "tb1q7t22stfr0caqg4j2w02pu2fe85m66hlre9mvx6",
"CryptoProtocol": "bitcoin"
},
"IsTest": "True"
}