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
- maxLength:
20Payment method on public sales read API v1.0. Digital wallets are first-class methods. Gift card payments use
gift_card, notapm. Values use lowercase snake_case. Known values arecard,cash,apm,external,apple_pay,google_pay,whatsapp_pay, andgift_card. Additional values may be returned as new payment methods become available.Example:
"card" - maxLength:
50The reference to the actual payment used for this sale, e.g. the sumup transaction code.
Example:
"TERTYFQ4G3" - default:
"purchase"Payment operation type. This is distinct from the payment instrument in
method. Values use lowercase snake_case. Known values arepurchasefor a normal purchase andunreferenced_refundfor negative sales such as deposit returns.Example:
"purchase" - format:
int64minimum:0The amount of the payment including tips. The value of the amount in minor units of
Sale.currency.Example:
975 - Options:
"FAILED""SUCCESSFUL""CANCELED"The status of the payment.
Example:
"SUCCESSFUL" - format:
date-timeUTC 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:
"2026-06-02T10:20:00Z" - apm_typestringmaxLength:
20Alternative payment method type when
methodisapm. Gift card is not an APM on this API. Values use lowercase snake_case. Known values areqr_code_pix,sepa_dd,paypal,sumup_pay,twint, andiris. Additional values may be returned as new alternative payment methods become available. - cardobject
Card brand, credit/debit processing type, and last four digits.
Show 3 properties
- maxLength:
20The 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" - Options:
"credit""debit""unknown"Credit or debit processing choice, not brand or funding.
unknownwhen unavailable; prepaid/voucher are not processing types.Example:
"debit" - 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
methodisgift_cardand the gift card id is known. Gift card IDs use the format "GC" followed by 9 alphanumeric characters (e.g. GCZ3NTMB1V).Show 1 property
Gift card identifier. Format "GC" followed by 9 alphanumeric characters (e.g. GCZ3NTMB1V).
Example:
"GCZ3NTMB1V"