Documentation/Integration guides

Set up your project

Connect your company, project, payment gateway and checkout page.

Prepare your account

Find the right credentials

Keep the API password, bearer token and HMAC charge key on your server. The registration preview on this website does not provision API access.

Documentation/Integration guides

Authentication

Authenticate server requests and sign charge payloads.

Request a token

Send your API username and password to the token endpoint as JSON. The published response schema is a string.

curl --request POST "https://api.mypay.gr/v2/Token" \
  --header "Content-Type: application/json" \
  --data '{"username":"YOUR_USERNAME","password":"YOUR_PASSWORD"}'

Replace example values and credentials before use.

If your account was created through an external sign-in provider, obtain the API password from Management console Security Api Password.

Send the Authorization header

Authorization: Bearer YOUR_ACCESS_TOKEN

The API defines bearer authentication in the Authorization header. Use HTTPS and keep the token out of browser code and application logs.

Sign charge requests

For POST /v2/Charge, add your server IP under Management console Security ALLOWED IPs. Calculate HMAC-SHA256 over the exact JSON request body using the HMAC CHARGE KEY, and send the lowercase hexadecimal digest in the HMAC header.

$body = json_encode([
    'PaymentToken' => 'YOUR_PAYMENT_TOKEN',
    'Amount' => 55.55,
    'Currency' => 'USD'
]);
$signature = hash_hmac('sha256', $body, getenv('MYPAY_HMAC_CHARGE_KEY'));
// Send this exact $body with the HMAC: $signature header.

Replace example values and credentials before use.

Documentation/Integration guides

MyPay Checkout

Open a MyPay checkout from your website and pass the details of the purchase.

Load Mypay.js

<script src="https://api.mypay.gr/Content/js/v1/mypay.js"></script>

Use the checkout page ID from your project in the MyPay dashboard. Call Mypay.Checkout when the customer chooses to pay.

Mypay.Checkout({
  publicCheckoutPageID: YOUR_CHECKOUT_PAGE_ID
});

Replace example values and credentials before use.

Preselect the product and customer

You can pass a product, quantity and customer token so checkout starts with that information already selected.

Mypay.Checkout({
  'PublicCheckoutPage.ID': YOUR_CHECKOUT_PAGE_ID,
  'CartProducts[0].ID': YOUR_PRODUCT_ID,
  'CartProducts[0].Quantity': YOUR_PRODUCT_QUANTITY,
  'Customer.Token': 'YOUR_CUSTOMER_TOKEN'
});

Replace example values and credentials before use.

Prepare checkout on your server

POST /v2/Checkout/Token accepts a dictionary of checkout parameters. Use its checkout token with the checkoutToken option in Mypay.Checkout.

Checkout options

Payment method identifiers describe the existing library options. They do not guarantee that a method is enabled for your project.

Documentation/Integration guides

Card tokenization

Pass a payment token to your server instead of raw card details.

Set your public key

Mypay.js exchanges customer and card details for a temporary token. Set the public key from Management console Security.

Mypay.SetPublicKey('YOUR_PUBLIC_KEY');

Mypay.CreateToken().done(function (token) {
  // Send the token to your server to continue the payment.
}).fail(function (error) {
  // Show a helpful message and let the customer try again.
});

Replace example values and credentials before use.

Map your form fields

The library reads inputs with data-mypay attributes. The table lists the fields in the published tokenization guide.

Use the token on your server

The existing guide gives temporary tokens a 30-minute lifetime. Complete the server-side API step before expiry. For subsequent charges, retrieve the permanent customer payment token through the charge or customer response.

Documentation/Integration guides

Full API integration

Build your own checkout around MyPay customers, products, charges and invoices.

Build the payment flow

A full API integration uses your own checkout experience. Start with a company, project and gateway, then create the customer and payment method needed for the charge.

Create a customer

These fields are marked required in CustomerDTO. Use the project subdomain configured for your company. The full reference includes shipping details, business information and payment methods.

{
  "Email": "customer@example.com",
  "ProjectSubdomain": "https://YOUR_SUBDOMAIN",
  "FirstName": "Alex",
  "LastName": "Example",
  "BillingAddress1": "1 Example Street",
  "BillingCountry": "GR",
  "BillingZip": "10552"
}

Replace example values and credentials before use.

Connect the charge to your order

ChargeDTO supports MerchantUniqueID for your transaction reference or CustomFields for multiple metadata values. Use one or the other, as specified by the API. Sign the request body using the charge HMAC key.

{
  "PaymentToken": "YOUR_PAYMENT_TOKEN",
  "Amount": 55.55,
  "Currency": "EUR",
  "ProductTitle": "Example order",
  "MerchantUniqueID": "ORDER-1001"
}

Replace example values and credentials before use.

Documentation/Integration guides

Payment notifications

Connect payment events with your order and fulfilment logic.

Read the notification payload

The v2 contract defines TransactionNotification for charge and payment updates. It includes the transaction ID, status, amount, customer data, signature and webhook type.

Event types

The following values are declared by WebhookType in the API contract.

Verify before updating an order

Verify incoming notifications before updating an order. Your implementation should account for signature validation, duplicate delivery and status reconciliation. The final verification instructions will be added here.

Match the notification to the stored order, check amount and currency, and ensure that processing the same event twice cannot fulfil the order twice.

Documentation/Integration guides

Before you go live

Check the complete customer journey and your server-side payment handling.

Your launch checklist

• 01
  Confirm the environment, gateway, credentials and payment methods enabled for your project.
• 02
  Test successful, declined, cancelled and interrupted payment journeys, including 3D Secure when applicable.
• 03
  Verify that the exact transmitted charge body matches the body used to calculate HMAC.
• 04
  Check your order reference, amount and currency against the confirmed transaction.
• 05
  Verify notification authentication and handle duplicate or delayed events.
• 06
  Review checkout on mobile, including keyboard entry and returning from payment.
• 07
  Confirm your PCI scope, activation steps and integration support contact.

Documentation/Payment API v2

Payment API reference

Explore endpoints, request fields and response models.

Base URL

https://api.mypay.gr

All paths below come from the published MyPay Payment API v2 definition. Required fields, types, enum values and response models follow that contract.

Reference by resource

Download the API definition

Download the local Swagger 2.0 JSON for your API tooling. This portal shows documentation and copyable examples; it does not submit payment requests.

Documentation/Payment API v2

Tokens

Documentation/Payment API v2

Checkout

Documentation/Payment API v2

Customers

Documentation/Payment API v2

Products

Documentation/Payment API v2

Charges

Documentation/Payment API v2

Transactions

Documentation/Payment API v2

Invoices

Documentation/Payment API v2

Subscriptions

Documentation/Payment API v2

Vendors

Documentation/Payment API v2

Companies

Documentation/Payment API v2

Projects

Documentation/Payment API v2

Tax

Documentation/Payment API v2

Billable add-ons

Documentation/Payment API v2

Prepaid usage

Documentation/Payment API v2

BillingAddonDTO

Fields

Documentation/Payment API v2

BillableAddonNotificationDTO

Fields

Documentation/Payment API v2

ChargeDTO

Fields

Documentation/Payment API v2

CustomerDTO

Fields

Documentation/Payment API v2

CreditCardDTO

Fields

Documentation/Payment API v2

BankAccountDTO

Fields