Request and Response Parameters

Field

Type

Maximum width

Description

Mandatory

acquirerId

Numeric

4

Acquirer code provided by Pay-me

Yes

idCommerce

Numeric

4

Unique merchant code provided by Pay-me. Fixed value.

Yes

purchaseOperationNumber

Numeric

6

Unique identifier for each transaction, generated by the merchant. Please note that all 6 characters must be sent.

Yes

purchaseAmount

Numeric

10

Total value of the purchase. (4)

Yes

purchaseCurrencyCode

Numeric

3

Currency according to ISO numerical standard. Consider the currencies enabled by Pay-me.

Soles: 604

Dollars: 840

Yes

language

Alphanumeric

2

Language used: English (EN), Spanish (SP).

(Default value Spanish)

Yes

billingFirstName

Alphanumeric

30

Cardholder's name (as it appears on the credit card) (1).

No

billingLastName

Alphanumeric

50

Cardholder's last name (as it appears on the credit card) (1).

No

billingEmail

Alphanumeric

50

Cardholder's e-mail address. (1).

No

billingAddress

Alphanumeric

50

Cardholder's address. (1).

No

billingZIP

Alphanumeric

10

Cardholder's zip code.

No

billingCity

Alphanumeric

50

Cardholder's city. (1).

No

billingState

Alphanumeric

2

First 2 characters of the cardholder's State, Department or Locality.

No

billingCountry

Alphanumeric

2

ISO code of the cardholder's country (1).

No

billingPhone

Alphanumeric

15

Cardholder's telephone number.

No

shippingFirstName

Alphanumeric

30

Name of the person who will receive the goods.

Yes

shippingLastName

Alphanumeric

50

Last name of the person who will receive the goods.

Yes

shippingEmail

Alphanumeric

50

Email of the person who will receive the goods.

Yes

shippingAddress

Alphanumeric

50

Address of the person who will receive the goods.

Yes

shippingZIP

Alphanumeric

10

Postal Code of the delivery.

Yes

shippingCity

Alphanumeric

50

Name of the city of delivery.

Yes

shippingState

Alphanumeric

15

Name of state/region or department of delivery.

Yes

shippingCountry

Alphanumeric

2

ISO code of the country of delivery.

Yes

shippingPhone

Alphanumeric

15

Telephone number of the place of delivery.

No

shippingDNI

Alphanumeric

10

DNI of the person receiving the goods.

No

HTTPSessionId

Alphanumeric

30

HTTP session only in case the business requires it.

No

terminalCode

Alphanumeric

12

Purchase terminal code

No

userCommerce

Alphanumeric

20

User code of the cardholder at the merchant. In Wallet the parameter is codCardHolderCommerce (3).

Yes

userCodePayme

Alphanumeric

30

Wallet association code for the user. In Wallet the parameter is codAsoCardHolderWallet. (3)

Yes

descriptionProducts

Alphanumeric

30

Description of the product or service purchased by the cardholder.(1)

Yes

programmingLanguage

Alphanumeric

15

Stipulates the programming language used by Commerce. Example: JAVA, PHP, VB.NET, PYTHON, RUBY, etc.

Yes

purchaseVerification

Alphanumeric

(Length not fixed)

Digital signature of the payment request frame. It contains the encrypted value of the fields acquirerId, idCommerce, purchaseOperationNumber, purchaseAmount, purchaseCurrencyCode and the SHA-2 key for the gateway downloaded from the V-Payment system.(PASSWORD_COM_XXXX_PASARELA_XXXXXXXXXXXX.txt).

Yes

reserved1 – reserved21

Alphanumeric

30

Fields for additional data not contemplated in V-POS2. (2)

No

reserved24 – reserved40

Alphanumeric

30

Fields for additional data not contemplated in V-POS2. (2)

No

Campo

Tipo

Ancho máximo

Descripción

authorizationResult

Numeric

2

This field contains the result of the authorization. It has three possible values sent by the V-POS:

00: indicates that the transaction has been authorized.

01: indicates that the transaction has been denied at the Issuing Bank.

05: indicates that the transaction has been rejected by V-POS.

IMPORTANT NOTE: The merchant will display the result messages to the cardholder according to these three codes. For example:

"Operation Authorized".
"Operation Denied".
"Operation Rejected".

authorizationCode

Alphanumeric

6

In case the transaction has been authorized by the Issuing Bank, this field will contain the authorization code of the transaction.

errorCode

Alphanumeric

4

In case the transaction has been denied or rejected this field will contain the respective error code indicating the reason for the rejection. The list of codes is dynamic and may increase or decrease according to improvements made to V-POS and/or new specifications from brands and processors.

This response code should not be displayed to the cardholder.

Review the return code table.

errorMessage

Alphanumeric

-

This field will contain the description of the error code in case of a rejection.

IMPORTANT NOTE: This error message should not be displayed to the cardholder. The Acquirer can arrange with the merchant to have groups of messages displayed.

answerCode

Alphanumeric

-

Response code of the processor with which the payment was made.

answerMessage

Alphanumeric

-

Response message describing the value of the answerCode field.

bin

Alphanumeric

6

This field contains the first 6 numbers of the payment card, it is only sent in case this value is obtained.

brand

Alphanumeric

12

This field contains the description of the brand, the following values can be given: VISA, MC, AMEX or DN.

paymentReferenceCode

Alphanumeric

-

In case the purchase was made with any brand of card, the masked card number will be returned (example: 414243******1234). For other means, the respective code will be returned.

purchaseVerification

Alphanumeric

(Longitud no fija)

Signature generated using the SHA-2 encryption algorithm based on the following parameters: acquirerId, idCommerce, purchaseOperationNumber, purchaseAmount, purchaseCurrencyCode, authorizationResult and the SHA-2 key for the gateway downloaded from the V-Payment system (PASSWORD_COM_XXXXXX_PASARELA_XXXXXXXXXXXXXXXXXXXXXX.txt), which will be used for data validation in the response process.

reserved1 – reserved21

Alphanumeric

30

Fields for additional data not checked by V-POS2.

reserved22

Alphanumeric

30

This field returns the type of card: DEBIT or CREDIT (the content is optional and subject to availability of information).

reserved23

Alphanumeric

30

This field returns the name of the Issuing Bank of the Card used in the transaction (the content is optional and subject to availability of the information).

reserved24 - reserved40

Alphanumeric

30

Fields for additional data not checked by V-POS2.

IDTransaction

Alphanumeric

28

Transaction ID generated by Pay-me for identification by the retailer of the order placed for traceability purposes.

txDateTime

Alphanumeric

19

This field returns the date and time of registration of the transaction with the format: DD/MM/YYYYYY HHMMSS: where DD is day, MM is month, YYYYY is year, HH indicates time in 24 hours, MM minutes and SS seconds format.