Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Body

application/json
marketplace
string
required

Settlement source marketplace slug (zalora, shopee, lazada, tiktok, shopify, agentic, …). Used to match orders and pick a payment-received formula. zalora matches both Seller Center orders (platform=zalora) and reconciliation-era agentic carts.

Required string length: 2 - 32
lines
object[]
required

Settlement lines. Plural even for one target. Each line is one fee/credit/reversal, not a net paymentReceived.

Required array length: 1 - 200 elements
organizationId
string

Optional for OAuth clients bound to one organization; required when the caller can access multiple organizations.

Maximum string length: 120
accountId
string

Exact store/account id. Never a wildcard. Omit only when org + marketplace + externalOrderId already identifies one order.

Maximum string length: 160

Response

Batch accepted. Top-level success is true only when every requested line succeeds; partial failures remain in data.results.

ok
boolean
apiVersion
string
operationId
string<uuid>
status
enum<string>
Available options:
completed,
failed
data
object