GoCardless instalment_schedules create_with_dates: 'Invalid document structure' , amount vs total_amount

TL;DR

Use total\amount (not amount) as the top-level key in instalment\schedules.create\with\dates , e.g. total\amount: 10\000 for 100 GBP , and the 'Invalid document structure' error goes away. The maintainer fixed the documentation typo the same day.

Steps

1. The docs example was wrong. Use total_amount (not amount) as the top-level key in instalment_schedules.create_with_dates , e.g. total_amount: 10_000 for 100 GBP , and the 'Invalid document structure' error goes away. The maintainer fixed the documentation typo the same day. Source: https://github.com/gocardless/gocardless-pro-ruby/issues/83
2. Take the question above and check if it matches what you're seeing. If it does, work through the verified fix step by step. Start with the cause described first, because that's what tells you the fix applies to your setup, then apply the changes in the order given. Verify by re-running whatever failed before, and expect the same behavior the thread author reported.

When to use

You are seeing this: Creating an instalment schedule with create\with\dates failed with 'Invalid document structure' even when copying the docs' example params. Use this skill when you run into "GoCardless instalmentschedules createwithdates: 'Invalid document structure' , amount vs totalamount".

When not to use

If your error message or symptom does not match what is described above, this is probably not your fix. Search for your exact error text instead of forcing this one to fit.

Versions

No specific versions are mentioned in the source material, so treat the fix as generally applicable and check the examples against whatever you have installed.

Why this happens

The original report does not dig into a root cause. It documents the symptom and the fix that resolved it.

Sources

• https://github.com/gocardless/gocardless-pro-ruby/issues/83

Someone asked: Creating an instalment schedule with create_with_dates failed with 'Invalid document structure' even when copying the docs' example params. A maintainer found a typo in GoCardless's docs: the top-level amount key must be total_amount. GoCardless corrected the documentation after the maintainer identified the typo. The verified answer: The docs example was wrong. Use total_amount (not amount) as the top-level key in instalment_schedules.create_with_dates , e.g. total_amount: 10_000 for 100 GBP , and the 'Invalid document structure' error goes away. The maintainer fixed the documentation typo the same day. Source: https://github.com/gocardless/gocardless-pro-ruby/issues/83 Discussion and confirmation live at https://vectle.com/threads/thr_7-oSeIhRkElaDROL8YzOJA