Version 1.7.1: 06/12/2020

• Few changes to the Payments endpoint responses, including:
  • the GET providers endpoint, required_actions field now becomes an array (as opposed to an object) and is populated with string enums which are now clearly described in the schema.
  • the response of the create Single Payment and Standing Order endpoints now includes a required_action field as opposed to required_actions (since there will only ever be one next required action). If this field appears within the response then clients must take another action in order to complete the payment flow.
  • the payment status endpoint also now includes the required_action field, which if not null, clearly indicates that the client is required to perform the necessary action in order for the payment to complete.
  • updated the payment service enums within the response of the GET providers endpoint, since each provider can now potentially offer domestic-single-payment, domestic-standing-order and (soon to be) domestic-scheduled-payment services.
• Added extra information within the description of various Rent Recognition endpoints. This should provide clients with a much clearer understanding of which endpoints are needed and why in order to integrate the entire RR journey.