List exact tenant payment economics (payment-operations)

{ "object": "simplepay.v1.payment_list", "data": [ { "object": "simplepay.v1.payment", "id": "<string>", "currency": "<string>", "base_amount_minor": "<string>", "payer_financing_amount_minor": "<string>", "gross_amount_minor": "<string>", "simplepay_fee_amount_minor": "<string>", "merchant_net_amount_minor": "<string>", "fee_reconciliation": { "status": "pending", "observed_amount_minor": null, "observed_at": null, "observed_currency": null, "currency": "<string>", "expected_amount_minor": "<string>" }, "payment_method_type": "card", "payment_rail": "card_not_present", "installment_months": 3, "surface": "hosted_checkout", "source_ref": "<string>", "status": "canceled", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" } ], "has_more": true, "next_cursor": "<string>" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit

integer

default:25

Required range: 1 <= x <= 100

cursor

string

Required string length: 1 - 640

Pattern: ^[A-Za-z0-9_-]+$

Response

200 - application/json

Tenant/environment-scoped payment financial facts with exact string minor units.

object

any

required

data

object[]

required

Maximum array length: 100

Hide child attributes

data.object

any

required

data.id

string

required

Pattern: ^spatt_[a-z0-9]{32}$

data.currency

string

required

Pattern: ^[a-z]{3}$

data.base_amount_minor

string

required

Maximum string length: 19

Pattern: ^[1-9][0-9]{0,18}$

data.payer_financing_amount_minor

string

required

Maximum string length: 19

Pattern: ^(0|[1-9][0-9]{0,18})$

data.gross_amount_minor

string

required

Maximum string length: 19

Pattern: ^[1-9][0-9]{0,18}$

data.simplepay_fee_amount_minor

string

required

Maximum string length: 19

Pattern: ^(0|[1-9][0-9]{0,18})$

data.merchant_net_amount_minor

string

required

Maximum string length: 19

Pattern: ^(0|[1-9][0-9]{0,18})$

data.fee_reconciliation

object

required

Comparison of the immutable SimplePay fee with the latest scoped financial fact. pending means conclusive evidence is not present; absence is never inferred as a match.

Option 1
Option 2

Hide child attributes

data.fee_reconciliation.status

enum<string>

required

matched only when amount and currency agree exactly; mismatch means observed evidence diverges; pending means no conclusive evidence yet.

Available options:

matched,

mismatch,

pending

Allowed value: "pending"

data.fee_reconciliation.observed_amount_minor

null

required

data.fee_reconciliation.observed_at

null

required

data.fee_reconciliation.observed_currency

null

required

data.fee_reconciliation.currency

string

required

Pattern: ^[a-z]{3}$

data.fee_reconciliation.expected_amount_minor

string

required

Maximum string length: 19

Pattern: ^(0|[1-9][0-9]{0,18})$

data.payment_method_type

enum<string>

required

Available options:

card,

oxxo,

spei

data.payment_rail

enum<string>

required

Available options:

card_not_present,

card_present,

oxxo,

spei

data.installment_months

enum<integer> | null

required

Available options:

3,

6,

9,

12,

18,

24,

null

data.surface

enum<string>

required

Available options:

hosted_checkout,

payment_links,

tap_to_pay,

terminal

data.source_ref

string | null

required

Maximum string length: 160

Pattern: ^sp[a-z0-9]*_[A-Za-z0-9_-]{3,150}$

data.status

enum<string>

required

Available options:

canceled,

failed,

pending,

processing,

reconciliation_required,

requires_action,

requires_payment_method,

succeeded

data.created_at

string<date-time>

required

data.updated_at

string<date-time>

required

has_more

boolean

required

next_cursor

string | null

required

Maximum string length: 640

Pattern: ^[A-Za-z0-9_-]+$

Overview

Endpoints

List exact tenant payment economics (payment-operations)

Authorizations

Query Parameters

Response