AuthTransaction
CaptureTransaction
SaleTransaction
StatusTransaction
VoidTransaction
CardTokenization
Requests are directives that take the required data from the models and convert it into a proper request that our system can interpret. An example of this would be converting an order with multiple items included to the proper JSON format.
For security reasons, there is a limit of requests per minute per IP address. Once this limit is reached, the client must wait some time before it can continue generating requests.
The Requests section includes the necessary methods to create different transaction types:
SaleTransaction
: Creates the request to carry out a direct sale.AuthTransaction
: Creates the request to authorize a sale. Once the sale is authorized, the merchant can request the capture of the authorized funds through the SDK.CaptureTransaction
: Creates the request to capture the funds from an authorized sale.VoidTransaction
: Creates the request to cancel a sale.StatusTransaction
: Creates the request to obtain the status of a transaction.CardTokenization
: Creates the request to tokenize a credit/debit card.To use PixelPay Services, it is necessary to send the information through requests.
Services that use requests of type AuthTransaction
, CaptureTransaction
, SaleTransaction
, VoidTransaction
can also use the TransactionResult
entity ` .
Services that use requests of type CardTokenization
can also use the CardResult
entity .
AuthTransaction
The AuthTransaction
request is necessary to create transactions where the merchant wants to authorize a payment and then capture it in the future.
Always capture a previously authorized transaction. In case you don't want to capture the transaction, you should do the cancellation.
This type of transaction freezes the funds on the card. The maximum waiting time to make a capture is 15 days.
AuthTransaction
PropertiesProperty Signature | Description |
---|---|
payment_uuid: string |
Payment UUID |
card_token: string |
Tokenized card identifier (format T-* ) |
card_number: string |
Card number or PAN |
card_cvv: string |
Card Security Code |
card_expire: string |
Card expiration date year / month (YYMM) |
card_holder: string |
Cardholder name |
billing_address: string |
Customer billing address |
billing_country: string |
Alpha-2 code of the customer's billing country (ISO 3166-1) |
billing_state: string |
Customer billing statement alpha code (ISO 3166-2) |
billing_city: string |
Customer billing city |
billing_zip: string |
Customer Billing ZIP Code |
billing_phone: string |
Customer Billing Phone |
customer_name: string |
Order customer name |
customer_email: string |
Customer Email |
customer_fingerprint: string |
Client Device Fingerprint Identifier |
order_id: string |
Order ID |
order_currency: string |
Alpha-3 Order Currency Code |
order_amount: string |
Total amount of the order |
order_tax_amount: string |
Total tax amount of the order |
order_shipping_amount: string |
Total amount of order shipment |
order_content: Item[] |
Product or Item Order Summary |
order_extras: object |
Additional properties related to the order |
order_note: string |
Order Note or Additional Instructions |
order_callback: string |
Order Callback Webhook URL |
AuthTransaction
MethodsFunction | Parameters | Return | Access |
---|---|---|---|
setCard |
card: Card |
void |
public |
Associate and map the properties of the card model to the transaction.
Function | Parameters | Return | Access |
---|---|---|---|
setCardToken |
token: string |
void |
public |
Associate and assign tokenized card model properties to the transaction.
Function | Parameters | Return | Access |
---|---|---|---|
setBilling |
billing: Billing |
void |
public |
Associate and assign billing model properties to the transaction.
Function | Parameters | Return | Access |
---|---|---|---|
setOrder |
order: Order |
void |
public |
Associate and assign properties of the order model to the transaction.
Function | Parameters | Return | Access |
---|---|---|---|
withAuthenticationRequest |
void |
public |
Enables the 3DS service in the transaction, only valid for iOS
, Android
and Browser JavaScript
integrations .
It is necessary to enable the 3DS service in the SDK integration, including the statement sale.withAuthenticationRequest() or auth.withAuthenticationRequest() depending on the case. The call for this method must be done on the client side.
CaptureTransaction
CaptureTransaction
request is necessary to create transactions where the merchant wants to capture a payment that has been previously authorized.
CaptureTransaction
PropertiesProperty Signature | Description |
---|---|
payment_uuid: string |
Payment UUID |
transaction_approved_amount: string |
The total quantity to capture, equal to or less than the authorized quantity. |
SaleTransaction
The SaleTransaction
request is necessary for transactions where we want to create a direct sale.
A direct sale is equivalent to the process of an authorization and an immediate capture.
SaleTransaction
PropertiesProperty Signature | Description |
---|---|
payment_uuid: string |
Payment UUID |
card_token: string |
Tokenized card identifier (format T-* ) |
card_number: string |
Card number or PAN |
card_cvv: string |
Card Security Code |
card_expire: string |
Card expiration date year / month (YYMM) |
card_holder: string |
Cardholder name |
billing_address: string |
Customer billing address |
billing_country: string |
Alpha-2 code of the customer's billing country (ISO 3166-1) |
billing_state: string |
Customer billing statement alpha code (ISO 3166-2) |
billing_city: string |
Customer billing city |
billing_zip: string |
Customer Billing ZIP Code |
billing_phone: string |
Customer Billing Phone |
customer_name: string |
Order customer name |
customer_email: string |
Customer Email |
customer_fingerprint: string |
Client Device Fingerprint Identifier |
order_id: string |
Order ID |
order_currency: string |
Alpha-3 Order Currency Code |
order_amount: string |
Total amount of the order |
order_tax_amount: string |
Total tax amount of the order |
order_shipping_amount: string |
Total amount of order shipment |
order_content: Item[] |
Product or Item Order Summary |
order_extras: object |
Additional properties related to the order |
order_note: string |
Order Note or Additional Instructions |
order_callback: string |
Order Callback Webhook URL |
installment_type: string |
Type of installment |
installment_months: string |
Number of financing installment |
SaleTransaction
MethodsFunction | Parameters | Return | Access |
---|---|---|---|
setCard |
card: Card |
void |
public |
Associate and map the properties of the card model to the transaction.
Function | Parameters | Return | Access |
---|---|---|---|
setCardToken |
token: string |
void |
public |
Associate and assign tokenized card model properties to the transaction.
Function | Parameters | Return | Access |
---|---|---|---|
setBilling |
billing: Billing |
void |
public |
Associate and assign billing model properties to the transaction.
Function | Parameters | Return | Access |
---|---|---|---|
setOrder |
order: Order |
void |
public |
Associate and assign properties of the order model to the transaction.
Function | Parameters | Return | Access |
---|---|---|---|
setInstallment |
months: int installment_type: string |
void |
public |
Associate and assign properties of the installment to the transaction.
Function | Parameters | Return | Access |
---|---|---|---|
withAuthenticationRequest |
void |
public |
Enables the 3DS service in the transaction, only valid for iOS
, Android
and Browser JavaScript
integrations .
It is necessary to enable the 3DS service in the SDK integration, including the statement sale.withAuthenticationRequest() or auth.withAuthenticationRequest() depending on the case. The call for this method must be done on the client side.
StatusTransaction
StatusThe StatusTransaction
request is necessary when a merchant wants to get the status of a transaction.
We get the payment UUID from responses as payment_uuid
in transactions of type Auth
, Capture
and Sale
.
StatusTransaction
PropertiesProperty Signature | Description |
---|---|
payment_uuid: string |
Payment UUID |
VoidTransaction
The VoidTransaction
request is necessary in order to void a transaction.
VoidTransaction
PropertiesProperty Signature | Description |
---|---|
payment_uuid: string |
Payment UUID |
void_reason: string |
Reason for order cancellation |
void_signature: string |
Signature of payment cancellation |
CardTokenization
The CardTokenization
request is necessary for card tokenization services.
CardTokenization
PropertiesProperty Signature | Description |
---|---|
number: string |
Card number or PAN |
cvv2: string |
Card Security Code |
expire_month: string |
Card expiration month date (MM) |
expire_year: string |
Card expiration date (YYYY) |
cardholder: string |
Cardholder name |
address: string |
Customer billing address |
country: string |
Alpha-2 code of the customer's billing country (ISO 3166-1) |
state: string |
Customer billing statement alpha code (ISO 3166-2) |
city: string |
Customer billing city |
zip: string |
Customer Billing ZIP Code |
phone: string |
Customer Billing Phone |
email: string |
Customer Email |
CardTokenization
MethodsFunction | Parameters | Return | Access |
---|---|---|---|
setCard |
card: Card |
void |
public |
Associate and map the properties of the card model to the transaction.
Function | Parameters | Return | Access |
---|---|---|---|
setBilling |
billing: Billing |
void |
public |
Associate and assign billing model properties to the transaction.