Skip to content
Navigation

Starts paying a frozen cart, answering what the buyer's page confirms with the processor, or the order when nothing is due.

POST
https://api.sherpo.io/customer/v1/stores/{store}/checkouts/{checkout}/pay

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

  • checkout
    string
    required
    minLength: 1

Request body JSON optional

  • instrument
    optional
    object

    One of the buyer's saved payment methods to pay with, as getBillingProfile lists it; only when the payment starts.

    • id
      string
      required
      maxLength: 512 · minLength: 1
  • attribution
    optional
    object

    What the buyer's browser tells the store's Meta pixel, kept for its purchase event only while the store sends them.

    • fbp
      optional
      string

      The _fbp cookie.

      maxLength: 500 · minLength: 1
    • fbc
      optional
      string

      The _fbc cookie.

      maxLength: 500 · minLength: 1
    • client_ip_address
      optional
      string

      The buyer's IP address.

      maxLength: 64 · minLength: 1
    • client_user_agent
      optional
      string
      maxLength: 512 · minLength: 1
    • country
      optional
      string

      ISO 3166-1 alpha-2.

      maxLength: 2 · minLength: 2 · pattern: ^[A-Za-z]{2}$
    • city
      optional
      string
      maxLength: 128 · minLength: 1
    • region
      optional
      string

      The region's code.

      maxLength: 16 · minLength: 1
    • postal_code
      optional
      string
      maxLength: 32 · minLength: 1
    • source_url
      optional
      string

      The http(s) page the payment started from; its query and fragment are dropped.

      maxLength: 2048 · minLength: 1

Returns

200

Starts paying a frozen cart, answering what the buyer's page confirms with the processor, or the order when nothing is due.

JSON

One of the following:

  • object
  • object
  • object
  • object
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close