account APIリファレンス | 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://jp.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://jp.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://jp.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://jp.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": []
    }
}

機械可読のエンドポイントドキュメント