ardohr-ltd / starling-payments-objects

Starling Bank Payments Service data objects
4 stars 1 forks source link

New faster payments status fields on address model #5

Closed judgej closed 6 years ago

judgej commented 6 years ago

The PaymentAccountAddress model has a single status field with the following possible values:

This mixes a couple of concepts, making this status more overloaded than desired. The status will be split into two fields:

status

fasterPaymentsStatus

I need to clarify these details, as there was some ambiguity in the notice I got about this.

The ChangeStatusPaymentAccountAddressRequest model may also get some changes.

judgej commented 6 years ago

Just noticed when creating an account and address, some new fields:

PaymentAccountAddress {#267 ▼
  #paymentBusinessUid: "4b77xxxx-xxxx-xxxx-xxxx-xxxxd454xxxx"
  #accountUid: "5abdfe35-a94b-448c-937b-fa46ad18545c"
  #addressUid: "73fc829c-9b81-4193-b0ae-f81c916075eb"
  #sortCode: "051439"
  #accountNumber: "59375344"
  #createdAt: "2018-02-06T16:40:19.360Z"
  #accountName: "C35705"
  #status: "ACTIVE"
  #_hydratableIsSet: true
  #_exceptionOnInvalidProperty: false
  #_additionalProperties: array:1 [▼ <---
    "fasterPaymentsStatus" => array:2 [▼
      "inboundStatus" => "ENABLED" <---
      "outboundStatus" => "ENABLED" <---
    ]
  ]
  #_rawData: array:9 [▶]
  #success: null
  #errors: null
}

It is the fasterPaymentsStatus with its inboundStatus and outboundStatus properties. This will likely be a new object, though it's not in the documentation yet.

The Starling objects library will put any additional values it finds into the _additionalProperties property, which makes them easy to spot.

judgej commented 6 years ago

The create address response model now has a fasterPaymentsStatus property with a AddressFasterPaymentsStatus object to provide the two statuses. This is in addition to the overall status field.

judgej commented 6 years ago

These are implemented and working.