AT AppointmentTrader
Iniciar sesión
En línea ahora  

/v1/checkout/

GET

/v1/checkout/get_context

#
Public-by-design: same-origin guest payment preparation uses a session-bound anti-forgery token.
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.appointmenttrader.com/v1/checkout/get_context' \
  --data-urlencode 'key={{API_KEY}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$checkout_get_context_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.csrfstring siOpaque anti-forgery token bound to the browser session. Synthetic examples never contain a usable token.
$.oneOf[0].allOf[1].Payload.settingsobject si
$.oneOf[0].allOf[1].Payload.settings.listingboolean si
$.oneOf[0].allOf[1].Payload.settings.bidboolean si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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
        }
    }
}
Documentación del endpoint legible por máquinas
GET

/v1/checkout/get_status

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
attempt string si — Opaque checkout attempt.
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.appointmenttrader.com/v1/checkout/get_status' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'attempt={{attempt}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$checkout_get_status_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.attemptstring si
$.oneOf[0].allOf[1].Payload.expiresAtinteger si
$.oneOf[0].allOf[1].Payload.serverTimeinteger si
$.oneOf[0].allOf[1].Payload.flowstring ["listing","bid"] si
$.oneOf[0].allOf[1].Payload.resumeURLstring si
$.oneOf[0].allOf[1].Payload.statestring ["prepared","authorized","completing","completed","canceling","canceled","expired","recovery"] si
$.oneOf[0].allOf[1].Payload.paymentState si
$.oneOf[0].allOf[1].Payload.paymentState.anyOf[0]string ["requires_payment_method","requires_confirmation","requires_action","processing","requires_capture","canceled","succeeded"] si
$.oneOf[0].allOf[1].Payload.paymentState.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.resultURL si
$.oneOf[0].allOf[1].Payload.resultURL.anyOf[0]string si
$.oneOf[0].allOf[1].Payload.resultURL.anyOf[1]null si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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"
    }
}
Documentación del endpoint legible por máquinas
POST

/v1/checkout/set_cancel

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
attempt string si — Opaque checkout attempt.
csrf string si — Browser token from get_context. POST required.
Ejemplo de solicitud (cURL) 
curl --request POST \
  'https://es.appointmenttrader.com/v1/checkout/set_cancel' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'attempt={{attempt}}' \
  --data-urlencode 'csrf={{csrf}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$checkout_set_cancel_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payload = true si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/checkout/set_cancel",
    "RequestUserAlias": "example-user",
    "Payload": true
}
Documentación del endpoint legible por máquinas
POST

/v1/checkout/set_prepare

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
payloadJSON string si — Listing UUID or canonical composer checkout fields and the selected reward.
requestKey string si — Random 64-character hexadecimal retry identity.
csrf string si — Browser token from get_context. POST required.
Ejemplo de solicitud (cURL) 
curl --request POST \
  'https://es.appointmenttrader.com/v1/checkout/set_prepare' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'payloadJSON={{payloadJSON}}' \
  --data-urlencode 'requestKey={{requestKey}}' \
  --data-urlencode 'csrf={{csrf}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Parámetros: payloadJSON
CampoTipoObligatorioDescripción
payloadJSONstring (application/json) si
payloadJSONGuestCheckoutPrepareInput (JSON decodificado) si
payloadJSON.oneOf[0]object si
payloadJSON.oneOf[0].listingUUIDstring si
payloadJSON.oneOf[0].expectedAmountinteger si
payloadJSON.oneOf[1]object siCanonical 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].lidDatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
payloadJSON.oneOf[1].lid.oneOf[0]integer si
payloadJSON.oneOf[1].lid.oneOf[1]string si
payloadJSON.oneOf[1].inventorytypeidDatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
payloadJSON.oneOf[1].inventorytypeid.oneOf[0]integer si
payloadJSON.oneOf[1].inventorytypeid.oneOf[1]string si
payloadJSON.oneOf[1].unitDatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
payloadJSON.oneOf[1].unit.oneOf[0]integer si
payloadJSON.oneOf[1].unit.oneOf[1]string si
payloadJSON.oneOf[1].bidamountDatabaseNumber siNumeric value; MySQL reads can serialize numbers as numeric strings.
payloadJSON.oneOf[1].bidamount.oneOf[0]number si
payloadJSON.oneOf[1].bidamount.oneOf[1]string si
payloadJSON.oneOf[1].startdatestring si
payloadJSON.oneOf[1].enddatestring si
payloadJSON.oneOf[1].starttimestring No
payloadJSON.oneOf[1].enddtimestring No
payloadJSON.oneOf[1].exactstarttimestring si
payloadJSON.oneOf[1].exactendtimestring si
payloadJSON.oneOf[1].cuidlstring No
payloadJSON.oneOf[1].composersnapshotstring si
payloadJSON.oneOf[1].atv2ComposerDraftInstanceKeystring No
payloadJSON.oneOf[1].atv2ComposerDraftViewerKeystring No
payloadJSON.oneOf[1].uridDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
payloadJSON.oneOf[1].urid.oneOf[0]integer No
payloadJSON.oneOf[1].urid.oneOf[1]string No
payloadJSON.oneOf[1].composeruridDatabaseInteger NoInteger value; legacy MySQL reads may serialize it as a numeric string.
payloadJSON.oneOf[1].composerurid.oneOf[0]integer No
payloadJSON.oneOf[1].composerurid.oneOf[1]string No
payloadJSON.oneOf[1].premiumbid NoPresence selects the premium fee; omit entirely for standard pricing.
payloadJSON.oneOf[1].premiumbid.anyOf[0]string No
payloadJSON.oneOf[1].premiumbid.anyOf[1]boolean No
payloadJSON.oneOf[1].premiumbid.anyOf[2]integer No
payloadJSON.oneOf[1].expectedAmountinteger si
Campos de respuesta
CampoTipoObligatorioDescripción
$checkout_set_prepare_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.attemptstring si
$.oneOf[0].allOf[1].Payload.expiresAtinteger si
$.oneOf[0].allOf[1].Payload.serverTimeinteger si
$.oneOf[0].allOf[1].Payload.flowstring ["listing","bid"] si
$.oneOf[0].allOf[1].Payload.resumeURLstring si
$.oneOf[0].allOf[1].Payload.clientSecretstring si
$.oneOf[0].allOf[1].Payload.paymentIntentIDstring si
$.oneOf[0].allOf[1].Payload.paymentStatestring ["requires_payment_method","requires_confirmation","requires_action","processing","requires_capture","canceled","succeeded"] si
$.oneOf[0].allOf[1].Payload.amountinteger siTotal payable USD cents including the applicable publishing fee.
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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
    }
}
Documentación del endpoint legible por máquinas