PublicPaymentV10 | SumUp Developer

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

methodstringrequired
maxLength: 20
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].

Example: "card"
referencestringrequired
maxLength: 50
The reference to the actual payment used for this sale, e.g. the sumup transaction code.

Example: "TERTYFQ4G3"
typestringrequired
default: "purchase"
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.

Example: "purchase"
amountintegerrequired
format: int64minimum: 0
The amount of the payment including tips. The value of the amount in minor units of Sale.currency.

Example: 975
statusstringrequired
Options:"FAILED""SUCCESSFUL""CANCELED"
The status of the payment.

Example: "SUCCESSFUL"
processed_atstringrequired
format: date-time
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.

Example: "2017-07-21T17:32:28+01:00"
apm_typestring
maxLength: 20
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].
cardobject
Card brand, credit/debit processing type, and last four digits.
Show 3 properties
- brandstringrequired
  maxLength: 20
  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].
  
  Example: "visa"
- typestringrequired
  Options:"credit""debit""unknown"
  Credit or debit processing choice, not brand or funding. unknown when unavailable; prepaid/voucher are not processing types.
  
  Example: "debit"
- last_4_digitsstringrequired
  minLength: 4maxLength: 4pattern: ^\d{4}$
  The last 4 digits of the card used for the payment.
  
  Example: "1234"
gift_cardobject
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).
Show 1 property
- idstringrequired
  Gift card identifier. Format "GC" followed by 9 alphanumeric characters (e.g. GCZ3NTMB1V).
  
  Example: "GCZ3NTMB1V"