Authorize PayIn with eCommerce Card
The function of this service is to allow an Authorization, both with Token and by sending the Card data.
If you wish to authorize with a token, you must first Create Card Token. Otherwise it can be authorized by sending the Card data from Example 3.
Ambiente | EndPoint | Método |
Desarrollo | POST | |
Producción | POST |
Headers
Cabecera | Valor | Requerido |
Content-Type | application/json | SI |
Authorization | Bearer <Access_Token> | SI |
"Content-Type":"application/json",
"Authorization":"Bearer yJhbGciOiJSUzI1NsInR5cCI6IkpXVCIsImt………",
Request
Parámetro | Tipo | Long. | Descripción | Req. |
action | Cadena (AN) | - | La intención del comercio. En este caso es "authorize" | SI |
channel | Cadena (N) | 3 | El canal del cual proviene la petición. En este caso: 1 = eCommerce (“Card” o “Token + CVV”) 3 = Card on File (solo “Token”) | SI |
payment_method.token.id | Cadena (AN) | 25 | El identificador del token que se quiere utilizar. No es obligatorio en caso se envié el objeto “Card” | SI |
payment_method.token.security_code | Cadena (AN) | 4 | Código de seguridad de la tarjeta asociada al Token. Solo es Obligatorio en caso que Channel sea 1. | - |
payment_method.card.pan | Cadena (N) | 20 | Numero de la tarjeta. No es obligatorio en caso se envié el objeto “Token”. | - |
payment_method.card.expiry_date | Cadena (N) | 4 | Fecha de expiración de la tarjeta, en formato MMYY. No es obligatorio en caso se envié el objeto “Token”. | - |
payment_method.card.security_code | Cadena (N) | 4 | Código de seguridad de la tarjeta. En caso que Channel sea 3 enviar 000. No es obligatorio en caso se envié el objeto “Token”. | - |
transaction.currency | Cadena (AN) | 3 | Código numérico de moneda en formato ISO 4217 | SI |
transaction.amount | Cadena (N) | 15 | Monto de la transacción en centavos de moneda, tomando en cuenta que consideramos las 5 últimas posiciones como la parte decimal del monto. | SI |
transaction.meta.internal_operation_number | Cadena (N) | 9 | El número de operación interno del cliente. Este puede ser el número de pedido u otro que considere el cliente como importante. | SI |
transaction.meta.description | Cadena (AN) | 50 | Descripción de la transacción. | NO |
transaction.meta.additional_fields | Cadena (AN) | - | En este objeto se insertan campos que el cliente crea importantes. Estos campos son determinados y configurados por el cliente. | NO |
transaction.meta.additional_fields.plan | Cadena (N) | 5 | Valor correspondiente al plan. | NO |
transaction.meta.additional_fields.cuota | Cadena (N) | 5 | Valor correspondiente a la cuota | NO |
Cadena (AN) | 50 | El id de un objeto dirección previamente retornado. Se genera un nuevo id de dirección a cada vez que se genera una nueva dirección. | NO | |
address.shipping.first_name | Cadena (AN) | 50 | El nombre asociado a la dirección | NO |
address.shipping.last_name | Cadena (AN) | 50 | El apellido asociado a la dirección | NO |
address.shipping.email | Cadena (AN) | 60 | El correo electrónico asociado a la dirección | NO |
address.shipping.phone.country_code | Cadena (AN) | 5 | El código de país asociado al número de teléfono de la dirección | NO |
address.shipping.phone.subscriber | Cadena (AN) | 20 | El número de teléfono asociado a la dirección | NO |
address.shipping.location.line_1 | Cadena (AN) | 50 | La parte principal de la dirección, asociado a la dirección | NO |
address.shipping.location.line_2 | Cadena (AN) | 50 | El complemento de información de la dirección, asociado a la dirección | NO |
address.shipping.location.city | Cadena (AN) | 30 | La ciudad asociada a la dirección | NO |
address.shipping.location.state | Cadena (AN) | 30 | El estado asociado a la dirección | NO |
address.shipping.location.country | Cadena (AN) | 2 | El código ISO 3166-1 alfa-2 de país asociado a la dirección | NO |
address.shipping.location.zip_code | Cadena (AN) | 10 | El código postal asociado a la dirección | NO |
Cadena (AN) | 50 | El id de un objeto dirección previamente retornado. Se genera un nuevo id de dirección a cada vez que se genera una nueva dirección. | NO | |
address.billing.first_name | Cadena (AN) | 50 | El nombre asociado a la dirección | SI |
address.billing.last_name | Cadena (AN) | 50 | El apellido asociado a la dirección | SI |
address.billing.email | Cadena (AN) | 60 | El correo electrónico asociado a la dirección | SI |
address.billing.phone.country_code | Cadena (AN) | 5 | El código de país asociado al número de teléfono de la dirección | SI |
address.billing.phone.subscriber | Cadena (AN) | 20 | El número de teléfono asociado a la dirección | SI |
address.billing.location.line_1 | Cadena (AN) | 50 | La parte principal de la dirección, asociado a la dirección | SI |
address.billing.location.line_2 | Cadena (AN) | 50 | El complemento de información de la dirección, asociado a la dirección | SI |
address.billing.location.city | Cadena (AN) | 30 | La ciudad asociada a la dirección | SI |
address.billing.location.state | Cadena (AN) | 30 | El estado asociado a la dirección | SI |
address.billing.location.country | Cadena (AN) | 2 | El código ISO 3166-1 alfa-2 de país asociado a la dirección | SI |
address.billing.location.zip_code | Cadena (AN) | 10 | El código postal asociado a la dirección | SI |
card_holder.first_name | Cadena (AN) | 50 | Nombre del tarjetahabiente | Si |
card_holder.last_name | Cadena (AN) | 50 | Apellido del tarjetahabiente | Si |
card_holder.email_address | Cadena (AN) | 60 | Correo del tarjetahabiente | Si |
card_holder.identity_document_country | Cadena (AN) | 50 | País del documento de identidad del tarjetahabiente | Si |
card_holder.identity_document_type | Cadena (AN) | 30 | Tipo de documento de identidad del tarjetahabiente | Si |
card_holder.identity_document_identifier | Cadena (AN) | 20 | Numero de documento de identidad del tarjetahabiente | Si |
1️⃣ Ejemplo: Autorización con Channel 3 enviando solo Token (Card on File)
{
"action": "authorize",
"channel": "3",
"payment_method": {
"token": [ { "id": "822a-748e-3z9h-0051" } ]
},
"transaction": {
"currency": "604",
"amount": "1000000",
"meta": {
"internal_operation_number": "123456",
"description": "Descripcion de la transaccion",
"additional_fields": {
"reserved1": "Ejemplo valor reservado 1",
"2": "Ejemplo valor reservado 2",
"plan": "00",
"cuota": "005"
}
}
},
"address": {
"billing": {
"first_name": "Juan Diego",
"last_name": "Perez Sanchez",
"email": "juan.perez@gmail.com",
"phone": { "country_code": "51", "subscriber": "987654321" },
"location": {
"line_1": "Mi casa",
"line_2": "Mi casa",
"city": "LIMA",
"state": "LIMA",
"country": "PE",
"zip_code": "18"
}
}
},
"card_holder": [
{
"first_name": "Juan Diego",
"last_name": "Perez Sanchez",
"email_address": "juan.perez@email.com",
"identity_document_country": "PER",
"identity_document_type": "DNI",
"identity_document_identifier": "87654321"
}
]
}
2️⃣ Ejemplo: Autorización con Channel 1 enviando Token más CVV (eCommerce)
{
"action":"authorize",
"channel":"1",
"payment_method":{
"token":[
{
"id":"822a-748e-3z9h-0051",
"security_code":"123"
}
]
},
"transaction":{
"currency":"604",
"amount":"1000000",
"meta":{
"internal_operation_number":"123456",
"description":"Descripcion de la transaccion"
}
},
"address":{
"billing":{
"first_name":"Juan Diego",
"last_name":"Perez Sanchez",
"email":"juan.perez@gmail.com",
"phone":{ "country_code":"51", "subscriber":"987654321" },
"location":{
"line_1":"Mi casa",
"line_2":"Mi casa",
"city":"LIMA",
"state":"LIMA",
"country":"PE",
"zip_code":"18"
}
}
},
"card_holder":[
{
"first_name":"Juan Diego",
"last_name":"Perez Sanchez",
"email_address":"juan.perez@email.com",
"identity_document_country":"PER",
"identity_document_type":"DNI",
"identity_document_identifier":"87654321"
}
]
}
3️⃣ Ejemplo: Autorización con Channel 1 enviando datos de la Tarjeta (eCommerce)
{
"action":"authorize",
"channel":"1",
"payment_method":{
"card":[ {
"pan":"4859510000000051",
"expiry_date":"1220",
"security_code":"365"
} ]
},
"transaction":{
"currency":"604",
"amount":"1000000",
"meta":{
"internal_operation_number":"123456",
"description":"Descripcion de la transaccion",
"additional_fields":{
"reserved1":"Ejemplo valor reservado 1",
"2":"Ejemplo valor reservado 2",
"plan":"00",
"cuota":"005"
}
}
},
"address":{
"billing":{
"first_name":"Juan Diego",
"last_name":"Perez Sanchez",
"email":"juan.perez@gmail.com",
"phone":{ "country_code":"51", "subscriber":"987654321" },
"location":{
"line_1":"Mi casa",
"line_2":"Mi casa",
"city":"LIMA",
"state":"LIMA",
"country":"PE",
"zip_code":"18"
}
}
},
"card_holder":[
{
"first_name":"Juan Diego",
"last_name":"Perez Sanchez",
"email_address":"juan.perez@email.com",
"identity_document_country":"PER",
"identity_document_type":"DNI",
"identity_document_identifier":"87654321"
}
Response
Parámetro | Descripción |
action | Proceso realizado, en este caso es " authorize " |
id | Transaction identifier assigned by AlignProcess performed, in this case it is " authorize ".et. |
success | True in case the request is successful or False otherwise. |
transaction.currency | Numeric currency code in ISO 4217 format |
transaction.amount | Amount of the transaction in cents of currency, taking into account that we consider the last 5 positions as the decimal part of the amount. |
transaction.meta.internal_operation_number | The customer's internal transaction number. This can be the order number or another number that the customer considers important. |
transaction.meta.description | Description of the transaction. |
transaction.meta.processor.authorization.code | Processor authorization code |
transaction.meta.additional_fields | This object returns the fields defined by the customer. These fields are determined and configured by the customer. |
transaction.meta.status.code | Code associated with the operation status |
transaction.meta.status.message_ilgn.locale | Locale on which the message is written. |
transaction.meta.status.message_ilgn.value | Value of the textual message |
validations | This object returns the results of the validations performed. |
{
"action": "authorize",
"id": "500114",
"success": "true",
"transaction": {
"currency": "604",
"amount": "1000000",
"meta": {
"internal_operation_number": "500114",
"description": "Descripcion de la transaccion",
"processor": {
"authorization": {
"code": "191046"
}
},
"additional_fields": {
"2": "Ejemplo valor reservado 2",
"reserved1": "Ejemplo valor reservado 1"
},
"status": {
"code": "00",
"message_ilgn": [
{
"locale": "es_PE",
"value": "Operacion Autorizada"
}
]
}
}
},
"validations": null,
"token": null
}