Additional features

Introduction

In this section you will find different Host2Host operations that will allow you to perform certain actions, such as viewing the status of a transaction, a customer’s details, etc.

Check status

This section contains the request to check the status of transactions. A transaction that is no more than 2 years old can be consulted.

Below, you have the endpoints to send the check status transactions to:

RequestEnvironmentURL
Transaction statusStaginghttps://checkout-stg.addonpayments.com/EPGCheckout/rest/status/merchantcall/repeat
Transaction statusProductionhttps://checkout.addonpayments.com/EPGCheckout/rest/status/merchantcall/repeat

Transaction status

This request asks for the status message returned in a previous transaction.

This is an example request to check the status of a transaction:

				
					https://checkout-stg.addonpayments.com/EPGCheckout/rest/status/merchantcall/repeat?token={token}&merchantId
={merchantId}&transactions={transactions}=postback={postback}&url={url}

These are required/mandatory (R) and optional (O) parameters in the transaction status request.

FieldFormatTypeDescriptionExample
merchantIdWhole number
4~7 digits		RYour merchant’s ID on the AP platform. Provided by Support in the welcome email. It is the same for both environments14983
tokenAnyRMD5 hash of the following pattern:
{merchantId}.{merchant_transaction_ids}.{merchant_password}		f2768df5cf6574ac5f0c13a71103e984
transactionsAlphanumericRList of the ids of the merchant’s transactions to be consulted.
Separated by “;”. Correspond to the identifier of the merchant, that is, the “merchantTransactionId”.		12345;12346;12347
postbackBoolean
– 0
– 1		O
Resends the transaction status to the original statusURL. For example, in cases where due to high transaction volume, you would not receive all notifications.
– 0 not to send it
– 1 to send it		1
url AlphanumericO New Status URL where Addon Payments will send the transaction status notification.https://new.url/status

Check status by date

In this section is the operation that allows you to consult the status of the transaction by date. Some things to keep in mind about this operation:

  • These queries must be made for a maximum of 30 days (inclusive).
  • In the test environment, we can query at most for the past month. For example, if we are on March 12, we can query from February 1.
  • In the production environment, we can query a maximum of 2 months. For example, if we are on March 12, we can query from January 1.

These are the endpoints to consult the transaction status by date:

RequestEnvironmentURL
Transaction status by dateStaginghttps://checkout-stg.addonpayments.com/EPGCheckout/rest/status/statusByDate
Transaction status by dateProductionhttps://checkout.addonpayments.com/EPGCheckout/rest/status/statusByDate

Transaction status by date

This request asks for the status message returned on transactions on the dates specified.

This is an example request to check the status of a transaction by date:

				
					https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/statusByDate?merchantId={merchantId}&encrypted
={encrypted}&integrityCheck={integrityCheck}

Before encrypting the parameters, you must concatenate them as in the following example:
{"merchantId":"21577","from":"2020/08/01 23:59:59", "to":"2020/08/07 23:59:59"}

These are the required/mandatory (R) parameters in the transaction status by date. Remember that they must be concatenated, encrypted and included in the “encryption” field:

FieldFormatTypeDescriptionExample
merchantIdWhole number
4~7 digits		RYour merchant’s ID on the AP platform. Provided by Support in the welcome email. It is the same for both environments14983
fromYYYY/MM/dd HH:mm:ssRDate from which you want to collect transactions.
Year, month, day, hour, minute and second are included.		2020/08/01 23:59:59
toYYYY/MM/dd HH:mm:ssRDate up to which you want to collect transactions.
Year, month, day, hour, minute and second are included.		2020/08/07 23:59:59

In addition to these encrypted parameters within the “encrypted”, you must send the “merchantId” and the “integrityCheck”. More details in the encryption document.

Check customer data

In this section you can find the operations used to obtain customer data. There are twho types of operation that obtain different customer details:

  • Customer details
  • Customer summary

Below are the endpoints used for this type of operation:

RequestEnviromentURL
Customer detailsStaginghttps://checkout-stg.addonpayments.com/EPGCheckout/rest/online/customer
Customer detailsProductionhttps://checkout.addonpayments.com/EPGCheckout/rest/online/customer
Customer summaryStaginghttps://checkout-stg.addonpayments.com/EPGCheckout/rest/online/customerSummary
Customer summaryProductionhttps://checkout.addonpayments.com/EPGCheckout/rest/online/customerSummary

Customer details

This request informs you about the accounts of different payment solutions that a customer has previously used and stored.

This is an example request to check the customer details:

				
					customerId=000001&paymentSolution=creditcards
				
			
				
					curl --location --request POST 'https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/customer' \
--header 'Apiversion: 5' \
--header 'Encryptionmode: CBC' \
--header 'iv: AcynMwxxskW4c7+mHtwtfw==' \
--form 'merchantId="12345"' \
--form 'encrypted="YhkE2nrG1vmWRxNnMxWtbqDHsi/+FQs2AfPJBBHwIYOG3JCagem6DSb+R+63D5+NT/FQzI0Agb69XWtT8WJ9qAdyNFHE6Hn+Hya57tJy2vABHzY718FIygsQXguzOX71j02MBW57Dh299/0sAvv6I9XFOxL7VnnLQsqr1YhPR+Zri9HZdlhZFMaXdKDWIoo0vyp5nKInCV2Gx3wpnmXsctM6/fV4fGEhKCnpIyLy8BT+GSx0f5TkdmwPAccU0m1OdFQy+c/w+ZxdLvB+MePPnAp6Q/ieTrW0tNFOz1Sz1xwJbHygF4CVBFJB5kZsJyQABpgj2hjbhYqMJ4PhjIH6unGEEgxMWjqX7VebSsmn/C1uzwvOFum7/Ykrwh2V1mcIldXBWTlwqIUmuR8ltCNLszWTXQKv+LKvVLjXZhKV4JUnubrfgP/SAoL1Sr5IpvfGKf0V8m7WUl6M5+LjrBTmZ9ZP2QFr2AZ3Dbn+bxcIVPaGGyg2kBBcOfx1ylrhg53nG2evwuAborzvFSQO3IslRCtBAuJVaSzRavzdNBtZXjzS2D5hF1TUlut+p3/9WUaInomL4o17lyYZds2eQ48hNGO8O8EmnDzTfveqZUASpII=”' \
--form 'integrityCheck="06c928531469eb314c609e9a565567afecae69e644ba0e8cc49c612b6bf35e83"'

The string parameters are the data prior to encryption and sending. They must go through the encryption process and be included in the sending of the request (cURL) as “encrypted”.

The required (R) and optional (O) parameters to obtain customer details are:

FieldFormatTypeDescriptionExample
customerIdAlphanumeric
Max 80 characters		RCustomer ID in your e-commerce platform.A34623
paymentSolutionAlphanumeric
Max 45 characters		OName of the payment solution to process the transaction.creditcards

Customer summary

This request informs you about the details of the transaction the customer has made through Addon Payments.

This is an example of a request to check the customer’s summary:

				
					customerId=000001&paymentSolution=creditcards
				
			
				
					curl --location --request POST 'https://checkout-stg.addonpayments.com/EPGCheckout/rest/online/customerSummary' \
--header 'Apiversion: 5' \
--header 'Encryptionmode: CBC' \
--header 'iv: AcynMwxxskW4c7+mHtwtfw==' \
--form 'merchantId="12345"' \
--form 'encrypted="YhkE2nrG1vmWRxNnMxWtbqDHsi/+FQs2AfPJBBHwIYOG3JCagem6DSb+R+63D5+NT/FQzI0Agb69XWtT8WJ9qAdyNFHE6Hn+Hya57tJy2vABHzY718FIygsQXguzOX71j02MBW57Dh299/0sAvv6I9XFOxL7VnnLQsqr1YhPR+Zri9HZdlhZFMaXdKDWIoo0vyp5nKInCV2Gx3wpnmXsctM6/fV4fGEhKCnpIyLy8BT+GSx0f5TkdmwPAccU0m1OdFQy+c/w+ZxdLvB+MePPnAp6Q/ieTrW0tNFOz1Sz1xwJbHygF4CVBFJB5kZsJyQABpgj2hjbhYqMJ4PhjIH6unGEEgxMWjqX7VebSsmn/C1uzwvOFum7/Ykrwh2V1mcIldXBWTlwqIUmuR8ltCNLszWTXQKv+LKvVLjXZhKV4JUnubrfgP/SAoL1Sr5IpvfGKf0V8m7WUl6M5+LjrBTmZ9ZP2QFr2AZ3Dbn+bxcIVPaGGyg2kBBcOfx1ylrhg53nG2evwuAborzvFSQO3IslRCtBAuJVaSzRavzdNBtZXjzS2D5hF1TUlut+p3/9WUaInomL4o17lyYZds2eQ48hNGO8O8EmnDzTfveqZUASpII=”' \
--form 'integrityCheck="06c928531469eb314c609e9a565567afecae69e644ba0e8cc49c612b6bf35e83"'

The string parameters are the data prior to encryption and sending. They must go through the encryption process and be included in the sending of the request (cURL) as “encrypted”.

The required (R) and optional (O) parameters to obtain the customer’s summary are:

FieldFormatTypeDescriptionExample
customerIdAlphanumeric
Max 80 characters		RCustomer ID in your e-commerce platform.A34623
paymentSolutionAlphanumeric
Max 45 characters		OName of the payment solution to process the transaction.creditcards

Card blocking and unblocking

In this section you will find the operations used to block and unblock cards in Addon Payments by means of their token (identifier that replaces the card data). There are two types of operations:

  • Token blocking
  • Token unblocking

Below, you have the endpoints to send these card blocking/unblocking operations to:

RequestFieldURL
Token blockingStaginghttps://api-stg.addonpayments.com/rest/card/block
Token blockingProductionhttps://api.addonpayments.com/rest/card/block
Unblocking tokenStaginghttps://api-stg.addonpayments.com/rest/card/unblock
Unblocking tokenProductionhttps://api.addonpayments.com/rest/card/unblock

Token blocking

This request blocks the cad number associated with the token sent.

This is an example request for token blocking:

				
					customerId=000001&cardNumberToken=4535954006730084
				
			
				
					curl --location --request POST 'https://api-stg.addonpayments.com/rest/card/block' \
--header 'Apiversion: 5' \
--header 'Encryptionmode: CBC' \
--header 'iv: AcynMwxxskW4c7+mHtwtfw==' \
--form 'merchantId="12345"' \
--form 'encrypted="YhkE2nrG1vmWRxNnMxWtbqDHsi/+FQs2AfPJBBHwIYOG3JCagem6DSb+R+63D5+NT/FQzI0Agb69XWtT8WJ9qAdyNFHE6Hn+Hya57tJy2vABHzY718FIygsQXguzOX71j02MBW57Dh299/0sAvv6I9XFOxL7VnnLQsqr1YhPR+Zri9HZdlhZFMaXdKDWIoo0vyp5nKInCV2Gx3wpnmXsctM6/fV4fGEhKCnpIyLy8BT+GSx0f5TkdmwPAccU0m1OdFQy+c/w+ZxdLvB+MePPnAp6Q/ieTrW0tNFOz1Sz1xwJbHygF4CVBFJB5kZsJyQABpgj2hjbhYqMJ4PhjIH6unGEEgxMWjqX7VebSsmn/C1uzwvOFum7/Ykrwh2V1mcIldXBWTlwqIUmuR8ltCNLszWTXQKv+LKvVLjXZhKV4JUnubrfgP/SAoL1Sr5IpvfGKf0V8m7WUl6M5+LjrBTmZ9ZP2QFr2AZ3Dbn+bxcIVPaGGyg2kBBcOfx1ylrhg53nG2evwuAborzvFSQO3IslRCtBAuJVaSzRavzdNBtZXjzS2D5hF1TUlut+p3/9WUaInomL4o17lyYZds2eQ48hNGO8O8EmnDzTfveqZUASpII=”' \
--form 'integrityCheck="06c928531469eb314c609e9a565567afecae69e644ba0e8cc49c612b6bf35e83"'

The string parameters are the data prior to encryption and sending. They must go through the encryption process and be included in the sending of the request (cURL) as “encrypted”.

The required parameters (R) for token blocking are:

FieldFormatTypeDescriptionExample
customerIdAlphanumeric
Max. 80 characters		RID of the customer in your merchant platform from whom you want to block/unblock the card.A34623
cardNumberTokenAlphanumeric
16~20 characters		RAddon Payments token of the card number you want to block/unblock. The last 4 digits coincide with the original card number.4535954006730084

Note: The response returns a code 200 (successfully blocked/unblocked) even if the card token does not exist. Returns a 400 error if any of the required parameters have not been sent.

Token unblocking

This request unblocks the card number associated to the token sent.

This is an example request to unblock the token:

				
					customerId=000001&cardNumberToken=4535954006730084
				
			
				
					curl --location --request POST 'https://api-stg.addonpayments.com/rest/card/unblock' \
--header 'Apiversion: 5' \
--header 'Encryptionmode: CBC' \
--header 'iv: AcynMwxxskW4c7+mHtwtfw==' \
--form 'merchantId="12345"' \
--form 'encrypted="YhkE2nrG1vmWRxNnMxWtbqDHsi/+FQs2AfPJBBHwIYOG3JCagem6DSb+R+63D5+NT/FQzI0Agb69XWtT8WJ9qAdyNFHE6Hn+Hya57tJy2vABHzY718FIygsQXguzOX71j02MBW57Dh299/0sAvv6I9XFOxL7VnnLQsqr1YhPR+Zri9HZdlhZFMaXdKDWIoo0vyp5nKInCV2Gx3wpnmXsctM6/fV4fGEhKCnpIyLy8BT+GSx0f5TkdmwPAccU0m1OdFQy+c/w+ZxdLvB+MePPnAp6Q/ieTrW0tNFOz1Sz1xwJbHygF4CVBFJB5kZsJyQABpgj2hjbhYqMJ4PhjIH6unGEEgxMWjqX7VebSsmn/C1uzwvOFum7/Ykrwh2V1mcIldXBWTlwqIUmuR8ltCNLszWTXQKv+LKvVLjXZhKV4JUnubrfgP/SAoL1Sr5IpvfGKf0V8m7WUl6M5+LjrBTmZ9ZP2QFr2AZ3Dbn+bxcIVPaGGyg2kBBcOfx1ylrhg53nG2evwuAborzvFSQO3IslRCtBAuJVaSzRavzdNBtZXjzS2D5hF1TUlut+p3/9WUaInomL4o17lyYZds2eQ48hNGO8O8EmnDzTfveqZUASpII=”' \
--form 'integrityCheck="06c928531469eb314c609e9a565567afecae69e644ba0e8cc49c612b6bf35e83"'

The string parameters are the data prior to encryption and sending. They must go through the encryption process and be included in the sending of the request (cURL) as “encrypted”.

The required parameters (R) for token unlocking are:

FieldFormatTypeDescriptionExample
customerIdAlphanumeric
Max. 80 characters		RID of the customer in your merchant platform from whom you want to block/unblock the card.A34623
cardNumberTokenAlphanumeric
16~20 characters		RAddon Payments token of the card number you want to block/unblock. The last 4 digits coincide with the original card number.4535954006730084

Note:The response returns a code 200 (successfully blocked/unblocked) even if the card token does not exist. Returns a 400 error if any of the required parameters have not been sent.

Get cashier information

In this section you will be able to find the operations used to get information from the cashier, such as: available payment solutions, currencies, etc. The operation available for this is:

  • Express cashier

Below you have a table with the endpoints to send express cashier operations to:

RequestEnviromentURL
Express cashierStaginghttps://checkout-stg.addonpayments.com/EPGCheckout/rest/online/expressCheckoutV2
Express cashierProductionhttps://checkout.addonpayments.com/EPGCheckout/rest/online/expressCheckoutV2

Express cashier

The express cashier request allows you to know the payment solutions available to you according to your country and currency. In addition, it allows you to know the limit of the amount of each payment solution. In the answer to the request, you will have a list of the available payment solutions.

TTL (time to live) cache is 10 minutes. Addon Payments updates the configuration every 10 minutes, we recommend to cache the request and clear it every 10 minutes.

Below is an example of a request to check the express cashier:

				
					merchantId=12345&currency=EUR&country=ES&operationType=debit&productId=12345000
				
			
				
					curl --location --request POST 'https://checkout-stg.addonpayments.com/EPGCheckout/rest/expressCheckoutV2' \
--header 'Apiversion: 5' \
--header 'Encryptionmode: CBC' \
--header 'iv: AcynMwxxskW4c7+mHtwtfw==' \
--form 'merchantId="12345"' \
--form 'encrypted="YhkE2nrG1vmWRxNnMxWtbqDHsi/+FQs2AfPJBBHwIYOG3JCagem6DSb+R+63D5+NT/FQzI0Agb69XWtT8WJ9qAdyNFHE6Hn+Hya57tJy2vABHzY718FIygsQXguzOX71j02MBW57Dh299/0sAvv6I9XFOxL7VnnLQsqr1YhPR+Zri9HZdlhZFMaXdKDWIoo0vyp5nKInCV2Gx3wpnmXsctM6/fV4fGEhKCnpIyLy8BT+GSx0f5TkdmwPAccU0m1OdFQy+c/w+ZxdLvB+MePPnAp6Q/ieTrW0tNFOz1Sz1xwJbHygF4CVBFJB5kZsJyQABpgj2hjbhYqMJ4PhjIH6unGEEgxMWjqX7VebSsmn/C1uzwvOFum7/Ykrwh2V1mcIldXBWTlwqIUmuR8ltCNLszWTXQKv+LKvVLjXZhKV4JUnubrfgP/SAoL1Sr5IpvfGKf0V8m7WUl6M5+LjrBTmZ9ZP2QFr2AZ3Dbn+bxcIVPaGGyg2kBBcOfx1ylrhg53nG2evwuAborzvFSQO3IslRCtBAuJVaSzRavzdNBtZXjzS2D5hF1TUlut+p3/9WUaInomL4o17lyYZds2eQ48hNGO8O8EmnDzTfveqZUASpII=”' \
--form 'integrityCheck="06c928531469eb314c609e9a565567afecae69e644ba0e8cc49c612b6bf35e83"'

The string parameters are the data prior to encryption and sending. They must go through the encryption process and be included in the sending of the request (cURL) as “encrypted”.

The required parameters (R) for the express cashier are:

FieldFormatTypeDescriptionExample
merchantIdWhole number
4~7 digits		RYour merchant’s ID on the AP platform. Provided by Support in the welcome email. It is the same for both environments14983
operationTypeAlphanumeric
Max 45 characters		RShows type of operation to carry out. Eligible values:
– debit (default): Payment transaction. That is, cash travels from the customer’s account to the merchant.
– credit: Deposit transaction to the customer’s account. That is, cash travels from the merchant to the customer’s account. For example, in the payment of a prize. Not to be confused with returns. These have their own type of transaction.		debit
productIdWhole number
6~11 digits		RProduct ID created on your AP merchant. You’ll find it in the welcome email.149830
currencyAlphabetical
3 characters
ISO-4217.3		RCurrency of the transactionEUR
Currency codes
countryAlphabetical
2 characters
ISO 3166-1 alfa-2		RCountry from which the transaction is sentES
States and country codes

visto recientemente

Comparte este documento
Tabla de Contenidos

Consulta la documentación de las distintas secciones de integraciones:

Comienza a integrar

undraw_add_to_cart_re_wrdo 1 (1) (1)

Plugins para CMS

Complementa la integración

SDKs

Métodos de pago

Herramientas

Addon Payments

Consulta la documentación de Addon Payments. Aquí tienes las distintas secciones:

Integraciones

Consultas frecuentes

Portal Backoffice

Cyberpac

We are currently working on the English version of the Cyberpac documentation. You can view the Spanish version using the buttons below:

Canales BackOffice Portal

Plugins integration

Custom integrations

POS integrated Payments

Create a solution that will help you automate processes. You can even add payment processes on physical terminals.

Payment Integrated with Android POS

Payment Integrated with Smartphone POS

POS Data sheets

Addon Payments

Comercia Global Payments has several integration options so you can choose the most efficient one for you.

Integrations

Frequently Asked Questions

BackOffice Portal

Consult the documentation of the different integrations sections:​

Start integration

undraw_add_to_cart_re_wrdo 1 (1) (1)

CMS Plugins

Complement your integration

SDKs

Payment Methods

Tools