Objects

PaymentSession

A container with data about all the operations performed within a single payment session.

Payment operations can only be performed within a session. One or more operations of the same or different types can be performed within the session (e.g., several payouts, a payment and a refund, or a payment which is subsequently split).

Name	Mandatory	Type	Description
id	+	string	Session identifier
status	+	string	Status. Options: created, in_progress, accepted, cancelled, error
created_at	+	string	Creation date in ISO 8601 format
updated_at	+	string	Update date in ISO 8601 format
payments	-	array<Payment>	A list of payouts performed within the session
acquiring_payments	-	array<AcquiringPayment>	A list of payments performed within the session
next_action	-	string	A label indicating actions needed to perform the transaction successfully. Options: confirm, capture
error	-	Error	Error description

Payment session statuses (status)

• created — the session has been created and is waiting to be started or canceled
• in_progress — the payment is being processed
• accepted — the payment has been completed successfully
• cancelled — the payment has been canceled
• error — an unexpected error occurred while processing

  Attention! This status is not final. Please contact Smart Glocal's support team and wait for a final transaction status.

Next steps (next_action)

If this field is not empty, it means that Smart Glocal is waiting for you to perform specific actions to proceed with the operation:

• confirm — confirm the operation (session/confirm) or cancel it (session/cancel)
• capture — debit the money (session/capture) or cancel the operation (session/cancel)

Payment

An object containing all the payout details.

Name	Mandatory	Type	Description
id	+	string	Payout identifier
status	+	string	Status. Options: succeeded, in_progress, pending, failed
created_at	+	string	Creation date in ISO 8601 format
finished_at	-	string	Completion date in ISO 8601 format
customer	-	Customer	Recipient's data in your system, E.g. the login that lets you verify the recipient on your side.
payment_method	+	PaymentMethod	Method of receiving the payout
amount_details	+	AmountDetails	Amount
participant_details	-	ParticipantDetails	Details of payout participants required to perform the payout, E.g. the names and addresses of the payer and the recipient.
refunds	-	array<Refund>	Refund list
metadata	-	object	Additional information. Any data you need in order to perform the operation. Returned in responses and webhooks. May contain string, integer, or JSON object data
error	-	Error	Error description

Payout statuses (status)

• in_progress — the payout is being processed
• pending — awaiting your confirmation (session/confirm) or cancelation (session/cancel)
• succeeded — the payout has been completed successfully
• failed — the payout has failed

AcquiringPayment

An object containing all the payment details.

Name	Mandatory	Type	Description
id	+	string	Unique payment identifier
status	+	string	Payment status. Options: succeeded, in_progress, pending, failed
created_at	+	string	Creation date in ISO 8601 format
finished_at	-	string	Completion date in ISO 8601 format
customer	-	Customer	User (payer) details
payment_details	+	PaymentDetails	Payment data
amount_details	+	AmountDetails	Amount
recurrent	-	RecurrentTokenInfo	Details needed to perform recurring payments
participant_details	-	ParticipantDetails	Participant details
refunds	-	array<Refund>	Refund list
customer_interaction	-	Customer	Data needed for user interaction
metadata	-	object	Additional information. Any data you need in order to perform the operation. Returned in responses and webhooks. May contain string, integer, or JSON object data
error	-	Error	Error description

Payment statuses (status)

• in_progress — the payment is being processed
• pending — awaiting your confirmation (session/confirm) or cancelation (session/cancel)
• succeeded — the payment has been completed successfully
• failed — the payment has failed

Refund

An object containing details on a refund.

Name	Mandatory	Type	Description
id	+	string	Unique refund identifier
status	+	string	Refund status. Options: in_progress, accepted, declined, error
amount_details	+	AmountDetails	Refund amount details
created_at	+	string	Creation date
finished_at	-	string	Completion date
is_chargeback	-	bool	Whether the refund is made within a chargeback
metadata	-	object	Additional information

Refund statuses (status)

• in_progress — the refund is being processed
• accepted — the refund has been completed successfully
• declined — Smart Glocal has declined the refund
• error — the refund has failed

PaymentMethod

An object containing the description of the method for receiving a payout.

Name	Mandatory	Type	Description
type	+	string	Type of the method for receiving the payout. Options: card, bank_account, wallet, recurrent
card	-	CardPaymentMethod	Recipient's bank card
bank_account	-	BankAccountPaymentMethodaymentmethod	Recipient's bank account
wallet	-	WalletPaymentMethod	Recipient's wallet details
recurrent	-	RecurrentToken	A payout with a recurrent token

PaymentDetails

An object containing the description of the method for performing a payment.

Name	Mandatory	Type	Description
type	+	string	Payment method type. Options: card, recurrent, faster_payment_system
card	-	CardPaymentMethod	Bank card details
recurrent	-	RecurrentTokenInfo	Details for repeating a payment using a token
faster_payment_system	-	FasterPaymentSystem	FPS details

PaymentOptions

Parameters needed to perform a payment.

Name	Mandatory	Type	Description
return_url	-	string	URL to which the user is redirected after the payment is performed
recurrent	-	bool	Whether the payment is to be performed using a saved token
description	-	string	Any additional information to be displayed to the user during 3DS verification (if the field is supported by the payment provider)

BankAccountPaymentMethod

An object containing the payout recipient's account description.

Name	Mandatory	Type	Description
type	+	string	Bank payment system. Options: global, ru
global	-	BankAccountGlobal	Recipient's bank account details
ru	-	BankAccountRu	Recipient's bank account details

BankAccountGlobal

An object containing bank account details (region: global).

Name	Mandatory	Type	Description
account_number	-	string	Account number
bank_account_number	-	string	Bank account number
account_type	-	string	Account type
routing_code	-	string	Routing code
routing_number	-	string	Routing number
swift_bic_code	-	string	SWIFT BIC code
sort_code	-	string	Sort code
msisdn	-	string	Phone number
iban	-	string	IBAN
description	-	string	Purpose of remittance for the payout
bsb_number	-	string	BSB number
ifs_code	-	string	IFS code
branch_number	-	string	Branch number

To learn which parameters are mandatory, check the information on a particular country.

BankAccountRU

An object containing bank account details (region: ru).

Name	Mandatory	Type	Description
bik	+	string	Recipient’s Bank Identification Code
account	+	string	Recipient's bank account
full_name	+	string	Individual's full name. In case of a payout to an account of a sole proprietor should be passed in the following format: ИП <full name>. In case of a payout to a legal entity, enter the entity's name, if it is provided in the agreement. Important: if the name is passed incorrectly the recipient bank may cancel the payout and the payout will be refunded
description	+	string	Payout purpose
inn	- (mandatory for payouts to the accounts of legal entities and individual proprietors)	string	Recipient's INN, 10 digits for legal entities, 12 digits for individuals, including individual proprietors
kpp	- (mandatory for payouts to the accounts of legal entities)	string	Recipient's Tax Registration Reason Code (KPP)

CardPaymentMethod

An object containing a payout recipient's bank card details.

Name	Mandatory	Type	Description
type	+	string	Card details transmission type. Options: bank_card, encrypted_card
bank_card	-	BankCard	Unencrypted card
encrypted_card	-	EncryptedCard	Card with encrypted fields (tokenized)
brand	-	string	Card information. Returned in notifications, needed for user display
last4	-	string	Card information. Returned in notifications, needed for user display

BankCard

Unencrypted card object (can be used if you have PCI DSS).

Name	Mandatory	Type	Description
number	+	string	Card number
expiration_month	- (Mandatory for payments if available)	string	Month
expiration_year	- (Mandatory for payments if available)	string	Year
security_code	- (Mandatory for payments if available)	string	CVC (security code)
cardholder_name	-	string	Cardholder's name

FasterPaymentSystem

FPS details.

Name	Mandatory	Type	Description
phone	+	string	Recipient's phone number
bank_id	+	string	Identifier of the recipient's bank in the FPS
description	+	string	Payout purpose

EncryptedCard

Card with encrypted fields (tokenized). Transmitted during payouts or payments through the widget.

Name	Mandatory	Type	Description
number_hash	+	string	Card number hash
expiration_date_hash	-	string	Expiration date hash
security_code_hash	-	string	CVC code hash
cardholder_name_hash	-	string	Cardholder's name hash

WalletPaymentMethod

An object with the recipient's wallet details.

Name	Mandatory	Type	Description
type	+	string	Options: global
global	+	WalletGlobal	Wallet details

WalletGlobal

An object with wallet details.

Name	Mandatory	Type	Description
name	+	string	Wallet name
msisdn	+	string	Phone number
description	+	string	Purpose of remittance for the payout

WalletDetails

An object with details on the wallet balance used to make payouts.

Name	Mandatory	Type	Description
id	+	string	Balance identifier
amount_details	+	AmountDetails	Current balance

PublicToken

An object with information about a public token.

Name	Mandatory	Type	Description
token	+	string	Token

RecurrentToken

An object with information on a recurrent token.

Name	Mandatory	Type	Description
token	+	string	Token

CardTokenInfo

An object with details of a tokenized bank card.

Name	Mandatory	Type	Description
number_hash	+	string	Token (tokenized bank card)
brand	+	string	Payment system, i.e. visa
last4	+	string	Last 4 card numbers
country_iso3	-	string	Country of the card's bank

PublicTokenInfo

An object with information on a public token.

Name	Mandatory	Type	Description
token	+	string	Token
created_at	+	string	Creation date in ISO 8601 format
finished_at	+	string	Completion date in ISO 8601 format
is_active	+	bool	Whether the token can be used for an operation: true — yes, false — no

RecurrentTokenInfo

An object with information on a recurrent token.

Name	Mandatory	Type	Description
token	+	string	Token
created_at	+	string	Creation date in ISO 8601 format
finished_at	+	string	Completion date in ISO 8601 format
is_active	+	bool	Whether the token can be used for an operation: true — yes, false — no
initiator	-	string	Recurrent payment type. Options: merchant - a MIT payment (by default), client - a CIT payment

AmountDetails

An amount object.

Name	Mandatory	Type	Description
amount	+	int	Amount in minor currency units (USD decimal format), i.e. if the value is 10000, the amount is 100 USD
currency	+	string	ISO 4217 currency code. Case insensitive

Customer

Data on the user (payout recipient or payment sender) in your system (e.g., the login that lets you identify the user). It also includes their contact details.

Name	Mandatory	Type	Description
reference	+	string	User's identifier (payout recipient or payment sender) in your system
contacts	-	array<CustomerContact>	User contacts

CustomerContact

Contacts of the user (payout recipient or payment sender).

Name	Mandatory	Type	Description
e-mail	-	string	User's email
phone	-	string	User's phone number

CustomerInteraction

An object describing customer interaction.

Name	Mandatory	Type	Description
type	+	string	Customer interaction type. Options: redirect, inform
redirect	-	CustomerInteractionRedirect	User redirect data object
inform	-	CustomerInteractionInform	Payment method information

CustomerInteractionRedirect

An object with user redirect data.

Name	Mandatory	Type	Description
url	+	string	Redirect address including GET parameters
base_url	+	string	Redirect address
method	+	string	Submission method. Options: POST, GET
qs	-	map\<string,string>	A set of parameters depending on the transaction method
params	-	map\<string,*>	A set of parameters depending on the transaction method

• Check if any parameters are specified in the qs and params objects.
• Redirect the user to the redirect address specified in base_url using the method from the method parameter and including all the required parameters in the URL or request body.

CustomerInteractionInform

An object with payment method details.

Name	Mandatory	Type	Description
qr	-	InformQR	QR code for FPS payments

InformQR

QR code for FPS payments.

Name	Mandatory	Type	Description
content	+	string	QR code link
img	+	string	QR code image

ParticipantDetails

Payout participant details.

Name	Mandatory	Type	Description
sender	-	Participant	Sender details
recipient	-	Participant	Recipient details

Participant

Payout participant (payer and/or recipient) details. Which details are necessary depends on the method of receiving the payout.

Name	Mandatory	Type	Description
full_name	-	string	Full name
first_name	-	string	First name
last_name	-	string	Last name
middle_name	-	string	Patronymic
company_name	-	string	Company name
reference	-	string	Recipient identifier in your system
tax_reference	-	string	Taxpayer identifier
address_line	-	string	Address
ipv4	-	string	IP version 4 address
ipv6	-	string	IP version 6 address
country_iso3	-	string	Country (ISO-3166-1 alpha-3)
country_iso2	-	string	Country (ISO-3166-1 alpha-2)
city	-	string	City
state	-	string	State
postal_code	-	string	Postal address
identity_document	-	IdentityDocument	Identity details
bank_name	-	string	Bank name
currency	-	string	Currency (ISO 4217)
registration_number	-	string	Company registration number
code	-	string	Company registration number
date_of_incorporation	-	string	Company incorporation date
id_number	-	string	Identification number
msisdn	-	string	Mobile wallet address
email	-	string	Email address

IdentityDocument

Identity details.

Name	Mandatory	Type	Description
id_type	-	string	Identity type
id_number	+	string	Identity number
id_expiration_date	-	string	Identity expiration date

TokenizeWidgetMetadata

An object containing settings for the tokenization widget.

Name	Mandatory	Type	Description
access	+	bool	Identifies whether this public key can use the tokenization widget
locale	-	string	Localization parameter. Options: en, ru. Default value: en

AcquiringWidgetMetadata

An object containing settings for the payout form widget (for performing bank card payments).

Name	Mandatory	Type	Description
session_id	+	string	Payment session identifier
locale	-	string	Localization parameter. Options: en, ru. Default value: en
show_recurrent_checkbox	-	bool	Whether to display the I agree to recurrent payments checkbox in the widget interface
success_return_url	-	string	URL to which the user is redirected after the payment is successfully completed
failure_return_url	-	string	URL to which the user is redirected if an error occurs during the payment
success_on_hold	-	bool	Whether to show the message about a successful payment to a payer when holding. The default value is false and the widget shows a loading screen until the end of the hold

FpsNoAccountWidgetMetadata

An object containing settings for the payment page for money transfers.

Name	Mandatory	Type	Description
session_id	+	string	Payment session identifier

Error

An object with error details.

Name	Mandatory	Type	Description
code	+	string	Error code
description	+	string	Error description

Error codes