HOME / COMMUNITY Switch to knowledge base

More information regarding clients direct debit status

Hi,

We would like to start emailing our clients to try and get them to set up a direct debit with us, however there is no information regarding this when using the CLIENT_GET request through the API.

It would be very helpful if this information was added in the response message, and the URL for that particular client to sign up with us.

Hi @CraigB

While there isn’t a boolean flag for whether or not there is a direct debit in place, but there is a way of checking.

For example, a Client_Get call, similar to the following, will return one of two results.

Request

    "Body": {
      "ClientID": 123456,
      "ReturnData": {
          "GoCardlessDetails": true
      }
    }

Responses

    "Body": {
      "ClientDetails": {
        "ClientID": 123456,
        "CompanyName": "My Client (no DD)",

        ...

      },
      "GoCardlessDetails": {
        "NewSignUpUrl": "https://www.quickfile.co.uk/gocardless?q=abc......."
      }
    }

OR

    "Body": {
      "ClientDetails": {
        "ClientID": 123456,
        "CompanyName": "My Client (with DD)",
        
        ...

      },
      "GoCardlessDetails": {
        "PreAuthId": "MD..."
      }
    }
  }
}

So with the GoCardlessDetails section, you will either have a NewSignUpUrl (no mandate) or PreAuthId (there is a mandate)

Hope that helps!

1 Like

Hi @QFMathew

Apologies, I completely missed the GoCardlessDetails return data.

That said, thank you for your swift reply, very helpful once again!

1 Like