Справочник API account

Поиск по всем методам

/v1/account/

Manages Access to the AppointmentTrader Account

GET

/v1/account/get_incoming_payment_session

Returns details of the incoming payment session and information on whether it has been completed or is still pending.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`uniquePaymentSessionID`	`string`	`Да`	`—`	unique session id returned by /v1/account/set_start_incoming_payment_session

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/account/get_incoming_payment_session' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'uniquePaymentSessionID={{uniquePaymentSessionID}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`account_get_incoming_payment_session_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.MetaInformation`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.MetaInformation[]`	`string`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].uniquePaymentSessionID`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].createDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].lastUpdateDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].expiryDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].sessionStatus`	`string ["active","expired"]`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentType`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].userAlias`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionReferenceID`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionDescription`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails`		`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].DestinationAccount`	`string`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*`	`PaymentConfigurationValue`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[0]`	`string \| number \| boolean \| null`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[1]`	`array`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[1][]`	`PaymentConfigurationValue`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[2]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0]..oneOf[2].`	`PaymentConfigurationValue`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][]`	`PaymentConfigurationValue`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[0]`	`string \| number \| boolean \| null`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[1]`	`array`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[1][]`	`PaymentConfigurationValue`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[2]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[2].*`	`PaymentConfigurationValue`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[2]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].fundingStatus`	`string ["not_funded","funded"]`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueFieldList`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueFieldList[]`	`string`	`Нет`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/account/get_incoming_payment_session",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Name": "synthetic-example",
        "MetaInformation": [],
        "KeyValueList": [],
        "KeyValueFieldList": []
    }
}

Машиночитаемая документация метода

GET

/v1/account/get_ledger

Returns paginated ledger entries for one account owned by the acting API user. Admin tools should access another user's ledger through the dispatcher impersonationUserAlias parameter; this endpoint still validates the account against the effective API user.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`accountID`	`string`	`Да`	`—`	Account ID owned by the acting API user.
`pageNumber`	`int`	`Нет`	`0`	Zero-based page number.
`pageLength`	`int`	`Нет`	`50`	Number of ledger rows to return, capped at 200.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/account/get_ledger' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'accountID={{accountID}}' \
  --data-urlencode 'pageNumber={{pageNumber}}' \
  --data-urlencode 'pageLength={{pageLength}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`account_get_ledger_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.Account`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.Currency`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.CurrencySymbol`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.LastUpdateDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.Description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.ATUser_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.ATUser_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.ATUser_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.CurrencyCreditLimit`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.CurrencyCreditLimit.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.CurrencyCreditLimit.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.PayoutDefaultBasisPoints`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.PayoutDefaultBasisPoints.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.PayoutDefaultBasisPoints.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.PointsCreditLimit`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.PointsCreditLimit.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.PointsCreditLimit.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.IsATCorporateAccount`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.IsATCorporateAccount.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.IsATCorporateAccount.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.IsDefault`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.IsDefault.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.IsDefault.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.IsDepositAccount`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.IsDepositAccount.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.IsDepositAccount.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.CurrencyBalance`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.CurrencyBalance.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.CurrencyBalance.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.PointsBalance`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.PointsBalance.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Account.PointsBalance.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.Ledger[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].LastUpdateDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Description`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationObject`	`string`	`Да`	Stored provider/audit content is returned as text; it is not decoded into a JSON object by this endpoint.
`$.oneOf[0].allOf[1].Payload.Ledger[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyAmount`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyAmount.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyAmount.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].PointsAmount`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].PointsAmount.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].PointsAmount.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyBalance`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyBalance.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyBalance.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].PointsBalance`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].PointsBalance.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].PointsBalance.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationID`		`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationID.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].SupplementalURL`		`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].SupplementalURL.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].SupplementalURL.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-RefundObject`		`Да`	Stored provider/audit content is returned as text; it is not decoded into a JSON object by this endpoint.
`$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-RefundObject.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-RefundObject.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-DisputeObject`		`Да`	Stored provider/audit content is returned as text; it is not decoded into a JSON object by this endpoint.
`$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-DisputeObject.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-DisputeObject.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-RefundObject`		`Да`	Stored provider/audit content is returned as text; it is not decoded into a JSON object by this endpoint.
`$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-RefundObject.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-RefundObject.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-DisputeObject`		`Да`	Stored provider/audit content is returned as text; it is not decoded into a JSON object by this endpoint.
`$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-DisputeObject.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-DisputeObject.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].RefundInstruction`		`Да`	Stored provider/audit content is returned as text; it is not decoded into a JSON object by this endpoint.
`$.oneOf[0].allOf[1].Payload.Ledger[].RefundInstruction.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].RefundInstruction.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Ledger[].TransactionType`	`string ["DEBIT","CREDIT"]`	`Да`
`$.oneOf[0].allOf[1].Payload.Page`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.Page.PageNumber`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Page.PageLength`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Page.NextPageNumber`		`Да`
`$.oneOf[0].allOf[1].Payload.Page.NextPageNumber.anyOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Page.NextPageNumber.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Page.PreviousPageNumber`		`Да`
`$.oneOf[0].allOf[1].Payload.Page.PreviousPageNumber.anyOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.Page.PreviousPageNumber.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.Page.HasMore`	`boolean`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/account/get_ledger",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Account": {
            "Currency": "synthetic-example",
            "CurrencySymbol": "synthetic-example",
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "Name": "synthetic-example",
            "Description": "synthetic-example",
            "ID": 0,
            "ATUser_ID": 0,
            "CurrencyCreditLimit": 0,
            "PayoutDefaultBasisPoints": 0,
            "PointsCreditLimit": 0,
            "IsATCorporateAccount": 0,
            "IsDefault": 0,
            "IsDepositAccount": 0,
            "CurrencyBalance": 0,
            "PointsBalance": 0
        },
        "Ledger": [],
        "Page": {
            "PageNumber": 0,
            "PageLength": 0,
            "NextPageNumber": 0,
            "PreviousPageNumber": 0,
            "HasMore": false
        }
    }
}

Машиночитаемая документация метода

GET

/v1/account/get_list

Returns all available user accounts including their balances and if applicable credit limits in the smallest possible currency unit

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`searchFilter`	`string`	`Нет`	`""`	filter criteria
`includeDepositAccount`	`bool`	`Нет`	`false`	defines if deposit account should be return
`pageSize`	`int`	`Нет`	`50`	Defines how many results will be return per request
`pageNumber`	`int`	`Нет`	`0`	Defines which page should be returned
`includeCorporateAccounts`	`bool`	`Нет`	`false`	Admin-only flag to include corporate accounts owned by the inspected user.
`includeHiddenAccounts`	`bool`	`Нет`	`false`	Admin-only flag to include hidden accounts owned by the inspected user.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/account/get_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'searchFilter={{searchFilter}}' \
  --data-urlencode 'includeDepositAccount={{includeDepositAccount}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}' \
  --data-urlencode 'includeCorporateAccounts={{includeCorporateAccounts}}' \
  --data-urlencode 'includeHiddenAccounts={{includeHiddenAccounts}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`account_get_list_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation[]`	`string`	`Нет`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountName`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountDescription`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrency`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencySymbol`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountNameAndBalance`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyBalance`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyBalance.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyBalance.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsBalance`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsBalance.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsBalance.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyCreditLimit`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyCreditLimit.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyCreditLimit.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsCreditLimit`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsCreditLimit.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsCreditLimit.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountIsCorporate`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountIsCorporate.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountIsCorporate.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountAvailableCurrencyBalance`	`number`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountAvailablePointsBalance`	`number`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]`	`string`	`Нет`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/account/get_list",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": [],
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}

Машиночитаемая документация метода

POST

/v1/account/set_start_incoming_payment_session

Creates an incoming payments session which will be credited to API users main account. The gross amount will be discounted, and the discounted expected payment will be returned

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`paymentType`	`string`	`Да`	`—`	Type of payment used
`grossAmount`	`int`	`Да`	`—`	Amount that shall be received by the transaction
`transactionReferenceID`	`string`	`Да`	`—`	this reference number can be used to avoid creating new payments sessions for the same checkout flow, if an active payments session for this transactionReferenceID exists the ExpiryTime will extended by the payment types sessionLifetime
`transactionDescription`	`string`	`Да`	`—`	this description will reflect on the users account detailing what the charge was for.
`isWritingRequest`	`bool`	`Нет`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/account/set_start_incoming_payment_session' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'paymentType={{paymentType}}' \
  --data-urlencode 'grossAmount={{grossAmount}}' \
  --data-urlencode 'transactionReferenceID={{transactionReferenceID}}' \
  --data-urlencode 'transactionDescription={{transactionDescription}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`account_set_start_incoming_payment_session_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.MetaInformation`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.MetaInformation[]`	`string`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].uniquePaymentSessionID`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].createDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].lastUpdateDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].expiryDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].sessionStatus`	`string ["active","expired"]`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentType`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].userAlias`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionReferenceID`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionDescription`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails`		`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].DestinationAccount`	`string`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*`	`PaymentConfigurationValue`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[0]`	`string \| number \| boolean \| null`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[1]`	`array`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[1][]`	`PaymentConfigurationValue`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[2]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0]..oneOf[2].`	`PaymentConfigurationValue`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][]`	`PaymentConfigurationValue`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[0]`	`string \| number \| boolean \| null`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[1]`	`array`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[1][]`	`PaymentConfigurationValue`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[2]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[2].*`	`PaymentConfigurationValue`	`Нет`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[2]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].fundingStatus`	`string ["not_funded","funded"]`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueFieldList`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.KeyValueFieldList[]`	`string`	`Нет`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/account/set_start_incoming_payment_session",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Name": "synthetic-example",
        "MetaInformation": [],
        "KeyValueList": [],
        "KeyValueFieldList": []
    }
}

Машиночитаемая документация метода