Access By API

Before you begin processing with Addon Payments Pay By Link, set up your Addon Payment test account. It requires the following account and credentials.

• API credentials: client_id and client_secret
  • Remember that these credentials requires Pay By Link authorities.
  • For more information, go to API Authentication
• Configure available Payment Solutions, Products, countries and currencies.

Then, you could start using Pay By Link.

To start using the integration, You need API credentials with the proper permissions, you will be provided with credentials by an Addon Payment staff member during boarding.

Follow API Authentication for more information.

Make a POST to /pay-by-link request passing off the following details:

• Merchant Id: Addon Payments’ Merchant identifier
• Product Id: Addon Payments’ Product identifier
• MerchantTransactionId: Merchant transaction identifier.
• Amount: Payment’s amount
• Currency: Payment’s currency in ISO-2. List of available currencies
• Country: Payment’s country in ISO-3. List of available countries

you could also add some other optional fields, which enrich the Pay By Link Hosted cashier page.

• Customer Id: Customer identifier on your platform.
• Due Date: Pay By Link due date.
• Description: Payment’s description.
• Language: Payment’s hosted cashier language.
• ReferenceId: Payment’s reference identifier.
• MerchantParams: List of merchants parameters (key, value).

Below example, you could see how you could create a Addon Payments Pay By Link for a test shopper.

  curl --location --request POST 'https://api.easypaymentgateway.com/invoice-service/pay-by-link' \
    --header 'Authorization: Bearer YOUR_OATH2_TOKEN' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "merchantId": "YOUR_MERCHANT_ID",
        "merchantTransactionId": "YOUR_MERCHANT_TRANSACTION_ID",
        "productId": "YOUR_PRODUCT_ID",
        "country": "ES",
        "currency": "EUR",
        "amount": 25.55,
        "description": "Pay By Link description",
        "language": "ES",
        "customerId": "YOUR_CUSTOMER_ID"
    }'

You receive a response containing the following details:

• id: Pay By Link identifier
• url: Pay By Link url, where the customer could pay
• dueDate: Date and time when the Pay By Link is expired. By Default is 1 month.

{
      "id": "60dc27beccbab61bb8d07a7c",
      "merchantId": "YOUR_MERCHANT_ID",
      "merchantTransactionId": "YOUR_MERCHANT_TRANSACTION_ID",
      "status": "CREATED",
      "description": "Pay By Link description",
      "dueDate": "2022-08-25T22:10:30.000Z",,
      "productId": "YOUR_PRODUCT_ID",
      "currency": "EUR",
      "language": "ES",
      "amount": 25.55,
      "url": "https://invoice.epgpay.com/U5BR"
  }

Getting the previoues response, you could send the url field to your customer.

Sending the url, it allows to the customer to access to Addon Payments Hosted cashier, where the customer could see the available Payment Solutions for this Pay By Link.

Note: Pay By Link uses the amount and the currency that is sent in the Pay By Link create request.

To get Pay By Link details, you could perform a GET /pay-by-link/{id} request, returning the Pay By Link details.

curl --location --request GET 'https://api.easypaymentgateway.com/invoice-service/pay-by-link/{id}' \
    --header 'Merchant-Id: YOUR_MERCHANT_ID' \
    --header 'Authorization: Bearer YOUR_OATH2_TOKEN'

Below you could see an example of paid Pay By Link, where it contains the merchantTransactionId, amount and status.

{
      "id": "60dc27beccbab61bb8d07a7c",
      "referenceId": "98123",
      "merchantId": "YOUR_MERCHANT_ID",
      "merchantTransactionId": "YOUR_MERCHANT_TRANSACTION_ID",
      "status": "PAID",
      "description": "Pay By Link description",
      "dueDate": "2022-08-25T22:10:30.000Z",,
      "productId": "YOUR_PRODUCT_ID",
      "currency": "EUR",
      "language": "ES",
      "amount": 25.55,
      "url": "https://invoice.epgpay.com/U5BR"
  }

There are some use cases, where the merchant wants to cancel a Pay By Link before the payment is completed or the payment is expired.

The merchant could perform a PATCH /pay-by-link/{id} request, passing of the CANCELLED status.

curl --location --request PATCH 'https://api.easypaymentgateway.com/invoice-service/pay-by-link/{id}' \
  --header 'Authorization: Bearer YOUR_OATH2_TOKEN'
  --header 'Content-Type: application/json' \
  --data-raw '{
    `status`:'CANCELLED'
  }'

The response will contain a new status value