Welcome to the Consumer Data Right Support Portal

Check out our guides, browse through our FAQs, and post your own questions for Support.

New to the Consumer Data Right? Learn more

[ARCHIVE] BankingScheduledPayment INACTIVE status Follow

Avatar
Neale Morison
  • Created:
  • Last edited:
  • Updated

Archived 2022.12.11. Content moved to CDS Guide, Scheduled Payments

Question

For the API Get Scheduled Payments for Account, under BankingScheduledPayment, there is a status field with description "Indicates whether the schedule is currently active". The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.

The field has an enumerated value INACTIVE whose purpose is not clear in the field description.

Property Value
status ACTIVE
status INACTIVE
status SKIP

What does the INACTIVE status mean for Scheduled Payments?

Answer

INACTIVE status was included for situations where a payment schedule exists, and therefore should be shared, but payment schedule has been paused or suspended for some reason.

In the API Get Scheduled Payments Bulk request, there is a field open-status, used to filter accounts depending on whether they are OPEN or CLOSED. If this filter results in returning no corresponding scheduled payments, the HTTP status code returned should be 200 OK, and in the response payload the scheduledPayments field is an empty array.

 

See:

Comments

2 comments

Sort by Date Votes
  • Avatar
    Jakub Vozarik

    Hi Neale Morison and Jarryd

    Wanted to ask a follow-up question to this. With regards to open-status query parameter - is this meant to filter based on account status being open/closed?

    Assuming it is - can a data holder respond with 200 no data to a request for scheduled payments on closed accounts, provided no scheduled payments data is held?

    Thanks

    0
    Comment actions Permalink
  • Avatar
    James Bligh

    Hi Jakub,

    Yes, then open-status parameter is only on the bulk endpoint and is intended to filter the accounts to be included.  For all of the endpoints that operate on a set of accounts the query parameters were consistently applied so the same parameters could be used across multiple endpoints.

    If the applied filters result in a situation where no scheduled payments are to be returned then a 200 should be returned with a response payload with no records.  In this case the 'scheduledPayments' field would be an empty array.

    - James

    1
    Comment actions Permalink

Please sign in to leave a comment.