PayMaxis¶
ACCEPT PAYMENTS FROM ANYWHERE
Website: paymaxis.com
Set up Account¶
Step 1: Create Provider account¶
To create an account send connection request at the paymaxis.com/contacts-us or contact manager directly. Submit the required documents to verify your account and gain access.
Step 2: Get required credentials¶
Credentials that have to be issued:
- API Key
- Signing Key
Connect Provider Account¶
Step 1. Connect Provider account at the Corefy Dashboard¶
Press Connect at Paymaxis Provider Overview page in 'New connection' section and choose Provider account option to open Connection form.
Enter credentials:
- api_key → API Key
- signing_key → Signing Key
Success
You have connected PayMaxis Provider account!
Set up Account¶
Step 1: Create merchant account¶
To create an account send connection request at the paymaxis.com or contact manager directly. Submit the required documents to verify your account and gain access.
Step 2: Get required credentials¶
Credentials that have to be issued:
- API Key
- Signing Key
Connect H2H Merchant Account¶
Step 1. Connect H2H account at the Corefy Dashboard¶
Press Connect at PayMaxis Provider Overview page in 'New connection' section and choose H2H Merchant account option to open Connection form.
Enter credentials:
- API Key → API Key
- Signing Key → Signing Key
- Currency → choose currency (You can set these parameters according to available currencies and features for your PayMaxis wallets and services, but it's necessary to check details of the connection with your Corefy account manager.)
Success
You have connected PayMaxis H2H merchant account!
API examples:¶
Maximum data set to create a transaction¶
SALE
POST /api/commerce/payment-invoices HTTP/1.1
{
"data": {
"type": "payment-invoice",
"attributes": {
"service": "payment_card_usd_hpp",
"commerce_account": "Hello World",
"currency": "USD",
"amount": 123,
"reference_id": "b877ced8-da9a-4dc0-aa64-15951828c4d0",
"flow": "charge",
"gateway_options": {
"cardgate": {
"tokenize": ""
}
},
"customer": {
"reference_id": "60e865e1-9aa8-4074-ae21-f603fba6c2ee",
"name": "Test test",
"email": "[email protected]",
"phone": "380987452365",
"date_of_birth": "2023-12-04",
"address": {
"full_address": "7, Sunny street",
"country": "BG",
"region": "1234",
"city": "London",
"post_code": "123"
}
},
"test_mode": false,
"options": {
"allow_partially": false
},
"service_fields": []
}
}
}
PAYOUT
POST /api/commerce/payout-invoices HTTP/1.0
{
"data":{
"type":"payout-invoice",
"attributes":{
"service":"payment_card_usd",
"commerce_account":"Hello_World",
"currency":"USD",
"amount":213,
"reference_id":"6813c1ec-faa1-47d7-848d-d9b445d7be98",
"context":{
"card":{
"card_holder":"John Smith",
"exp_year":"30",
"exp_month":"01"
}
},
"customer":{
"reference_id":"5f90a4f1-6f4d-4979-b31d-e6858d497f22",
"firstName":"John",
"lastName": "Smith",
"date_of_birth": "2001-12-03",
"email":"[email protected]",
"phone":"357111111111",
"address":{
"fullAddress": "7, Sunny street",
"city": "Limassol",
"country": "CY",
"post_code": "4141",
"region": "CA"
}
},
"test_mode":true,
"fields":{
"card_number":"400000******0002"
},
"options":{
"attempts_limit":0,
"split_mode":false,
"allow_partially":false,
"auto_process":false
}
}
}
}
Minimum data set to create a transaction¶
SALE
POST /api/commerce/payment-invoices HTTP/1.1
{
"data": {
"type": "payment-invoice",
"attributes": {
"service": "payment_card_usd_hpp",
"commerce_account": "Hello world",
"currency": "USD",
"amount": 123,
"reference_id": "dad88b67-e331-4986-a2db-85f69033f105",
"flow": "charge",
"gateway_options": {
"cardgate": {
"tokenize": ""
}
},
"customer": {
"reference_id": "88d2d919-08f9-4cd4-8fae-4c0c63534a2b",
"email": "[email protected]"
},
"test_mode": true,
"options": {
"allow_partially": false
},
"service_fields": []
}
}
}
PAYOUT
POST /api/commerce/payout-invoices HTTP/1.0
{
"data":{
"type":"payout-invoice",
"attributes":{
"service":"payment_card_usd",
"commerce_account":"Hello_World",
"currency":"USD",
"amount":321,
"reference_id":"306e6a37-f33c-4f8f-8da1-ebe5e1dac53c",
"context":{
"card":{
"card_holder":"John Smith",
"exp_year":"30",
"exp_month":"01"
}
},
"customer":{
"reference_id":"da81dd81-2cb5-4298-81c7-775569e8ea76",
},
"test_mode":true,
"fields":{
"card_number":"400000******0002"
},
"options":{
"attempts_limit":0,
"split_mode":false,
"allow_partially":false,
"auto_process":false
}
}
}
}
Additional information¶
Constants¶
If some parameters are not sent in the transaction creation request, they will take the values from the set constants.
Here is a list of constants with their corresponding parameters:
- FIRST_NAME → customer [first_name]
- LAST_NAME → customer [last_name]
- EMAIL → customer [email]
- PHONE → customer [phone]
- DATE_OF_BIRTH → customer [date_of_birth]
- CITIZENSHIP_COUNTRY_CODE → customer [address] [country]
- FULL_ADDRESS → customer [address] [fullAddress]
- CITY → customer [address] [city]
- COUNTRY_CODE → customer [address] [country]
- POSTAL_CODE → customer[address][post_code]
- STATE → customer [address] [region]
Provider Options¶
- finalize_by_protocol
- The provider does not guarantee the finality of the fail status because in their system it can later change to success and if the merchant does not agree with this logic then there is no need to enable this option.
- Then we (Corefy) will stop failing payments but the merchant will not receive transaction status discrepancies.
- If a merchant wants to fail decline which the provider does not guarantee then you need to enable this option.
- The provider does not guarantee the finality of the fail status because in their system it can later change to success and if the merchant does not agree with this logic then there is no need to enable this option.
Question
"Still looking for help connecting your PayMaxis account?"