Package com.commercetools.api.models.payment

Interface PaymentReference

All Superinterfaces:
Identifiable<Payment>, IdentifiableObjHolder<Payment>, Reference, ReferenceMixin
public interface PaymentReference extends Reference, Identifiable<Payment>, IdentifiableObjHolder<Payment>

Reference to a Payment.

Example to create an instance using the builder pattern 

     PaymentReference paymentReference = PaymentReference.builder()
             .id("{id}")
             .build()

  • Field Details

  • Method Details

    • getObj

      @Valid @Valid Payment getObj()

      Contains the representation of the expanded Payment. Only present in responses to requests with Reference Expansion for Payments.

      Specified by:
      getObj in interface IdentifiableObjHolder<Payment>
      Returns:
      obj

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the referenced Payment.

      Specified by:
      getId in interface Identifiable<Payment>
      Specified by:
      getId in interface Reference
      Specified by:
      getId in interface ReferenceMixin
      Returns:
      id

    • setObj

      void setObj(Payment obj)

      Contains the representation of the expanded Payment. Only present in responses to requests with Reference Expansion for Payments.

      Parameters:
      obj - value to be set

    • setId

      void setId(String id)

      Unique identifier of the referenced Payment.

      Specified by:
      setId in interface Reference
      Parameters:
      id - value to be set

    • of

      static PaymentReference of()
      factory method
      Returns:
      instance of PaymentReference

    • of

      static PaymentReference of(PaymentReference template)
      factory method to create a shallow copy PaymentReference
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      PaymentReference copyDeep()
      Specified by:
      copyDeep in interface Reference

    • deepCopy

      @Nullable static PaymentReference deepCopy(@Nullable PaymentReference template)
      factory method to create a deep copy of PaymentReference
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static PaymentReferenceBuilder builder()
      builder factory method for PaymentReference
      Returns:
      builder

    • builder

      static PaymentReferenceBuilder builder(PaymentReference template)
      create builder for PaymentReference instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withPaymentReference

      default <T> T withPaymentReference(Function<PaymentReference,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<PaymentReference> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference