Şu an çevrimiçi  

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

Parametreler

AdTürGerekliVarsayılanAçıklama
uniquePaymentSessionID string Evet — unique session id returned by /v1/account/set_start_incoming_payment_session
İstek örneği (cURL)
curl --get \
  'https://tr.appointmenttrader.com/v1/account/get_incoming_payment_session' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'uniquePaymentSessionID={{uniquePaymentSessionID}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$account_get_incoming_payment_session_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.Namestring Evet
$.oneOf[0].allOf[1].Payload.MetaInformationarray Evet
$.oneOf[0].allOf[1].Payload.MetaInformation[]string HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueListarray Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[]object HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].uniquePaymentSessionIDstring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].createDatestring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].lastUpdateDatestring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].expiryDatestring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].sessionStatusstring ["active","expired"] Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentTypestring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSecondsDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].userAliasstring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionReferenceIDstring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionDescriptionstring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmountDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmountDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0]object Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].DestinationAccountstring HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*PaymentConfigurationValue HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[0]string | number | boolean | null HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[1]array HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[1][]PaymentConfigurationValue HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[2]object HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[2].*PaymentConfigurationValue HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1]array Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][]PaymentConfigurationValue HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[0]string | number | boolean | null HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[1]array HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[1][]PaymentConfigurationValue HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[2]object HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[2].*PaymentConfigurationValue HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[2]string | number | boolean | null Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].fundingStatusstring ["not_funded","funded"] Evet
$.oneOf[0].allOf[1].Payload.KeyValueFieldListarray Evet
$.oneOf[0].allOf[1].Payload.KeyValueFieldList[]string HAYIR
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
Yanıt örneği
{
    "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": []
    }
}
Makine tarafından okunabilir uç nokta belgeleri
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.

Parametreler

AdTürGerekliVarsayılanAçıklama
accountID string Evet — Account ID owned by the acting API user.
pageNumber int HAYIR 0 Zero-based page number.
pageLength int HAYIR 50 Number of ledger rows to return, capped at 200.
İstek örneği (cURL)
curl --get \
  'https://tr.appointmenttrader.com/v1/account/get_ledger' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'accountID={{accountID}}' \
  --data-urlencode 'pageNumber={{pageNumber}}' \
  --data-urlencode 'pageLength={{pageLength}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$account_get_ledger_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.Accountobject Evet
$.oneOf[0].allOf[1].Payload.Account.Currencystring Evet
$.oneOf[0].allOf[1].Payload.Account.CurrencySymbolstring Evet
$.oneOf[0].allOf[1].Payload.Account.CreatedDatestring Evet
$.oneOf[0].allOf[1].Payload.Account.LastUpdateDatestring Evet
$.oneOf[0].allOf[1].Payload.Account.Namestring Evet
$.oneOf[0].allOf[1].Payload.Account.Descriptionstring Evet
$.oneOf[0].allOf[1].Payload.Account.IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Account.ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Account.ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Account.ATUser_IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Account.ATUser_ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Account.ATUser_ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Account.CurrencyCreditLimitDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Account.CurrencyCreditLimit.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Account.CurrencyCreditLimit.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Account.PayoutDefaultBasisPointsDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Account.PayoutDefaultBasisPoints.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Account.PayoutDefaultBasisPoints.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Account.PointsCreditLimitDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Account.PointsCreditLimit.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Account.PointsCreditLimit.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Account.IsATCorporateAccountDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Account.IsATCorporateAccount.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Account.IsATCorporateAccount.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Account.IsDefaultDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Account.IsDefault.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Account.IsDefault.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Account.IsDepositAccountDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Account.IsDepositAccount.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Account.IsDepositAccount.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Account.CurrencyBalanceDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Account.CurrencyBalance.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Account.CurrencyBalance.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Account.PointsBalanceDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Account.PointsBalance.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Account.PointsBalance.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Ledgerarray Evet
$.oneOf[0].allOf[1].Payload.Ledger[]object HAYIR
$.oneOf[0].allOf[1].Payload.Ledger[].CreatedDatestring Evet
$.oneOf[0].allOf[1].Payload.Ledger[].LastUpdateDatestring Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Namestring Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Descriptionstring Evet
$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationObjectstring EvetStored provider/audit content is returned as text; it is not decoded into a JSON object by this endpoint.
$.oneOf[0].allOf[1].Payload.Ledger[].IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Ledger[].ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Ledger[].ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyAmountDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyAmount.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyAmount.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Ledger[].PointsAmountDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Ledger[].PointsAmount.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Ledger[].PointsAmount.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyBalanceDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyBalance.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyBalance.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Ledger[].PointsBalanceDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Ledger[].PointsBalance.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Ledger[].PointsBalance.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID.anyOf[0]DatabaseInteger EvetInteger 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 Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID.anyOf[0]DatabaseInteger EvetInteger 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 Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID.anyOf[0]DatabaseInteger EvetInteger 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 Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID Evet
$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationID Evet
$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationID.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Ledger[].SupplementalURL Evet
$.oneOf[0].allOf[1].Payload.Ledger[].SupplementalURL.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.Ledger[].SupplementalURL.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-RefundObject EvetStored 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 Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-RefundObject.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-DisputeObject EvetStored 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 Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-DisputeObject.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-RefundObject EvetStored 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 Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-RefundObject.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-DisputeObject EvetStored 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 Evet
$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-DisputeObject.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Ledger[].RefundInstruction EvetStored 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 Evet
$.oneOf[0].allOf[1].Payload.Ledger[].RefundInstruction.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Ledger[].TransactionTypestring ["DEBIT","CREDIT"] Evet
$.oneOf[0].allOf[1].Payload.Pageobject Evet
$.oneOf[0].allOf[1].Payload.Page.PageNumberinteger Evet
$.oneOf[0].allOf[1].Payload.Page.PageLengthinteger Evet
$.oneOf[0].allOf[1].Payload.Page.NextPageNumber Evet
$.oneOf[0].allOf[1].Payload.Page.NextPageNumber.anyOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Page.NextPageNumber.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Page.PreviousPageNumber Evet
$.oneOf[0].allOf[1].Payload.Page.PreviousPageNumber.anyOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.Page.PreviousPageNumber.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Page.HasMoreboolean Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
Yanıt örneği
{
    "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
        }
    }
}
Makine tarafından okunabilir uç nokta belgeleri
GET

/v1/account/get_list

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

Parametreler

AdTürGerekliVarsayılanAçıklama
searchFilter string HAYIR "" filter criteria
includeDepositAccount bool HAYIR false defines if deposit account should be return
pageSize int HAYIR 50 Defines how many results will be return per request
pageNumber int HAYIR 0 Defines which page should be returned
includeCorporateAccounts bool HAYIR false Admin-only flag to include corporate accounts owned by the inspected user.
includeHiddenAccounts bool HAYIR false Admin-only flag to include hidden accounts owned by the inspected user.
İstek örneği (cURL)
curl --get \
  'https://tr.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}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$account_get_list_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Evet
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation[]string HAYIR
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object HAYIR
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountNamestring Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountDescriptionstring Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencystring Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencySymbolstring Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountNameAndBalancestring Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountIDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyBalanceDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyBalance.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyBalance.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsBalanceDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsBalance.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsBalance.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyCreditLimitDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyCreditLimit.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyCreditLimit.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsCreditLimitDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsCreditLimit.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsCreditLimit.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountIsCorporateDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountIsCorporate.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountIsCorporate.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountAvailableCurrencyBalancenumber Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountAvailablePointsBalancenumber Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string HAYIR
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
Yanıt örneği
{
    "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": []
        }
    }
}
Makine tarafından okunabilir uç nokta belgeleri
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

Parametreler

AdTürGerekliVarsayılanAçıklama
paymentType string Evet — Type of payment used
grossAmount int Evet — Amount that shall be received by the transaction
transactionReferenceID string Evet — 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 Evet — this description will reflect on the users account detailing what the charge was for.
isWritingRequest bool HAYIR 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
İstek örneği (cURL)
curl --request POST \
  'https://tr.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}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$account_set_start_incoming_payment_session_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.Namestring Evet
$.oneOf[0].allOf[1].Payload.MetaInformationarray Evet
$.oneOf[0].allOf[1].Payload.MetaInformation[]string HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueListarray Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[]object HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].uniquePaymentSessionIDstring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].createDatestring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].lastUpdateDatestring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].expiryDatestring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].sessionStatusstring ["active","expired"] Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentTypestring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSecondsDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].userAliasstring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionReferenceIDstring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionDescriptionstring Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmountDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmountDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0]object Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].DestinationAccountstring HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*PaymentConfigurationValue HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[0]string | number | boolean | null HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[1]array HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[1][]PaymentConfigurationValue HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[2]object HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[2].*PaymentConfigurationValue HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1]array Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][]PaymentConfigurationValue HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[0]string | number | boolean | null HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[1]array HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[1][]PaymentConfigurationValue HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[2]object HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[2].*PaymentConfigurationValue HAYIR
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[2]string | number | boolean | null Evet
$.oneOf[0].allOf[1].Payload.KeyValueList[].fundingStatusstring ["not_funded","funded"] Evet
$.oneOf[0].allOf[1].Payload.KeyValueFieldListarray Evet
$.oneOf[0].allOf[1].Payload.KeyValueFieldList[]string HAYIR
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
Yanıt örneği
{
    "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": []
    }
}
Makine tarafından okunabilir uç nokta belgeleri