account API reference | AppointmentTrader

Search all endpoints

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

Parameters

Name	Type	Required	Default	Description
`uniquePaymentSessionID`	`string`	`Yes`	`—`	unique session id returned by /v1/account/set_start_incoming_payment_session

Request example (cURL)

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

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`account_get_incoming_payment_session_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.MetaInformation`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.MetaInformation[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].uniquePaymentSessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].createDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].lastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].expiryDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].sessionStatus`	`string ["active","expired"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].userAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionReferenceID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails`		`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].DestinationAccount`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*`	`PaymentConfigurationValue`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[0]`	`string \| number \| boolean \| null`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[1]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[1][]`	`PaymentConfigurationValue`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[2]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0]..oneOf[2].`	`PaymentConfigurationValue`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][]`	`PaymentConfigurationValue`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[0]`	`string \| number \| boolean \| null`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[1]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[1][]`	`PaymentConfigurationValue`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[2]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[2].*`	`PaymentConfigurationValue`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[2]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].fundingStatus`	`string ["not_funded","funded"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueFieldList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueFieldList[]`	`string`	`No`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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": []
    }
}

Machine-readable endpoint documentation

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.

Parameters

Name	Type	Required	Default	Description
`accountID`	`string`	`Yes`	`—`	Account ID owned by the acting API user.
`pageNumber`	`int`	`No`	`0`	Zero-based page number.
`pageLength`	`int`	`No`	`50`	Number of ledger rows to return, capped at 200.

Request example (cURL)

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

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`account_get_ledger_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.Currency`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.CurrencySymbol`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.Description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.CurrencyCreditLimit`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.CurrencyCreditLimit.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.CurrencyCreditLimit.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.PayoutDefaultBasisPoints`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.PayoutDefaultBasisPoints.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.PayoutDefaultBasisPoints.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.PointsCreditLimit`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.PointsCreditLimit.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.PointsCreditLimit.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.IsATCorporateAccount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.IsATCorporateAccount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.IsATCorporateAccount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.IsDefault`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.IsDefault.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.IsDefault.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.IsDepositAccount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.IsDepositAccount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.IsDepositAccount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.CurrencyBalance`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.CurrencyBalance.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.CurrencyBalance.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.PointsBalance`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Account.PointsBalance.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Account.PointsBalance.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.Ledger[].CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationObject`	`string`	`Yes`	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`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyAmount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyAmount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyAmount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].PointsAmount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].PointsAmount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].PointsAmount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyBalance`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyBalance.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].CurrencyBalance.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].PointsBalance`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Ledger[].PointsBalance.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].PointsBalance.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	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`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	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`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Originating-ATAccounts_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	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`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Destination-ATAccounts_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	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`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].ATUserPaymentMethods_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationID`		`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationID.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].ConfirmationID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].SupplementalURL`		`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].SupplementalURL.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].SupplementalURL.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-RefundObject`		`Yes`	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`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-RefundObject.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-DisputeObject`		`Yes`	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`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Stripe-DisputeObject.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-RefundObject`		`Yes`	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`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-RefundObject.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-DisputeObject`		`Yes`	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`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].Checkout-DisputeObject.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].RefundInstruction`		`Yes`	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`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].RefundInstruction.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Ledger[].TransactionType`	`string ["DEBIT","CREDIT"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page.PageNumber`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page.PageLength`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page.NextPageNumber`		`Yes`
`$.oneOf[0].allOf[1].Payload.Page.NextPageNumber.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page.NextPageNumber.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page.PreviousPageNumber`		`Yes`
`$.oneOf[0].allOf[1].Payload.Page.PreviousPageNumber.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page.PreviousPageNumber.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.Page.HasMore`	`boolean`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/account/get_list

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

Parameters

Name	Type	Required	Default	Description
`searchFilter`	`string`	`No`	`""`	filter criteria
`includeDepositAccount`	`bool`	`No`	`false`	defines if deposit account should be return
`pageSize`	`int`	`No`	`50`	Defines how many results will be return per request
`pageNumber`	`int`	`No`	`0`	Defines which page should be returned
`includeCorporateAccounts`	`bool`	`No`	`false`	Admin-only flag to include corporate accounts owned by the inspected user.
`includeHiddenAccounts`	`bool`	`No`	`false`	Admin-only flag to include hidden accounts owned by the inspected user.

Request example (cURL)

curl --get \
  'https://ca.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}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`account_get_list_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrency`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencySymbol`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountNameAndBalance`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyBalance`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyBalance.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyBalance.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsBalance`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsBalance.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsBalance.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyCreditLimit`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyCreditLimit.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountCurrencyCreditLimit.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsCreditLimit`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsCreditLimit.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountPointsCreditLimit.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountIsCorporate`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountIsCorporate.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountIsCorporate.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountAvailableCurrencyBalance`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].accountAvailablePointsBalance`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]`	`string`	`No`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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": []
        }
    }
}

Machine-readable endpoint documentation

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

Parameters

Name	Type	Required	Default	Description
`paymentType`	`string`	`Yes`	`—`	Type of payment used
`grossAmount`	`int`	`Yes`	`—`	Amount that shall be received by the transaction
`transactionReferenceID`	`string`	`Yes`	`—`	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`	`Yes`	`—`	this description will reflect on the users account detailing what the charge was for.
`isWritingRequest`	`bool`	`No`	`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

Request example (cURL)

curl --request POST \
  'https://ca.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}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`account_set_start_incoming_payment_session_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.MetaInformation`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.MetaInformation[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].uniquePaymentSessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].createDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].lastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].expiryDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].sessionStatus`	`string ["active","expired"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].remainingSessionLifetimeInSeconds.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].userAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionReferenceID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].transactionDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].grossAmount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].discountedAmount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails`		`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].DestinationAccount`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*`	`PaymentConfigurationValue`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[0]`	`string \| number \| boolean \| null`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[1]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[1][]`	`PaymentConfigurationValue`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0].*.oneOf[2]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[0]..oneOf[2].`	`PaymentConfigurationValue`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][]`	`PaymentConfigurationValue`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[0]`	`string \| number \| boolean \| null`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[1]`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[1][]`	`PaymentConfigurationValue`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[2]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[1][].oneOf[2].*`	`PaymentConfigurationValue`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].paymentDetails.anyOf[2]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].fundingStatus`	`string ["not_funded","funded"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueFieldList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueFieldList[]`	`string`	`No`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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": []
    }
}

Machine-readable endpoint documentation