---
title: "PublicPaymentV10"
description: "Payment on a closed sale, for bookkeeping and reconciliation.\n\nAcquirer/processing cost is not on this object. Merchant-charged fees (shipping, service\ncharge, etc.) appear as `type: \"FEE\"` item lines in `Sale.items`."
image: "https://developer.sumup.com/og/index.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://developer.sumup.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: SumUp REST API

Payment on a closed sale, for bookkeeping and reconciliation.

Acquirer/processing cost is not on this object. Merchant-charged fees (shipping, service
charge, etc.) appear as `type: "FEE"` item lines in `Sale.items`.

## Fields

- `method` (`PublicPaymentV10.method`; string, required) — Payment method on public sales read API v1.0. Digital wallets are first-class methods. Gift card payments use `gift_card`, not `apm`. Input is case-insensitive; the canonical form is lowercase snake_case. **VALUES**: [card, cash, apm, external, apple_pay, google_pay, whatsapp_pay, gift_card].
  - maxLength 20; example `"card"`
- `reference` (`PublicPaymentV10.reference`; string, required) — The reference to the actual payment used for this sale, e.g. the sumup transaction code.
  - maxLength 50; example `"TERTYFQ4G3"`
- `type` (`PublicPaymentV10.type`; string, required) — Payment operation type. This is distinct from the payment instrument in `method`. Input is case-insensitive; the canonical form is lowercase snake_case. **VALUES**: [purchase, unreferenced_refund] Defaults to "purchase" if unspecified. Either a normal purchase or an unreferenced refund for negative sales like deposit returns.
  - default `"purchase"`; example `"purchase"`
- `amount` (`PublicPaymentV10.amount`; integer, required) — The amount of the payment including tips. The value of the amount in minor units of `Sale.currency`.
  - format `int64`; min 0; example `975`
- `status` (`PublicPaymentV10.status`; string, required) — The status of the payment.
  - one of `"FAILED"`, `"SUCCESSFUL"`, `"CANCELED"`; example `"SUCCESSFUL"`
- `processed_at` (`PublicPaymentV10.processed_at`; string, required) — UTC date-time when SumUp recorded this payment’s exposed `status` (successful, failed, or canceled). Server processed time when available; otherwise the payment provider’s transaction time. Not the device clock.
  - format `date-time`; example `"2017-07-21T17:32:28+01:00"`
- `apm_type` (`PublicPaymentV10.apm_type`; string, optional) — Alternative payment method type when `method` is `apm`. Gift card is not an APM on this API. Input is case-insensitive; the canonical form is lowercase snake_case. **VALUES**: [qr_code_pix, sepa_dd, paypal, sumup_pay, twint, iris].
  - maxLength 20
- `card` (`PublicPaymentV10.card`; object, optional) — Card brand, credit/debit processing type, and last four digits.
  - `brand` (`PublicPaymentV10.card.brand`; string, required) — The brand of the card. Input is case-insensitive; the canonical form is lowercase snake_case. **VALUES**: [amex, cup, diners, discover, elo, elv, hipercard, jcb, maestro, mastercard, visa, visa_electron, visa_vpay, vr, eftpos, conecs, swile, girocard, interac, sumup, bancomat].
    - maxLength 20; example `"visa"`
  - `type` (`PublicPaymentV10.card.type`; string, required) — Credit or debit processing choice, not brand or funding. `unknown` when unavailable; prepaid/voucher are not processing types.
    - one of `"credit"`, `"debit"`, `"unknown"`; example `"debit"`
  - `last_4_digits` (`PublicPaymentV10.card.last_4_digits`; string, required) — The last 4 digits of the card used for the payment.
    - minLength 4; maxLength 4; pattern `^\d{4}$`; example `"1234"`
- `gift_card` (`PublicPaymentV10.gift_card`; object, optional) — Gift card used for this payment. Present when `method` is `gift_card` and the gift card id is known. Gift card IDs use the format "GC" followed by 9 alphanumeric characters (e.g. GCZ3NTMB1V).
  - `id` (`PublicPaymentV10.gift_card.id`; string, required) — Gift card identifier. Format "GC" followed by 9 alphanumeric characters (e.g. GCZ3NTMB1V).
    - example `"GCZ3NTMB1V"`


Source: https://developer.sumup.com/api/schemas/PublicPaymentV10/index.md