Package tbdex.sdk.protocol.models

Class Balance

  • All Implemented Interfaces:
    
public final class Balance
extends Resource

    Balance is a protected resource used to communicate the available amount of each currency held by the PFI on behalf of its customer.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class Balance.Companion

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      ResourceMetadata getMetadata() An object containing fields about the resource
      BalanceData getData() The actual resource content.
      String getSignature() A message or resource signature is a detached compact JWS as defined in RFC-7515
      val balance = Balance.create(from, data)
      Unit setSignature(String signature) A message or resource signature is a detached compact JWS as defined in RFC-7515
      val balance = Balance.create(from, data)

      • Methods inherited from class tbdex.sdk.protocol.models.Resource

        sign, toString, verify

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getData

         BalanceData getData()

        The actual resource content. This will always be a JSON object. The Resource Kinds section specifies the content for each individual resource type

      • getSignature

         String getSignature()

        A message or resource signature is a detached compact JWS as defined in RFC-7515

        val balance = Balance.create(from, data)

      • setSignature

         Unit setSignature(String signature)

        A message or resource signature is a detached compact JWS as defined in RFC-7515

        val balance = Balance.create(from, data)