API Objects

Customer Object

Field Name	Type	Required	Description
customer_token	string	Yes	Token that uniquely identifies the customer
country	string	No	Customer's country code https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
first_name	string	No	Customer’s first name
last_name	string	No	Customer’s last name
billing_address	Object	No	Object containing the customer's billing address, please refer to Billing address object
avs_alert	int	No	Address verification status. Can be: 0 for Address Verification System pass. 1 for Address Verification System failure.
verification_alert	int	No	Customer verification status (fraud monitor). Can be: 0 if no alert has been detected for the customer. 1 if fraud alert is detected. -1 if review by the merchant is required.

Session Object

Field Name	Type	Required	Description
auth_token	string	Yes	Session authentication token.
intent	string	Yes	Operation intent. Only payment is supported for now.
session_status	string	Yes	Current session status. Can be: Open - customer action expected Action required - approval or processing by manager expected Successful - closed with expected result Failed - closed with decline Expired - closed with intent not fulfilled
order_id	string	Yes	Payment session ID
amount	int	No	Transaction amount (nullable) in minor units https://en.wikipedia.org/wiki/ISO_4217#Minor_unit_fractions
currency	string	Yes	Transaction currency code https://en.wikipedia.org/wiki/ISO_4217
conversion_rate	float	No	Applied conversion rate, if any
processed_currency	string	Yes	Currency after processing https://en.wikipedia.org/wiki/ISO_4217
processed_amount	int	Yes	Amount after processing in processed currency, in minor units https://en.wikipedia.org/wiki/ISO_4217#Minor_unit_fractions
payment_method	string	No	APM or CREDIT_CARD
gateway	string	No	Payment provider's name (e. g. Przelewy24 by Nuvei)
cid	string	No	Customer's ID
variable1	string	No	Custom tag field #1
variable2	string	No	Custom tag field #2
variable3	string	No	Custom tag field #3

Billing Address Object

Field Name	Type	Required	Description
address	string	Yes	Street address
city	string	Yes	City name
state	string	No	State or province
zip	string	Yes	ZIP or postal code
country	string	No	Country (as string code or name)

Session Object

Field Name	Type	Required	Description
auth_token	string	Yes	Session authentication token
intent	string	Yes	Only payment is available now
session_status	string	Yes	Status of the session. Can be: Open - customer action expected Action required - approval or processing by manager expected Successful - closed with expected result Failed - closed with decline Expired - closed with intent not fulfilled
order_id	string	Yes	Merchant transaction ID
currency	string	Yes	Currency code https://en.wikipedia.org/wiki/ISO_4217
amount	int	No	Original transaction amount in minor units https://en.wikipedia.org/wiki/ISO_4217#Minor_unit_fractions
conversion_rate	float	No	Rate used to convert from original to processed currency
processed_currency	string	No	Currency after processing https://en.wikipedia.org/wiki/ISO_4217
processed_amount	int	No	Final amount in processed currency in minor units https://en.wikipedia.org/wiki/ISO_4217#Minor_unit_fractions
cid	string	No	Customer unique ID
variable1	string	No	Custom field passed due payment request
variable2	string	No	Custom field passed due payment request
variable3	string	No	Custom field passed due payment request

Transaction Object

Field Name	Type	Required	Description
transaction_type	string	Yes	Only sale value is available as of now
transaction_status	string	Yes	Status of the transaction. Can be: Pending - waiting for updates from payment service provider Approved - payment transaction has been approved Rejected - payment transaction has been rejected by the payment service provider Error - unexpected error has occurred during the processing Canceled - payment transaction is marked as canceled
tid	int	Yes	Internal transaction ID
transaction_id	string	No	External transaction ID of payment provider
currency	string	Yes	Currency code https://en.wikipedia.org/wiki/ISO_4217
amount	int	Yes	Original amount of the transaction in minor units https://en.wikipedia.org/wiki/ISO_4217#Minor_unit_fractions
conversion_rate	float	No	Applied conversion rate
processed_currency	string	No	Currency after processing https://en.wikipedia.org/wiki/ISO_4217
processed_amount	int	No	Amount after processing in processed currency, minor units https://en.wikipedia.org/wiki/ISO_4217#Minor_unit_fractions
payment_method	string	Yes	APM or CREDIT_CARD
payment_processor	string	Yes	Payment processor name (e. g. Nuvei )
gateway	string	Yes	Payment provider name (ex Przelewy24 by Nuvei)
is_async	int	Yes	Default 1
is_cascade	int	Yes	Default 1
cascade_level	int	Yes	Default 1
created_by	string	Yes	Only INTERNET value is supported as of now.
status_code	string	Yes	Short status code returned from the gateway or processor
status_details	string	No	Detailed description or reason for the status
card	Object	No	Please refer to Card object

Card object

Field Name	Type	Required	Description
card_token	string	No	Currently is not returned
card_type	string	No	Type of card (e.g., VISA, MasterCard)
card_number	string	Yes	Masked card number (e.g., 4111********1111)
card_exp	string	No	Card expiration date (format: MM/YY or MM/YYYY)
card_issuer_name	string	No	Name of the card issuing bank or institution
card_issuer_country	string	No	Country of the card issuer (ISO 3166-1 alpha-2 code or name)
card_holder	string	No	Name of the card holder, if available.