Authorize Transaction

Environment

EndPoint

Method

Development

https://api.dev.alignet.io/charges

POST

Production

https://api.alignet.io/charges

POST

Header

Value

Required

Content-Type

application/json

Yes

ALG-API-VERSION

API version to be used. Available values: 1618440906

Yes 

Authorization

Bearer <Access_Token>

Yes

Parameter

Type

Long.

Description

Req.

action

String

(AN)

-

The intent of the merchant. In this case it is "authorize".

Yes

channel

String

(N)

3

The channel from which the request originates. In this case:

1 = eCommerce (“Card” or “Token + CVV”)

3 = Card on File (only “Token”)

Yes

payment_method.token.id

String

(AN)

25

The identifier of the token to be used.

It is not required if "Card" object is sent.

Yes

payment_method.token.security_code

String

(AN)

4

Security code of the card associated to the Token.

It is only required if Channel is 1.

-

payment_method.card.pan

String

(N)

20

Card number.

It is not required if "Token" object is sent.

-

payment_method.card.expiry_date

String

(N)

4

Card expiration date, in MMYY format.

It is not required if "Token" object is sent.

-

payment_method.card.security_code

String

(N)

4

Card security code. In case Channel is 3 send 000.

It is not required if "Token" object is sent..

-

transaction.currency

String

(AN)

3

Numeric currency code in ISO 4217 format

Yes

transaction.amount

String

(N)

15

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.

Yes

transaction.meta.internal_operation_number

String

(N)

9

The customer's internal transaction number. This can be the order number or another number that the customer considers important.

Yes

transaction.meta.description

String

(AN)

50

Description of the transaction.

No

transaction.meta.additional_fields

String

(AN)

-

In this object are inserted fields that the customer believes to be important. These fields are determined and configured by the customer.

No

transaction.meta.additional_fields.plan

String

(N)

5

Value corresponding to the plan.

No

transaction.meta.additional_fields.cuota

String

(N)

5

Value corresponding to the installment.

No

address.shipping.id

String

(AN)

50

The id of a previously returned address object. A new address id is generated each time a new address is generated.

No

address.shipping.first_name

String

(AN)

50

Shipping’s First Name.

No

address.shipping.last_name

String

(AN)

50

Shipping’s Last Name.

No

address.shipping.email

String

(AN)

60

Shipping’s First Email.

No

address.shipping.phone.country_code

String

(AN)

5

Shipping’s Phone Country Code.

No

address.shipping.phone.subscriber

String

(AN)

20

Shipping’s Phone Number.

No

address.shipping.location.line_1

String

(AN)

50

Shipping’s Address Line 1.

No

address.shipping.location.line_2

String

(AN)

50

Shipping’s Address Line 1.

No

address.shipping.location.city

String

(AN)

30

Shipping’s City.

No

address.shipping.location.state

String

(AN)

30

Shipping’s Sate.

No

address.shipping.location.country

String (AN)

2

Shipping’s ISO Country Code.

No

address.shipping.location.zip_code

String

(AN)

10

Shipping’s Zip Code.

No

address.billing.id

String

(AN)

50

The id of a previously returned address object. A new address id is generated each time a new address is generated.

No

address.billing.first_name

String

(AN)

50

Billing’s First Name.

Yes

address.billing.last_name

String

(AN)

50

Billing’s Last Name.

Yes

address.billing.email

String

(AN)

60

Billing’s Email.

Yes

address.billing.phone.country_code

String

(AN)

5

Billing’s Phone Country.

Yes

address.billing.phone.subscriber

String

(AN)

20

Billing’s Phone.

Yes

address.billing.location.line_1

String

(AN)

50

Billing’s Address Line 1.

Yes

address.billing.location.line_2

String

(AN)

50

Billing’s Address Line 2.

Yes

address.billing.location.city

String

(AN)

30

Billing’s City.

Yes

address.billing.location.state

String

(AN)

30

Billing’s State.

Yes

address.billing.location.country

String (AN)

2

Billing’s ISO Country Code.

Yes

address.billing.location.zip_code

String

(AN)

10

Billing’s Zip Code.

Yes

card_holder.first_name

String

(AN)

50

Cardholder's name.

Yes

card_holder.last_name

String

(AN)

50

Cardholder's last name.

Yes

card_holder.email_address

String

(AN)

60

Cardholder's Email.

Yes

card_holder.identity_document_country

String

(AN)

50

Cardholder's ID Country.

Yes

card_holder.identity_document_type

String

(AN)

30

Cardholder's ID Type.

Yes

card_holder.identity_document_identifier

String

(AN)

20

Cardholder's ID Number.

Yes

Parameter

Description

action

Process performed, in this case it is " authorize".

id

Transaction identifier assigned by Pay-me.

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.