Skip to main content

Objects

acquiring_payments

All the payment details.

NameMandatoryTypeDescription
id+stringUnique payment identifier
status+stringPayment status. Options: succeeded, in_progress, pending, failed
created_at+stringCreation date in ISO 8601 format
finished_at-stringCompletion date in ISO 8601 format
customer-objectUser (payer) details
payment_details+objectPayment data
amount_details+objectAmount
recurrent-objectDetails needed to perform recurring payments
participant_details-objectParticipant details
refunds-arrayRefund list
customer_interaction-objectData needed for user interaction
transaction_info-objectTransaction information
metadata-objectAdditional 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-objectError 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

acquiring_widget

Settings for the payout form widget (for performing bank card payments).

NameMandatoryTypeDescription
session_id+stringPayment session identifier
locale-stringLocalization parameter. Options: en, ru. Default value: en
show_recurrent_checkbox-boolWhether to display the I agree to recurring payments checkbox in the widget interface
success_return_url-stringURL to which the user is redirected after the payment is successfully completed
failure_return_url-stringURL to which the user is redirected if an error occurs during the payment
success_on_hold-boolWhether 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

amount_details

An amount object.

NameMandatoryTypeDescription
amount+intAmount in minor currency units (USD decimal format), i.e. if the value is 10000, the amount is 100 USD
currency+stringISO 4217 currency code. Case insensitive

bank_account

Payout recipient's account description.

NameMandatoryTypeDescription
type+stringBank payment system. Options: global, ru
global- (mandatory for
type = global)
objectRecipient's bank account details
ru- (mandatory for
type = ru)
objectRecipient's bank account details

bank_card

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

NameMandatoryTypeDescription
number+stringCard number
expiration_month- (mandatory for
payments if available)
stringMonth
expiration_year- (mandatory for
payments if available)
stringYear
security_code- (mandatory for
payments if available)
stringCVC (security code)
cardholder_name-stringCardholder's name

card

Payout recipient's bank card details.

NameMandatoryTypeDescription
type+stringCard details transmission type. Options: bank_card, encrypted_card
bank_card- (mandatory for
type = bank_card)
objectUnencrypted card
encrypted_card- (mandatory for
type = encrypted_card)
objectCard with encrypted fields (tokenized)
brand-stringCard information. Returned in notifications, needed for user display
last4-stringCard information. Returned in notifications, needed for user display
bin-stringBank Identification Number (BIN) (the first 6 digits of a card number)

contacts

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

NameMandatoryTypeDescription
e-mail-stringUser's email
phone-stringUser's phone number

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.

NameMandatoryTypeDescription
reference+stringUser's identifier (payout recipient or payment sender) in your system
contacts-arrayUser contacts

customer_interaction

Customer interaction details.

NameMandatoryTypeDescription
type+stringCustomer interaction type. Options: redirect, inform
redirect- (mandatory of type: redirect)objectUser redirect data
inform- (mandatory of type: inform)objectPayment method information

encrypted_card

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

NameMandatoryTypeDescription
number_hash+stringCard number hash
expiration_date_hash-stringExpiration date hash
security_code_hash-stringCVC code hash
cardholder_name_hash-stringCardholder's name hash

error

Error details.

NameMandatoryTypeDescription
code+stringError code
description+stringError description

Error codes

faster_payment_system

FPS details.

NameMandatoryTypeDescription
phone+stringRecipient's phone number
bank_id+stringIdentifier of the recipient's bank in the FPS
description+stringPayout purpose

fps_no_account_widget

Settings for the payment page for money transfers.

NameMandatoryTypeDescription
session_id+stringPayment session identifier

global (bank accounts)

Bank account details (region: global).

NameMandatoryTypeDescription
account_number-stringAccount number
bank_account_number-stringBank account number
account_type-stringAccount type
routing_code-stringRouting code
routing_number-stringRouting number
swift_bic_code-stringSWIFT BIC code
sort_code-stringSort code
msisdn-stringPhone number
iban-stringIBAN
description-stringPurpose of remittance for the payout
bsb_number-stringBSB number
ifs_code-stringIFS code
branch_number-stringBranch number

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

global (wallets)

Wallet details.

NameMandatoryTypeDescription
name+stringWallet name
msisdn+stringPhone number
description+stringPurpose of remittance for the payout

identity_document

Identity details.

NameMandatoryTypeDescription
id_type-stringIdentity type
id_number+stringIdentity number
id_expiration_date-stringIdentity expiration date

info (card token information)

Details of a tokenized bank card.

NameMandatoryTypeDescription
number_hash+stringToken (tokenized bank card)
brand+stringPayment system, i.e. visa
last4+stringLast 4 card numbers
country_iso3-stringCountry of the card's bank

info (public token information)

Information on a public token.

NameMandatoryTypeDescription
token+stringToken
created_at+stringCreation date in ISO 8601 format
finished_at+stringCompletion date in ISO 8601 format
is_active+boolWhether the token can be used for an operation: true—yes, false—no

info (recurring transaction token information)

Information on a token for recurring payments/payouts.

NameMandatoryTypeDescription
token+stringToken
created_at+stringCreation date in ISO 8601 format
finished_at+stringCompletion date in ISO 8601 format
is_active+boolWhether the token can be used for an operation: true—yes, false—no
initiator-stringRecurring payment type. Options: merchant—a MIT payment (by default), client—a CIT payment

inform

Payment method details.

NameMandatoryTypeDescription
qr-objectQR code for FPS payments

participant_details

Payout participant details.

NameMandatoryTypeDescription
recipient-objectRecipient details
sender-objectSender details

payments

All the payout details.

NameMandatoryTypeDescription
id+stringPayout identifier
status+stringStatus. Options: succeeded, in_progress, pending, failed
created_at+stringCreation date in ISO 8601 format
finished_at-stringCompletion date in ISO 8601 format
customer-objectRecipient data in your system
payment_method+objectMethod of receiving the payout
amount_details+objectAmount
participant_details-objectDetails of the payout participants required to perform the payout
refunds-arrayRefund list
transaction_info-objectTransaction information
metadata-objectAdditional 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-objectError 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

payment_details

Payment method description.

NameMandatoryTypeDescription
type+stringPayment method type. Options: card, recurrent, faster_payment_system
card- (mandatory for
type = card)
objectBank card details
recurrent- (mandatory for
type = recurrent)
objectDetails needed to perform recurring payments
faster_payment_system- (mandatory for
type = faster_payment_system)
objectFPS details

payment_method

Payout method description.

NameMandatoryTypeDescription
type+stringType of the method for receiving the payout. Options: card, bank_account, wallet, recurrent
card- (mandatory for
type = card)
objectRecipient's bank card
bank_account- (mandatory for
type = bank_account)
objectRecipient's bank account
wallet- (mandatory for
type = wallet)
objectRecipient's wallet details
recurrent- (mandatory for
type = recurrent)
objectToken for recurring payouts

payment_options

Parameters needed to perform a payment.

NameMandatoryTypeDescription
return_url-stringURL to which the user is redirected after the payment is performed
recurrent-boolWhether the payment is to be performed using a saved token
description-stringAny additional information to be displayed to the user during 3DS verification (if the field is supported by the payment provider)

public_token

Public token.

NameMandatoryTypeDescription
token+stringToken

qr

QR code for FPS payments.

NameMandatoryTypeDescription
content+stringQR code link
img+stringQR code image

recipient

Payout recipient details. Which details are necessary depends on the method of receiving the payout.

NameMandatoryTypeDescription
full_name-stringFull name
first_name-stringFirst name
last_name-stringLast name
middle_name-stringPatronymic
company_name-stringCompany name
reference-stringRecipient identifier in your system
tax_reference-stringTaxpayer identifier
address_line-stringAddress
ipv4-stringIP version 4 address
ipv6-stringIP version 6 address
country_iso3-stringCountry (ISO-3166-1 alpha-3)
country_iso2-stringCountry (ISO-3166-1 alpha-2)
city-stringCity
state-stringState
postal_code-stringPostal address
identity_document-objectIdentity document details
bank_name-stringBank name
currency-stringCurrency (ISO 4217)
registration_number-stringCompany registration number
code-stringCompany registration number
date_of_incorporation-stringCompany incorporation date
id_number-stringIdentification number
msisdn-stringMobile wallet address
email-stringEmail address

recurrent (recurring transaction token details)

Information on a token for recurring payments/payouts.

NameMandatoryTypeDescription
token+stringToken
created_at+stringCreation date in ISO 8601 format
finished_at+stringCompletion date in ISO 8601 format
is_active+boolWhether the token can be used for an operation: true—yes, false—no
initiator-stringRecurring payment type. Options: merchant—a MIT payment (by default), client—a CIT payment

recurrent (recurring transaction token)

Token for recurring payments/payouts.

NameMandatoryTypeDescription
token+stringToken

redirect

User redirect data.

NameMandatoryTypeDescription
url+stringRedirect address including GET parameters
base_url+stringRedirect address
method+stringSubmission 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.

refunds

Refund details.

NameMandatoryTypeDescription
id+stringUnique refund identifier
status+stringRefund status. Options: in_progress, accepted, declined, error
amount_details+objectRefund amount details
created_at+stringCreation date
finished_at-stringCompletion date
is_chargeback-boolWhether the refund is made within a chargeback
transaction_info-objectTransaction information
metadata-objectAdditional 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

ru

Bank account details (region: ru).

NameMandatoryTypeDescription
bik+stringRecipient’s Bank Identification Code
account+stringRecipient's bank account
full_name+stringIndividual'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+stringPayout purpose
inn- (mandatory for payouts to the accounts of legal entities and individual proprietors)stringRecipient's INN, 10 digits for legal entities, 12 digits for individuals, including individual proprietors
kpp- (mandatory for payouts to the accounts of legal entities)stringRecipient's Tax Registration Reason Code (KPP)

sender

Payout payer details. Which details are necessary depends on the method of receiving the payout.

NameMandatoryTypeDescription
full_name-stringFull name
first_name-stringFirst name
last_name-stringLast name
middle_name-stringPatronymic
company_name-stringCompany name
reference-stringRecipient identifier in your system
tax_reference-stringTaxpayer identifier
address_line-stringAddress
ipv4-stringIP version 4 address
ipv6-stringIP version 6 address
country_iso3-stringCountry (ISO-3166-1 alpha-3)
country_iso2-stringCountry (ISO-3166-1 alpha-2)
city-stringCity
state-stringState
postal_code-stringPostal address
identity_document-objectIdentity document details
bank_name-stringBank name
currency-stringCurrency (ISO 4217)
registration_number-stringCompany registration number
code-stringCompany registration number
date_of_incorporation-stringCompany incorporation date
id_number-stringIdentification number
msisdn-stringMobile wallet address
email-stringEmail address

session

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).

NameMandatoryTypeDescription
id+stringSession identifier
status+stringStatus. Options: created, in_progress, accepted, cancelled, error
created_at+stringCreation date in ISO 8601 format
updated_at+stringUpdate date in ISO 8601 format
payments-arrayA list of payouts performed within the session
acquiring_payments-arrayA list of payments performed within the session
next_action-stringA label indicating actions needed to perform the transaction successfully. Options: confirm, capture
error-objectError 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:

tokenize_widget

Settings for the tokenization widget.

NameMandatoryTypeDescription
access+boolIdentifies whether this public key can use the tokenization widget
locale-stringLocalization parameter. Options: en, ru. Default value: en

transaction_info

NameMandatoryTypeDescription
rrn+stringRetrieval Reference Number (a unique identifier generated for a bank transaction)
arn-stringAcquirer Reference Number (a unique number assigned to credit card transactions)
auth_code-stringAuthorization code

wallet

Recipient's wallet details.

NameMandatoryTypeDescription
type+stringOptions: global
global+objectWallet details

wallets

Details on the wallet balance used to make payouts.

NameMandatoryTypeDescription
id+stringBalance identifier
amount_details+objectCurrent balance