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

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

/v1/checkout/

GET

/v1/checkout/get_context

Public-by-design: same-origin guest payment preparation uses a session-bound anti-forgery token.

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

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

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`checkout_get_context_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.csrf`	`string`	`Да`	Opaque anti-forgery token bound to the browser session. Synthetic examples never contain a usable token.
`$.oneOf[0].allOf[1].Payload.settings`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.settings.listing`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.settings.bid`	`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/checkout/get_context",
    "RequestUserAlias": "example-user",
    "Payload": {
        "csrf": "FAKE_CSRF_TOKEN",
        "settings": {
            "listing": false,
            "bid": false
        }
    }
}

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

GET

/v1/checkout/get_status

Public-by-design: only the originating browser or verified intended buyer can read this attempt.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`attempt`	`string`	`Да`	`—`	Opaque checkout attempt.

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

curl --get \
  'https://ru.appointmenttrader.com/v1/checkout/get_status' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'attempt={{attempt}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`checkout_get_status_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.attempt`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.expiresAt`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.serverTime`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.flow`	`string ["listing","bid"]`	`Да`
`$.oneOf[0].allOf[1].Payload.resumeURL`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.state`	`string ["prepared","authorized","completing","completed","canceling","canceled","expired","recovery"]`	`Да`
`$.oneOf[0].allOf[1].Payload.paymentState`		`Да`
`$.oneOf[0].allOf[1].Payload.paymentState.anyOf[0]`	`string ["requires_payment_method","requires_confirmation","requires_action","processing","requires_capture","canceled","succeeded"]`	`Да`
`$.oneOf[0].allOf[1].Payload.paymentState.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.resultURL`		`Да`
`$.oneOf[0].allOf[1].Payload.resultURL.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.resultURL.anyOf[1]`	`null`	`Да`
`$.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/checkout/get_status",
    "RequestUserAlias": "example-user",
    "Payload": {
        "attempt": "synthetic-example",
        "expiresAt": 0,
        "serverTime": 0,
        "flow": "listing",
        "resumeURL": "synthetic-example",
        "state": "prepared",
        "paymentState": "requires_payment_method",
        "resultURL": "synthetic-example"
    }
}

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

POST

/v1/checkout/set_cancel

Public-by-design: cancellation requires the originating browser's token and attempt ownership.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`attempt`	`string`	`Да`	`—`	Opaque checkout attempt.
`csrf`	`string`	`Да`	`—`	Browser token from get_context. POST required.

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

curl --request POST \
  'https://ru.appointmenttrader.com/v1/checkout/set_cancel' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'attempt={{attempt}}' \
  --data-urlencode 'csrf={{csrf}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`checkout_set_cancel_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`	`= true`	`Да`
`$.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/checkout/set_cancel",
    "RequestUserAlias": "example-user",
    "Payload": true
}

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

POST

/v1/checkout/set_prepare

Public-by-design: prepares a session-owned manual-capture payment; never purchases or creates a bid.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`payloadJSON`	`string`	`Да`	`—`	Listing UUID or canonical composer checkout fields and the selected reward.
`requestKey`	`string`	`Да`	`—`	Random 64-character hexadecimal retry identity.
`csrf`	`string`	`Да`	`—`	Browser token from get_context. POST required.

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

curl --request POST \
  'https://ru.appointmenttrader.com/v1/checkout/set_prepare' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'payloadJSON={{payloadJSON}}' \
  --data-urlencode 'requestKey={{requestKey}}' \
  --data-urlencode 'csrf={{csrf}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Параметры: payloadJSON

Поле	Тип	Обязательно	Описание
`payloadJSON`	`string (application/json)`	`Да`
`payloadJSON`	`GuestCheckoutPrepareInput (декодированный JSON)`	`Да`
`payloadJSON.oneOf[0]`	`object`	`Да`
`payloadJSON.oneOf[0].listingUUID`	`string`	`Да`
`payloadJSON.oneOf[0].expectedAmount`	`integer`	`Да`
`payloadJSON.oneOf[1]`	`object`	`Да`	Canonical fields must match the session-owned frozen composer snapshot. composersnapshot is an opaque token, not serialized request content. expectedAmount is the displayed total in USD cents; bidamount is the displayed principal in the active currency. Unknown fields are discarded.
`payloadJSON.oneOf[1].lid`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`payloadJSON.oneOf[1].lid.oneOf[0]`	`integer`	`Да`
`payloadJSON.oneOf[1].lid.oneOf[1]`	`string`	`Да`
`payloadJSON.oneOf[1].inventorytypeid`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`payloadJSON.oneOf[1].inventorytypeid.oneOf[0]`	`integer`	`Да`
`payloadJSON.oneOf[1].inventorytypeid.oneOf[1]`	`string`	`Да`
`payloadJSON.oneOf[1].unit`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`payloadJSON.oneOf[1].unit.oneOf[0]`	`integer`	`Да`
`payloadJSON.oneOf[1].unit.oneOf[1]`	`string`	`Да`
`payloadJSON.oneOf[1].bidamount`	`DatabaseNumber`	`Да`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`payloadJSON.oneOf[1].bidamount.oneOf[0]`	`number`	`Да`
`payloadJSON.oneOf[1].bidamount.oneOf[1]`	`string`	`Да`
`payloadJSON.oneOf[1].startdate`	`string`	`Да`
`payloadJSON.oneOf[1].enddate`	`string`	`Да`
`payloadJSON.oneOf[1].starttime`	`string`	`Нет`
`payloadJSON.oneOf[1].enddtime`	`string`	`Нет`
`payloadJSON.oneOf[1].exactstarttime`	`string`	`Да`
`payloadJSON.oneOf[1].exactendtime`	`string`	`Да`
`payloadJSON.oneOf[1].cuidl`	`string`	`Нет`
`payloadJSON.oneOf[1].composersnapshot`	`string`	`Да`
`payloadJSON.oneOf[1].atv2ComposerDraftInstanceKey`	`string`	`Нет`
`payloadJSON.oneOf[1].atv2ComposerDraftViewerKey`	`string`	`Нет`
`payloadJSON.oneOf[1].urid`	`DatabaseInteger`	`Нет`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`payloadJSON.oneOf[1].urid.oneOf[0]`	`integer`	`Нет`
`payloadJSON.oneOf[1].urid.oneOf[1]`	`string`	`Нет`
`payloadJSON.oneOf[1].composerurid`	`DatabaseInteger`	`Нет`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`payloadJSON.oneOf[1].composerurid.oneOf[0]`	`integer`	`Нет`
`payloadJSON.oneOf[1].composerurid.oneOf[1]`	`string`	`Нет`
`payloadJSON.oneOf[1].premiumbid`		`Нет`	Presence selects the premium fee; omit entirely for standard pricing.
`payloadJSON.oneOf[1].premiumbid.anyOf[0]`	`string`	`Нет`
`payloadJSON.oneOf[1].premiumbid.anyOf[1]`	`boolean`	`Нет`
`payloadJSON.oneOf[1].premiumbid.anyOf[2]`	`integer`	`Нет`
`payloadJSON.oneOf[1].expectedAmount`	`integer`	`Да`

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`checkout_set_prepare_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.attempt`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.expiresAt`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.serverTime`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.flow`	`string ["listing","bid"]`	`Да`
`$.oneOf[0].allOf[1].Payload.resumeURL`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.clientSecret`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.paymentIntentID`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.paymentState`	`string ["requires_payment_method","requires_confirmation","requires_action","processing","requires_capture","canceled","succeeded"]`	`Да`
`$.oneOf[0].allOf[1].Payload.amount`	`integer`	`Да`	Total payable USD cents including the applicable publishing fee.
`$.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/checkout/set_prepare",
    "RequestUserAlias": "example-user",
    "Payload": {
        "attempt": "synthetic-example",
        "expiresAt": 0,
        "serverTime": 0,
        "flow": "listing",
        "resumeURL": "synthetic-example",
        "clientSecret": "pi_FAKE_secret_PLACEHOLDER",
        "paymentIntentID": "pi_FAKE",
        "paymentState": "requires_payment_method",
        "amount": 0
    }
}

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