# Common object definitions

# payment

# id string

Identifier of the payment resource created.
# reference_id string

In case of referenced payment (e.g., Capture or Refund), this fields included to see which payment was referenced.
# state string

The state of the payment, authorization, or order transaction. The value is:
- Authorised. The transaction was successfully authorised.
- Pending. The transaction is currently pending.
- Captured. The transaction has been captured.
- Refunded. The transaction has been refunded.
- Declined. The transaction has been declined.
- Expired. The transaction has been expired.
- Cancelled. The transaction has been cancelled.
- Voided. The transaction has been voided.
- Timeout. The transaction has been timeout.
- Deferred Refund. The transaction refund has been deferred.
- Flagged. The transaction has been flagged.
- Deferred Capture. The transaction Capture has been deferred.
- Card Verified. The card has been verified.
# result object

Contain result of the payment request
# intent string

The payment intent. Value is:
- sale. Makes an immediate payment.
- auth. Authorizes a payment for capture later
Allowed values: sale, auth.
# payer object

Source of the funds for this payment represented by a direct credit card.
# payee object

A resource representing a Payee who receives the funds and fulfills the order.
# transaction object

Transactional details including the amount and item details.
# custom object

Free-form field for the use of clients
# create_time datetime

Payment creation time as defined in RFC 3339 Section 5.6.
# three_d object

ThreeD Secure details pertaining to the transaction
# capture_delay decimal

The payment will be captured after the number of hours that you specify,

If Value is not specified and intent is Auth, then the transaction should be captured manually. If Value is specified and equal to 0 and intent is AUTH, then the transaction is captured after the default period of 7 days. If Value is specified and intent is AUTH, then the transaction is captured after the specified number of hours.

Value cannot be > 168 hours (7 days)
# delayed_capture_time datetime

Payment capture time in case the capture is delayed. (as defined in RFC 3339 Section 5.6.
# metadata ArrayOf(KeyValuePair(string, string))

contains additional information about the transaction
# merchant_initiated bool

Flags the payment as a merchant-initiated transaction (MIT).
# previous_payment_id string

For payments that use stored card details, such as subscription payments - an existing payment identifier from the subscription series.
# previous_scheme_transaction_id string

Previous Scheme Transaction Id as returned by the scheme. In merchant initiated transaction this will help to reference the initial payment. (Used only if the referenced payment is not done using our payment platform)
# one_dollar_retry bool

Indicates whether we retry with 1 dollar if a $0 authorization fails.
# subscription_plans ArrayOf(subscription_plan)

List of subscription plans to associate with this payer (currently only one accepted)
# subscriptions ArrayOf(subscription)

Output the subscription/s created

# result

# code string

Code identifying the result on our system
# message string

Message related to the code
# description string

Long description of the code identifying the result on our system
# authorisation_code string

Authorisation code:

When the payment is authorised successfully, this field holds the authorisation code for the payment. When the payment is not authorised, this field is empty.

Example: 58747
# cascaded string

Indicates whether the transaction has cascaded to another acquirer
# risk_check string

Indicate whether risk checks was enabled and performed
# redirect_url string

When the payment flow requires a redirect, this contains information about the redirect URL.
# actions ArrayOf(action)

List of actions performed by the payment transaction and its corresponding results.

# action

# code string

Code identifying the result on our system
# message string

Message related to the code
# description string

Long description of the code identifying the result on our system
# action string

The name of the action performed by the payment transaction to obtain the corresponding result
# id string

Identifier of the payment resource created corresponding to the action performed.
# state string

State of the payment action performed. The value is:
- Authorised. The transaction was successfully authorised.
- Pending. The transaction is currently pending.
- Captured. The transaction has been captured.
- Refunded. The transaction has been refunded.
- Declined. The transaction has been declined.
- Expired. The transaction has been expired.
- Cancelled. The transaction has been cancelled.
- Voided. The transaction has been voided.
- Timeout. The transaction has been timeout.
- Deferred Refund. The transaction refund has been deferred.
- Flagged. The transaction has been flagged.
- Deferred Capture. The transaction Capture has been deferred.
- Card Verified. The card has been verified.

# Payer

# payment_type enum

Payment type being used. Value is:
- CC : Credit card
# payer_info object

Information related to the Payer.
# funding_instrument object

Funding instrument to be used to fund the payment. The object must include either a credit_card or credit_card_token or credit_card_nonce object. If the array contains more than one instrument, the payment is declined.

# payer_info

# id string

Encrypted Payer ID.
# email string

Email address representing the payer. 127 characters max.
# ip string

IP Address of the payer
# name string

Full Name of the payer
# birth_date string

Birth date of the Payer in ISO8601 format (yyyy-mm-dd).
# billing_address object

Birth date of the Payer in ISO8601 format (yyyy-mm-dd).

# billing_address

# line1 string

The first line of the address. For example, number, street, and so on.

Maximum length: 100.
# line2 string

The second line of the address. For example, suite or apartment number.

Maximum length: 100.
# city string

The city name.

Maximum length: 64.
# country_code string

two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is GB and not UK as used in the top- level domain names for that country.

Minimum length: 2.

Maximum length: 2.

Pattern: ^([A-Z]{2}|C2)$.
# postal_code string

The postal code, which is the zip code or equivalent.
# state string

2 letter code for US states, and the equivalent for other countries.
# phone object

Information related phone number.

# phone

# country_code string

Country code (from in E.164 format)
# number string

In-country phone number (from in E.164 format). Maximum length is 25 characters.

# funding_instrument

Only one of the object described below is required:

# credit_card object

The credit card details. You can use this instrument to fund a payment.
# credit_card_nonce object

The tokenized credit card details. You can use this instrument to fund only one payment .
# credit_card_token object

The tokenized credit card details. You can use this instrument to fund a payment.
# credit_cards arrayOf(credit_card)

Array containing credit cards associated to the payer. The first one in the list is the default one.

# credit_card

# id string

ID of the credit card being saved for later use.
# number string

The credit card number. Value is numeric characters only with no spaces or punctuation. Must conform to the modulo and length required by each credit card type.
# expire_month integer

The expiration month with no leading zero. Value is from 1 to 12.
# expire_year integer

The four-digit expiration year.
# cvv2 string

The three- to four-digit card validation code.
# name string

The card holder's name as displayed on the card.
# stored bool

Indicate the origin of the card details on a full card API Call. Default : false This must be set to true for payments that use store card details (usually if you have a merchant which is PCI Compliant and they are sending you the full card details and the origin of these card details is On File)
# type string

Credit card type. Valid types are: visa, mastercard, discover, amex, UPI, JCB
# state string

State of the credit card funding instrument.
# cvv_check string

Raw CVV result received from the acquirer, where available
# avs_check string

The AVS result code of the payment, which provides information about the outcome of the AVS check.
# last4 string

Last 4 digit of a credit card number
# bin string

The Bank Identification Number of a credit card, which is the first six digits of a card number.
# is_default bool

Indicate if the card is the default one associated to a Payer.
# fingerprint string

A string containing the credit card fingerprint.
# bin_data object

Bin data corresponding to the credit card

# bin_data

# bin string

one time use tokenized credit card details
# country_code string

Issuing bank country code
# country_name string

Issuing bank country name
# bank_name string

Issuing bank name
# card_scheme string

Credit card scheme
# card_type string

Type of the card, DEBIT, CREDIT
# card_category string

Category of the card

# credit_card_nonce

# nonce string

one time use tokenized credit card details
# name string

The card holder's name as displayed on the card.

# credit_card_token

# credit_card_id string

ID of credit card previously stored.
# cvv2 string

3-4 digit card validation code. In case of card token the cvv is not stored in the DB but we does not omit the case where the merchant provide it to us.

# payee

# email string

Email Address associated with the Payee's Account.
# merchant_id string

Encrypted Merchant account identifier for the Payee.

# transaction

# amount object

The amount to collect.
# type string

Describe the transaction type. Possible value:
- 1 : Regular
- 2 : Subscription
- 3 : MOTO
Defaulted to 1 (regular) if not provided
# modestring

Describe the transaction mode. Possible value:
- 1 : Non 3D
- 2 : 3D
Defaulted to 1 (regular) if not provided
# attempt_non_3d bool

Describe if the 3Ds fails, we attempt the transaction without 3Ds.
# description string

Description of what is being paid for.
# items array(item)

List of items being paid for.
# shipping_address object

The shipping address.
# shipping_method string

Shipping method used for this payment like USPSParcel etc.
# return_url string

URL to send payment notifications(Maximum length: 2048.)
# cancel_url string

Url to send payer incase payment is denied.
# invoice_number string

invoice number to track this payment (Maximum length: 50.)
# soft_descriptor object

Dynamic Soft descriptor used when charging this funding source.

# amount

# currency string

The three-character ISO-4217 currency code.
# total string

The total amount charged to the payee by the payer. Maximum length is 10 characters, which includes:
- Seven digits before the decimal point.
- The decimal point.
- Two digits after the decimal point.

# shipping_address

# recipient_name string

Name of the recipient at this address.
# line1 string

The first line of the address. For example, number, street, and so on.

Maximum length: 100.
# line2 string

The second line of the address. For example, suite or apartment number.

Maximum length: 100.
# city string

The city name.

Maximum length: 64.
# country_code string

two-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top- level domain names for that country.

Minimum length: 2.

Maximum length: 2.

Pattern: ^([A-Z]{2}|C2)$.
# postal_code string

The postal code, which is the zip code or equivalent.
# state string

2 letter code for US states, and the equivalent for other countries.
# phone object

Information related phone number.

# soft_descriptor

# text string

The soft descriptor text to use to charge this funding source. If greater than the maximum allowed length, the API truncates the string.

Maximum length: 22.

# country string

The soft descriptor country to use to charge this funding source.

two-character ISO 3166-1 code that identifies the country or region.

# item

# sku string

The stock keeping unit (SKU) for the item.
# name string

The item name. If this value is greater than the maximum allowed length, the API truncates the string.
# description string

The item description.
# quantity string

The item quantity. Must be a whole number. Maximum length: 10.

Pattern: ^[0-9]{0,10}$.
# price string

The item cost. Supports two decimal places. Pattern: ^[0-9]{0,10}(\.[0-9]{0,2})?$
# shipping string

The shipping cost
# currency string

The three-character ISO-4217 currency code that identifies the currency.
# image string

URI to an image representing the item
# tangible bool

Identifies if the item is a tangible or not
# id string

Unique id

# custom

# field1 string

free-form field for the use of clients. maximum length of 100
# field2 string

free-form field for the use of clients. maximum length of 100
# field3 string

free-form field for the use of clients. maximum length of 100
# field4 string

free-form field for the use of clients. maximum length of 100
# field5 string

free-form field for the use of clients. maximum length of 100
# field6 string

free-form field for the use of clients. maximum length of 100
# field7 string

free-form field for the use of clients. maximum length of 100
# field8 string

free-form field for the use of clients. maximum length of 100
# field9 string

free-form field for the use of clients. maximum length of 100
# field10 string

free-form field for the use of clients. maximum length of 100

# three_d

# enabled string

Whether to process this payment as a 3D Secure payment
# enrolled string

3DS: whether the card was enrolled or not.

Y - Issuer enrolled N - Customer not enrolled U - Unknown
# authenticated string

authenticationStatus 3DS:The authentication status for the 3D secure request. Required when using a third-party MPI.

Indicates whether or not the cardholder was authenticated

Y - Customer authenticated N - Customer not authenticated A - An authentication attempt occurred but could not be completed U - Unable to perform authenticationK
# eci string

3DS: Defines the E-Commerce Indicator security level associated with the transaction. The Electronic Commerce Indicator security level associated with the 3D Secure enrollment result. Required if using a third-party merchant plug-in (MPI)
# cryptogram string

3DS: Cryptographic identifier used by the card schemes to validate the integrity of the 3D secure transaction data. A Base64 encoded cryptographic identifier (CAVV) used by the card schemes to validate the cardholder authentication result (3D Secure). Required if using an external MPI
# xid string

3DS: Unique identifier for the transaction assigned by the MPI. The 3D Secure transaction identifier. Required if using an external MPI with 3D Secure 2.X.X and a Mastercard card, or with 3D Secure 1.X.X for any supported card scheme
# version string

Indicates the version of 3D Secure that was used for authentication. Defaults to 1.0.0 if not provided
# ds_transactionid string

Transaction ID assigned by the directory server. Used when the transaction was already authenticated via 3D Secure version 2, using an external MPI.
# challenge_indicator string

Indicates whether a challenge is requested for this transaction. Can be sent when 3D Secure version 2.2 or higher is used.

# subscription_plan

# id string

Masked PlanId
# start_date string

Forecasted timestamp of the first transaction generated by the subscription plan in "YYYY-MM-DD" format. If start_date is not specified, the next billing date will be calculated based on the current date and subscription cycle. If start_date is specified, it should always be greater than the current date by at least one day (irrespective of the time component).

# subscription

# id string

Masked PlanId
# name string

Name of the subscription plan Max. 100 chars.
# track_id string

Unique identifier allowing the merchant to track the payment Max. 50 chars.
# capture_delay decimal

The payment will be captured after the number of hours that you specify,

If Value is not specified and intent is Auth, then the transaction should be captured manually. If Value is specified and equal to 0 and intent is AUTH, then the transaction is captured after the default period of 7 days. If Value is specified and intent is AUTH, then the transaction is captured after the specified number of hours.

Value cannot be > 168 hours (7 days)
# currency string

The three-character ISO-4217 currency code that identifies the currency.
# amount decimal

The total amount charged to the payee by the payer. Maximum length is 10 characters, which includes:
- Seven digits before the decimal point.
- The decimal point.
- Two digits after the decimal point.
# cycle string

Composed of 2 part, last character is the billing cycle, and the integer infront indicates number of billing cycle length Billing Cycle:
```
Nd --> N number of days   (allowed value: 1 - 730)
Nw --> N number of weeks  (allowed value: 1 - 104)
Nm --> N number of months (allowed value: 1 - 24)
Ny --> N number of years  (allowed value: 1 - 2)
```
example 2w: This represent that the next billing will be 2 weeks after the initial one. Max. 4 chars.
# number_of_cycle int

Subscription count, number of repetition of the above cycle
# notification int

Indicate the notification plan used for this subscription method
```
1 --> None
2 --> Pre
3 --> Post
4 --> Both
```

# status `int`

status of the subscription plan

1 --> FailedInitial
2 --> Active
3 --> Cancelled
4 --> InArrears
5 --> Suspended
6 --> Completed
7 --> AutoSuspended

# max_retry_count int

Maximum number of tries before failing a transaction. Default value is 7.
# start_date string

Forecasted timestamp of the first transaction generated by the subscription plan in "YYYY-MM-DD" format. If start_date is not specified, the next billing date will be calculated based on the current date and subscription cycle. If start_date is specified, it should always be greater than the current date by at least one day (irrespective of the time component).
# subscription_id string

Masked id identifying the subscription
# card_id string

Credit card token used for this subscription
# payer_id string

Masked payer id used for this subscription
# number_of_cycle_remaining string

Indicate the number of cycle remaining to complete the subscription plan
# collection_count int

Number of transaction to be performed for this subscription process
# collection_amount string

Successful Amount collected throughout the subscription process
# previous_billing_date string

Previous billing date
# next_billing_date string

Next billing date

← Parse IPN Messages Result Codes →

# Common object definitions

# payment

# id string

# reference_id string

# state string

# result object

# intent string

# payer object

# payee object

# transaction object

# custom object

# create_time datetime

# three_d object

# capture_delay decimal

# delayed_capture_time datetime

# metadata ArrayOf(KeyValuePair(string, string))

# merchant_initiated bool

# previous_payment_id string

# previous_scheme_transaction_id string

# one_dollar_retry bool

# subscription_plans ArrayOf(subscription_plan)

# subscriptions ArrayOf(subscription)

# result

# code string

# message string

# description string

# authorisation_code string

# cascaded string

# risk_check string

# redirect_url string

# actions ArrayOf(action)

# action

# code string

# message string

# description string

# action string

# id string

# state string

# Payer

# payment_type enum

# payer_info object

# funding_instrument object

# payer_info

# id string

# email string

# ip string

# name string

# birth_date string

# billing_address object

# billing_address

# line1 string

# line2 string

# city string

# country_code string

# postal_code string

# state string

# phone object

# phone

# country_code string

# number string

# funding_instrument

# credit_card object

# credit_card_nonce object

# credit_card_token object

# credit_cards arrayOf(credit_card)

# credit_card

# id string

# number string

# expire_month integer

# expire_year integer

# cvv2 string

# name string

# stored bool

# type string

# state string

# cvv_check string

# avs_check string

# last4 string

# bin string

# is_default bool

# id `string`

# reference_id `string`

# state `string`

# result `object`

# intent `string`

# payer `object`

# payee `object`

# transaction `object`

# custom `object`

# create_time `datetime`

# three_d `object`

# capture_delay `decimal`

# delayed_capture_time `datetime`

# metadata `ArrayOf(KeyValuePair(string, string))`

# merchant_initiated `bool`

# previous_payment_id `string`

# previous_scheme_transaction_id `string`

# one_dollar_retry `bool`

# subscription_plans `ArrayOf(subscription_plan)`

# subscriptions `ArrayOf(subscription)`

# code `string`

# message `string`

# description `string`

# authorisation_code `string`

# cascaded `string`

# risk_check `string`

# redirect_url `string`

# actions `ArrayOf(action)`

# code `string`

# message `string`

# description `string`

# action `string`

# id `string`

# state `string`

# payment_type `enum`

# payer_info `object`

# funding_instrument `object`

# id `string`

# email `string`

# ip `string`

# name `string`

# birth_date `string`

# billing_address `object`

# line1 `string`

# line2 `string`

# city `string`

# country_code `string`

# postal_code `string`

# state `string`

# phone `object`

# country_code `string`

# number `string`

# credit_card `object`

# credit_card_nonce `object`

# credit_card_token `object`

# credit_cards `arrayOf(credit_card)`

# id `string`

# number `string`

# expire_month `integer`

# expire_year `integer`

# cvv2 `string`

# name `string`

# stored `bool`

# type `string`

# state `string`

# cvv_check `string`

# avs_check `string`

# last4 `string`

# bin `string`

# is_default `bool`

# fingerprint `string`

# bin_data `object`

# bin `string`

# country_code `string`

# country_name `string`

# bank_name `string`

# card_scheme `string`

# card_type `string`

# card_category `string`

# nonce `string`