snapcasterDevelopers

    API reference · Types

    OrderAdditionPayment

    The buyer’s payment for this offer, or null until one accepts it.

    Type: object or null

    Example

    Generated Schema example: Generated OrderAdditionPayment
    {
  "payment_ref": "string",
  "status": "processing",
  "currency": "string",
  "amount_cents": 0,
  "accepted_at": "string",
  "completes_at": "string",
  "resolved_at": "string",
  "failure_reason": "string",
  "attempts": 0
}

    Fields

    payment_ref string required

    The opaque public payment id (oap_…).

    status string required

    processing means the answer is not in yet - a browser redirect does not prove a payment succeeded, so keep asking. succeeded means the cards are on the order. failed means the attempt collected nothing and the offer can be accepted again. blocked means a captured payment was screened out and returned; this offer is over.

    Constraints: allowed values: processing, succeeded, failed, blocked

    currency string required

    The ISO 4217 currency code used for monetary amounts.

    amount_cents integer required

    The exact amount the buyer approved, frozen from the offer.

    accepted_at string required
    completes_at string required

    When this attempt’s 15-minute completion window closes - distinct from the offer’s own 24 hours. Past it a processing payment is UNKNOWN rather than failed, and is reconciled against the provider.

    resolved_at string or null required
    failure_reason string or null required
    attempts integer required

    Above 1 when a declined card was retried on the same payment.

    Used by