Skip to main content
POST
Confirm an authoritative provider payment

Authorizations

X-Cart-Token
string
header
required

Purpose-limited capability returned for a guest cart.

Headers

Idempotency-Key
string
required

Caller-stable key reused only for retries of this exact request.

Required string length: 16 - 128
Pattern: ^[A-Za-z0-9._:-]{16,128}$
If-Match
string
required

Current cart ETag returned by the API.

Pattern: ^(?:W/)?"cart-(?:0|[1-9][0-9]*)"$

Path Parameters

locationId
string
required
Required string length: 1 - 128
cartId
string
required
Required string length: 1 - 128

Body

application/json
provider
enum<string>
required
Available options:
SQUARE
sourceId
string
required
Required string length: 1 - 1024
quoteRevision
string
required
Required string length: 1 - 128
tenderType
enum<string>
default:CARD
Available options:
CARD,
GIFT_CARD,
STORED_CARD,
WALLET
storedPaymentMethodId
string
Required string length: 1 - 128

Response

Confirmed completed provider payment and order.

provider
enum<string>
required
Available options:
SQUARE
status
enum<string>
required
Available options:
TENDER_REQUIRED
orderId
string
required
Minimum string length: 1
remaining
object
required
approvedTenders
object[]
required
Minimum array length: 1