PurchaseRequest

A unique reference number for the transaction.

The transaction date and time in UTC format.

Contains the user's billing-related details (cardholder information) for Address Verification System (AVS) processing and for populating records at the payment gateway. This object is optional; passing null or omitting it maintains backward compatibility. This object is request-only and is not returned in API responses.

Validation & Error Handling

If any field inside billingAddress fails its length or format validation rules (for example, an invalid email format in billingEmailId or a string that exceeds the specified character limit), the API rejects the request before contacting the gateway.

• HTTP Status: 422 Unprocessable Entity
• Behavior: The transaction is aborted before the payment processor is contacted.

Gateway Processing & Data Security

Gateway Forwarding

• Aurus Gateway: Full support. Forwards billingAddress data to Aurus for AVS checks.
• Other Payment Gateways: Gracefully ignore billingAddress without returning an error.

Data Privacy & Log Masking

• Masked PII: billingFirstName, billingLastName, billingEmailId, and billingMobileNumber are redacted or masked in stored application and audit logs.
• Unmasked Address Information: billingAddressLine1, billingAddressLine2, billingCity, billingState, billingCountry, and billingZip remain visible in logs to facilitate AVS decline analysis.

The invoice number associated with the transaction.

Indicates whether this saved card should be set as the user's preferred payment method.

A temporary, single-use token generated to securely represent the credit card used for the purchase. This token is exchanged for a reusable paymentMethodToken that can be used for future transactions. Required if paymentMethodToken is not provided.

A reusable token generated from a one time token (oneTimeToken), representing a saved credit card for recurring payments.

Gets or sets a value indicating whether the user's card information should be saved for future use.

The transaction date and time in local format.

The unique identifier of the user in your system for whom the card is being saved. Required when saveCard is true.

Identifies the wallet provider. Example values GooglePay, ApplePay