AT AppointmentTrader
登录
当前在线  

/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://cn.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].RequestUserAliasstring 是的
$.oneOf[0].allOf[0].RequestPathstring | null 是的
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" 是的
$.oneOf[0].allOf[0].ResponseCodeinteger 是的
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
$.oneOf[0].allOf[1]object 是的
$.oneOf[0].allOf[1].Payloadobject 是的
$.oneOf[0].allOf[1].Payload.Namestring 是的
$.oneOf[0].allOf[1].Payload.MetaInformationarray 是的
$.oneOf[0].allOf[1].Payload.MetaInformation[]string 否
$.oneOf[0].allOf[1].Payload.KeyValueListarray 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[]object 否
$.oneOf[0].allOf[1].Payload.KeyValueList[].uniquePaymentSessionIDstring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].createDatestring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].lastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].expiryDatestring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].sessionStatusstring ["active","expired"] 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentTypestring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSecondsDatabaseInteger 是的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[].userAliasstring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionReferenceIDstring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionDescriptionstring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmountDatabaseInteger 是的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[].discountedAmountDatabaseInteger 是的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].DestinationAccountstring 否
$.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[].fundingStatusstring ["not_funded","funded"] 是的
$.oneOf[0].allOf[1].Payload.KeyValueFieldListarray 是的
$.oneOf[0].allOf[1].Payload.KeyValueFieldList[]string 否
$.oneOf[1]object 是的
$.oneOf[1].RequestUserAliasstring 是的
$.oneOf[1].RequestPathstring | null 是的
$.oneOf[1].RequestStatus = "Failed" 是的
$.oneOf[1].ResponseCodeinteger 是的
$.oneOf[1].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
响应示例 
{
    "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://cn.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].RequestUserAliasstring 是的
$.oneOf[0].allOf[0].RequestPathstring | null 是的
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" 是的
$.oneOf[0].allOf[0].ResponseCodeinteger 是的
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
$.oneOf[0].allOf[1]object 是的
$.oneOf[0].allOf[1].Payloadobject 是的
$.oneOf[0].allOf[1].Payload.Accountobject 是的
$.oneOf[0].allOf[1].Payload.Account.Currencystring 是的
$.oneOf[0].allOf[1].Payload.Account.CurrencySymbolstring 是的
$.oneOf[0].allOf[1].Payload.Account.CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.Account.LastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.Account.Namestring 是的
$.oneOf[0].allOf[1].Payload.Account.Descriptionstring 是的
$.oneOf[0].allOf[1].Payload.Account.IDDatabaseInteger 是的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_IDDatabaseInteger 是的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.CurrencyCreditLimitDatabaseInteger 是的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.PayoutDefaultBasisPointsDatabaseInteger 是的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.PointsCreditLimitDatabaseInteger 是的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.IsATCorporateAccountDatabaseInteger 是的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.IsDefaultDatabaseInteger 是的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.IsDepositAccountDatabaseInteger 是的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.CurrencyBalanceDatabaseInteger 是的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.PointsBalanceDatabaseInteger 是的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.Ledgerarray 是的
$.oneOf[0].allOf[1].Payload.Ledger[]object 否
$.oneOf[0].allOf[1].Payload.Ledger[].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.Ledger[].LastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.Ledger[].Namestring 是的
$.oneOf[0].allOf[1].Payload.Ledger[].Descriptionstring 是的
$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationObjectstring 是的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[].IDDatabaseInteger 是的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[].CurrencyAmountDatabaseInteger 是的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[].PointsAmountDatabaseInteger 是的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[].CurrencyBalanceDatabaseInteger 是的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[].PointsBalanceDatabaseInteger 是的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[].TransactionTypestring ["DEBIT","CREDIT"] 是的
$.oneOf[0].allOf[1].Payload.Pageobject 是的
$.oneOf[0].allOf[1].Payload.Page.PageNumberinteger 是的
$.oneOf[0].allOf[1].Payload.Page.PageLengthinteger 是的
$.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.HasMoreboolean 是的
$.oneOf[1]object 是的
$.oneOf[1].RequestUserAliasstring 是的
$.oneOf[1].RequestPathstring | null 是的
$.oneOf[1].RequestStatus = "Failed" 是的
$.oneOf[1].ResponseCodeinteger 是的
$.oneOf[1].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
响应示例 
{
    "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://cn.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].RequestUserAliasstring 是的
$.oneOf[0].allOf[0].RequestPathstring | null 是的
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" 是的
$.oneOf[0].allOf[0].ResponseCodeinteger 是的
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
$.oneOf[0].allOf[1]object 是的
$.oneOf[0].allOf[1].Payloadobject 是的
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" 是的
$.oneOf[0].allOf[1].Payload.ResponseBodyobject 是的
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring 是的
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray 是的
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation[]string 否
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray 是的
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object 否
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountNamestring 是的
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountDescriptionstring 是的
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencystring 是的
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencySymbolstring 是的
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountNameAndBalancestring 是的
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountIDDatabaseInteger 是的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[].accountCurrencyBalanceDatabaseInteger 是的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[].accountPointsBalanceDatabaseInteger 是的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[].accountCurrencyCreditLimitDatabaseInteger 是的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[].accountPointsCreditLimitDatabaseInteger 是的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[].accountIsCorporateDatabaseInteger 是的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[].accountAvailableCurrencyBalancenumber 是的
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountAvailablePointsBalancenumber 是的
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray 是的
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string 否
$.oneOf[1]object 是的
$.oneOf[1].RequestUserAliasstring 是的
$.oneOf[1].RequestPathstring | null 是的
$.oneOf[1].RequestStatus = "Failed" 是的
$.oneOf[1].ResponseCodeinteger 是的
$.oneOf[1].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
响应示例 
{
    "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://cn.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].RequestUserAliasstring 是的
$.oneOf[0].allOf[0].RequestPathstring | null 是的
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" 是的
$.oneOf[0].allOf[0].ResponseCodeinteger 是的
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
$.oneOf[0].allOf[1]object 是的
$.oneOf[0].allOf[1].Payloadobject 是的
$.oneOf[0].allOf[1].Payload.Namestring 是的
$.oneOf[0].allOf[1].Payload.MetaInformationarray 是的
$.oneOf[0].allOf[1].Payload.MetaInformation[]string 否
$.oneOf[0].allOf[1].Payload.KeyValueListarray 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[]object 否
$.oneOf[0].allOf[1].Payload.KeyValueList[].uniquePaymentSessionIDstring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].createDatestring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].lastUpdateDatestring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].expiryDatestring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].sessionStatusstring ["active","expired"] 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentTypestring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSecondsDatabaseInteger 是的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[].userAliasstring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionReferenceIDstring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionDescriptionstring 是的
$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmountDatabaseInteger 是的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[].discountedAmountDatabaseInteger 是的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].DestinationAccountstring 否
$.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[].fundingStatusstring ["not_funded","funded"] 是的
$.oneOf[0].allOf[1].Payload.KeyValueFieldListarray 是的
$.oneOf[0].allOf[1].Payload.KeyValueFieldList[]string 否
$.oneOf[1]object 是的
$.oneOf[1].RequestUserAliasstring 是的
$.oneOf[1].RequestPathstring | null 是的
$.oneOf[1].RequestStatus = "Failed" 是的
$.oneOf[1].ResponseCodeinteger 是的
$.oneOf[1].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
响应示例 
{
    "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": []
    }
}
机器可读的端点文档