Attributes

• METHOD TYPECash Payment
• PAYMENTS
• PAYOUTS
• REFUNDS
• RECURRING

Introduction

The EasyPay APM is available in Bulgaria for making secure and fast transactions, such as money transfers, payments, and online shopping. The service provides a quick and easy solution for accepting payments from customers via the Internet and cash registers (kiosks).

Supported Countries

• Bulgaria

Supported Currencies

• BGN

Payment (Deposit) Flow

Press tab to open…

{
  "sessionToken": "<sessionToken from /getSessionToken>",
  "merchantId": "<your merchantId>",
  "merchantSiteId": "<your merchantSiteId>",
  "clientRequestId": "<unique request ID in merchant system>",
  "amount": "200",
  "currency": "BGN",
  "userTokenId": "<unique customer identifier in merchant system>",
  "clientUniqueId": "<unique transaction ID in merchant system>",
  "paymentOption": {
    "alternativePaymentMethod": {
      "paymentMethod": "apmgw_EasyPay"
    }
  },
  "deviceDetails": {
    "ipAddress": "<customer's IP address>"
  },
  "billingAddress": {
    "firstName": "John",
    "lastName": "Smith",
    "country": "BG",
    "email": "[email protected]"
  },
  "userDetails": {
    "firstName": "John",
    "lastName": "Smith",
    "country": "BG",
    "email": "[email protected]"
  },
  "timeStamp": "<YYYYMMDDHHmmss>",
  "checksum": "<calculated checksum>"
}

{
  "internalRequestId": 42134551,
  "status": "SUCCESS",
  "errCode": 0,
  "reason": "",
  "merchantId": "5634436935940029474",
  "merchantSiteId": "242181",
  "version": "1.0",
  "sessionToken": "2e4a8f3f-1a6e-40b5-9440-3f5fc87584a8",
  "orderId": "43352981",
  "userTokenId": "Testy2",
  "paymentOption": {
    "redirectUrl": "https://apmtest.gate2shop.com/ppp/resources/cdn/v1/payment-details-170994.html?amount=234.00&currency=BGN&locale=bg_BG&reference=3888600354",
    "userPaymentOptionId": "2153235521",
    "card": {}
  },
  "transactionStatus": "REDIRECT"
}

sfc.createPayment({
  sessionToken: "<sessiontoken>",
  paymentOption: {
    alternativePaymentMethod: {
      paymentMethod: "apmgw_EasyPay",
    }
  },
  deviceDetails: {
    ipAddress: "<customer's IP address>"
  },
  billingAddress: {
    firstName: "John",
    lastName: "Smith",
    country: "BG",
    email: "[email protected]"
  },
  userDetails: {
    firstName: "John",
    lastName: "Smith",
    country: "BG",
    email: "[email protected]"
  },
}, function(res) {
  console.log(res);
});

Example Payment DMN with Status=APPROVED

...'ppp_status=OK&Status=APPROVED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=43353081&userid=Testy_CheckoutSDK_20240709123947&merchant_unique_id=sdf234wdsf&customData=&productId=&first_name=John&last_name=Smith&email=john.smith%40email.com&currency=BGN&clientUniqueId=sdf234wdsf&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=123+test&address2=&country=Bulgaria&state=&city=Sitee&zip=12345&phone1=%2B359996560264&phone2=&phone3=&client_ip=79.112.13.88&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=EasyPayMS-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=BG&shippingState=&shippingCity=iasi&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=242181&merchant_status=&action=&requestVersion=&message=APPROVED&merchantLocale=&unknownParameters=&payment_method=apmgw_EasyPay&ID=&merchant_id=5634436935940029474&responseTimeStamp=2024-07-09.09%3A42%3A13&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=&cardCompany=&eci=&user_token_id=Testy_CheckoutSDK_20240709123947&userPaymentOptionId=&TransactionID=2610000000000040049&APMReferenceID=ADB0C615F5E4B08233BAD7B32B865E51&orderTransactionId=24682791&totalAmount=300.00&dynamicDescriptor=static+test&item_name_1=NA&item_number_1=&item_amount_1=300.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&externalToken_blockedCard=&externalToken_cardAcquirerId=&externalToken_cardAcquirerName=&externalToken_cardBin=&externalToken_cardBrandId=&externalToken_cardBrandName=&externalToken_cardExpiration=&externalToken_cardLength=&externalToken_cardMask=&externalToken_cardName=&externalToken_cardTypeId=&externalToken_cardTypeName=&externalToken_clubName=&externalToken_creditCompanyId=&externalToken_creditCompanyName=&externalToken_extendedCardType=&externalToken_Indication=&externalToken_tokenValue=&externalToken_tokenProvider=&ECIRaw=&cryptogram=&maskedNetworkTokenNumber=&type=DEPOSIT&clientRequestId=&relatedTransactionId=&apmPayerInfo=%5B%5D&sessionId=6de8b4661cd8df4ecdd8a88ffb45&responsechecksum=e87b313b3aca8de850ba5fa35121ab16&advanceResponseChecksum=7622eff6de06083a8c1b9e791d658e0d',

Example Payment DMN with Status=DECLINED

...'ppp_status=FAIL&Status=DECLINED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=43351931&userid=Testy_CheckoutSDK_20240709100940&merchant_unique_id=sdf234wdsf&customData=&productId=&first_name=John&last_name=Smith&email=john.smith%40email.com&currency=BGN&clientUniqueId=sdf234wdsf&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=123+test&address2=&country=Bulgaria&state=&city=Sitee&zip=12345&phone1=%2B359996560264&phone2=&phone3=&client_ip=79.112.13.88&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=EasyPayMS-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=BG&shippingState=&shippingCity=iasi&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=242181&merchant_status=&action=&requestVersion=&message=DECLINED&merchantLocale=&unknownParameters=&payment_method=apmgw_EeasyPay_bg&ID=&merchant_id=5634436935940029474&responseTimeStamp=2024-07-09.07%3A10%3A04&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=&cardCompany=&eci=&user_token_id=Testy_CheckoutSDK_20240709100940&userPaymentOptionId=&TransactionID=2610000000000040001&APMReferenceID=FBE76E0973522272E0529D31FEF0A6C3&orderTransactionId=24682131&totalAmount=300.00&dynamicDescriptor=static+test&item_name_1=NA&item_number_1=&item_amount_1=300.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&externalToken_blockedCard=&externalToken_cardAcquirerId=&externalToken_cardAcquirerName=&externalToken_cardBin=&externalToken_cardBrandId=&externalToken_cardBrandName=&externalToken_cardExpiration=&externalToken_cardLength=&externalToken_cardMask=&externalToken_cardName=&externalToken_cardTypeId=&externalToken_cardTypeName=&externalToken_clubName=&externalToken_creditCompanyId=&externalToken_creditCompanyName=&externalToken_extendedCardType=&externalToken_Indication=&externalToken_tokenValue=&externalToken_tokenProvider=&ECIRaw=&cryptogram=&maskedNetworkTokenNumber=&type=DEPOSIT&clientRequestId=&relatedTransactionId=&apmPayerInfo=%5B%5D&sessionId=653c7f4a02d7bec86451a45088ff&responsechecksum=525a7682673703bab14e70fcb985d8b6&advanceResponseChecksum=d877173068edd02e1927c75ca6389d15',

Payout (Withdrawal) Flow

Send a /payout request and include the userPaymentOptionId, which contains the user’s previously stored APM account details. Press here for an example.

After the transaction is processed, Nuvei sends a DMN that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /payout request.

User Experience

Payment

The user is redirected to a page with a payment code and instructions for completing the payment.

Testing

Test credentials and testing scenarios can be provided by Nuvei if necessary. You can contact Nuvei support for assistance.