Data Model Reference

Payin, Payout, and Claim are the three primary entities. Claims are linked to Payins through the transactionId foreign key. A single Claim can be associated with multiple Payins (via the relatedPayins nested field). Aggregation queries operate across all three datasets.

erDiagram
    PAYIN {
        string transactionId PK
        string trackingId
        decimal amount
        string currency
        string transactionStatusName
        datetime createdTs
        datetime editedTs
    }

    PAYOUT {
        string transactionId PK
        string trackingId
        decimal amount
        string currency
        decimal settlementAmount
        string transactionStatusName
        datetime createdTs
        datetime editedTs
    }

    CLAIM {
        string claimId PK
        string transactionId FK
        decimal amount
        string status
        string claimReason
        datetime createdTs
        datetime editedTs
    }

    PAYIN ||--o{ CLAIM : "has claims"
    CLAIM }o--|| PAYIN : "relatedPayins"

Payin

An inbound payment transaction where funds are received from a customer.

Payout

An outbound payment transaction where funds are sent from the merchant to a recipient.

Claim

A chargeback or dispute claim filed against a payin transaction. A single claim may be associated with multiple payin transactions.

relatedPayins

The relatedPayins field on a Claim returns the payin transactions associated with the claim. This is a nested query that returns up to 100 payins per claim.

query {
  claims(
    first: 1
    filter: {
      claimId: "20723"
      createdDateFrom: "2026-01-01"
      createdDateTo: "2026-01-31"
    }
  ) {
    edges {
      node {
        claimId
        amount
        status
        claimReason
        relatedPayins {
          transactionId
          amount
          currency
          transactionStatusName
        }
      }
    }
  }
}

PageInfo

Pagination metadata returned with every connection.

PageSummary

Additional pagination metadata.

AggregationResult

Returned by the aggregations query.

AggregationByStatus

A single status bucket within an aggregation result.

Example aggregation response

{
  "data": {
    "payinsAgg": {
      "totalCount": 3720,
      "sumAmount": "823980.71",
      "byStatus": [
        { "status": "APPROVED", "count": 3176, "sumAmount": "678716.21" },
        { "status": "FAILED", "count": 9, "sumAmount": "515.71" },
        { "status": "PENDING", "count": 461, "sumAmount": "130922.74" },
        { "status": "EXPIRED", "count": 16, "sumAmount": "1723.57" },
        { "status": "CANCELLED", "count": 58, "sumAmount": "12102.48" }
      ]
    }
  }
}

Connection types

All list queries return connection wrappers following the same pattern.

Each connection contains:

• edges -- Array of edge objects, each with a node and cursor.
• pageInfo -- PageInfo object with endCursor and hasNextPage.
• summary -- PageSummary object with rowCount, pageSizeLimit, and totalCount.

Filter inputs

PayinFilterInput

PayoutFilterInput

ClaimFilterInput

AggregationFilterInput

AggregationDataset enum

Used with the aggregations query to specify which dataset to aggregate.

Field standards

Monetary amounts

All monetary values use the Money scalar type and are returned as strings with exactly 2 decimal places (e.g., "55.03", "1000.00"). Parse these as decimal types in your application -- do not use floating-point types to avoid precision loss.

Dates and timestamps

• Date fields (createdDate, paidDate, processedDate): Format yyyy-MM-dd.
• Timestamp fields (createdTs, editedTs, paidTs, processedTs): ISO 8601 format with timezone offset (e.g., "2026-01-31T23:59:15.167Z").

Currency codes

All currency codes follow ISO 4217 (3-letter uppercase). Common currencies in the API include BRL, CLP, MXN, COP, and PEN.

PII fields

Fields marked as PII may be returned in masked form unless the X-Pii-Access: true header is included. PII fields include: customerEmail, customerPersonalId, customerFullName, customerPhone, payerPersonalId, payerFullName, payerEmail, payerPhone.