Rate this page:

AccountCallback

The account callback. See the AccountCallbacks type.

Fields

callback_id

Copy URL
callback_id: 

number

The callback ID (sequence)

type

Copy URL
type: 

string

The callback type

account_id

Copy URL
account_id: 

number

The account ID

hash

Copy URL
hash: 

string

The security hash: hash = md5(account_salt + account_id + api_key + callback_id). Example: 50c5fe2290cd7409b37e673b8b05e495

account_name

Copy URL
account_name: 

string

The account name

account_email

Copy URL
account_email: 

string

The account email

language_code

Copy URL
language_code: 

string

The notification language code (2 symbols, ISO639-1). Examples: en, ru

account_first_name

Copy URL
account_first_name: 

string

The first name

account_last_name

Copy URL
account_last_name: 

string

The last name

balance

Copy URL
balance: 

decimal

The account's money

currency

Copy URL
currency: 

string

The currency code (USD, RUR, EUR, …)

account_document_uploaded

Optional
Copy URL
account_document_uploaded: 

AccountDocumentUploadedCallback

Deprecated. Please use the unified account_document_status_updated callback instead

regulation_address_uploaded

Optional
Copy URL
regulation_address_uploaded: 

RegulationAddressUploadedCallback

Received when proof of address is uploaded

account_document_verified

Optional
Copy URL
account_document_verified: 

AccountDocumentVerifiedCallback

Deprecated. Please use the unified account_document_status_updated callback instead

account_is_frozen

Optional
Copy URL
account_is_frozen: 

AccountIsFrozenCallback

Received when an account is frozen

account_is_unfrozen

Optional
Copy URL
account_is_unfrozen: 

AccountIsUnfrozenCallback

Received when an account is unfrozen

activate_successful

Optional
Copy URL
activate_successful: 

ActivateSuccessfulCallback

Received when a new (not child) account is created

call_history_report

Optional
Copy URL
call_history_report: 

CallHistoryReportCallback

Received when a call history report is ready

card_expired

Optional
Copy URL
card_expired: 

CardExpiredCallback

Received when a card is expired

card_expires_in_month

Optional
Copy URL
card_expires_in_month: 

CardExpiresInMonthCallback

Received when one month is left for a card to be expired

card_payment

Optional
Copy URL
card_payment: 

CardPaymentCallback

Received when a bank card payment is made

card_payment_failed

Optional
Copy URL
card_payment_failed: 

CardPaymentFailedCallback

Received when a bank card payment is failed

robokassa_payment

Optional
Copy URL
robokassa_payment: 

RobokassaPaymentCallback

Received when a robokassa payment is made

wire_transfer

Optional
Copy URL
wire_transfer: 

WireTransferCallback

Received when a wire transfer is made

js_fail

Optional
Copy URL
js_fail: 

JSFailCallback

Received when send_js_error is set to true and a JS error occures. See the 'send_js_error' parameter of the 'SetAccountInfo' function

min_balance

Optional
Copy URL
min_balance: 

MinBalanceCallback

Received when the minimum balance is reached

regulation_address_verified

Optional
Copy URL
regulation_address_verified: 

RegulationAddressVerifiedCallback

Received when proof of address is verified

renewed_subscriptions

Optional
Copy URL
renewed_subscriptions: 

RenewedSubscriptionsCallback

Received when subscriptions are renewed

reset_account_password_request

Optional
Copy URL
reset_account_password_request: 

ResetAccountPasswordRequestCallback

Received when an account password reset is requested

sip_registration_fail

Optional
Copy URL
sip_registration_fail: 

SIPRegistrationFailCallback

Received when a SIP registration is failed

subscription_is_frozen

Optional
Copy URL
subscription_is_frozen: 

SubscriptionIsFrozenCallback

Received when a subscription is frozen

subscription_is_detached

Optional
Copy URL
subscription_is_detached: 

SubscriptionIsDetachedCallback

Received when a subscription is canceled

transaction_history_report

Optional
Copy URL
transaction_history_report: 

TransactionHistoryReportCallback

Received when a transaction history report is ready

unverified_subscription_detached

Optional
Copy URL
unverified_subscription_detached: 

UnverifiedSubscriptionDetachedCallback

Received when an unverified subscription is canceled

expiring_callerid

Optional
Copy URL
expiring_callerid: 

ExpiringCallerIDCallback

Received when a caller ID is about to be expired

transcription_complete

Optional
Copy URL
transcription_complete: 

TranscriptionCompleteCallback

Received when a transcription is saved

sms_inbound

Optional
Copy URL
sms_inbound: 

InboundSmsCallback

Received when an inbound SMS is gotten

expiring_agreement

Optional
Copy URL
expiring_agreement: 

ExpiringAgreementCallback

Received for the accounts for which the confirmation documents waiting period expires in 20/15/10/5/1 day(s)

expired_agreement

Optional
Copy URL
expired_agreement: 

ExpiredAgreementCallback

Received for the accounts for which the confirmation documents waiting period has already expired or expires today

restored_agreement_status

Optional
Copy URL
restored_agreement_status: 

RestoredAgreementStatusCallback

Received when an expiration date of the confirmation documents waiting period is changed

next_charge_alert

Optional
Copy URL
next_charge_alert: 

NextChargeAlertCallback

Received when a plan is to be renewed in 3 days, but there is not enough money

certificate_expired

Optional
Copy URL
certificate_expired: 

CertificateExpiredCallback

Deprecated. Please use the expired_certificates and expiring_certificates callbacks instead

expired_certificates

Optional
Copy URL
expired_certificates: 

ExpiredCertificateCallback

Received for the accounts whose Apple VOIP certificates are expired

expiring_certificates

Optional
Copy URL
expiring_certificates: 

ExpiringCertificateCallback

Received for the accounts whose Apple VOIP certificates expire in 14 or fewer days

account_document_status_updated

Optional
Copy URL
account_document_status_updated: 

AccountDocumentStatusUpdatedCallback

Received when the verification status is updated

a2p_sms_activated

Optional
Copy URL
a2p_sms_activated: 

A2PActivatedCallback

Received when A2P SMS are activated

regulation_address_documents_requested

Optional
Copy URL
regulation_address_documents_requested: 

RegulationAddressDocumentsRequestedCallback

Received when the verification status is changed to PENDING

invoice_received

Optional
Copy URL
invoice_received: 

InvoiceReceivedCallback

Received when a monthly invoice is sent