From 4e79cd2130362826b368d40582c8815ba99dd8c5 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Mon, 15 Jun 2026 12:40:22 +0000 Subject: [PATCH 01/35] Changes generated by 954c0afb4d49281568105513c90f0d12ded6fcd2 This commit was automatically created from gocardless/client-library-templates@954c0afb4d49281568105513c90f0d12ded6fcd2 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/27546743240 --- package-lock.json | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/package-lock.json b/package-lock.json index 022e806b..f88083f1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2231,9 +2231,9 @@ ] }, "node_modules/acorn": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz", - "integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==", + "version": "8.17.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.17.0.tgz", + "integrity": "sha512-xRQbDb9BnwDafYNn6Vwl839DYVjqXYb1XVGtWAZ1kcDc6iwAL4hg3B1dZlRiuENFeO2H53gFG3in621AdERVAg==", "dev": true, "license": "MIT", "bin": { @@ -2486,9 +2486,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.10.35", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.35.tgz", - "integrity": "sha512-honAfLBde0HAFLdNyBEfuuENkF6zR+ozxqxa/2zJKHBe1qzLqyTSeRKpdPEHAP03rlDGyQOPnCSxnVpVqQo9Mg==", + "version": "2.10.37", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.37.tgz", + "integrity": "sha512-girxaJ7WZssDOFhzCGZTDKoTa1gk6A1TbflaYTpykLJ4UU9Fz9kx1aREM8JCuoVHbL8X8T/mJg7w2oYSq72Oig==", "dev": true, "license": "Apache-2.0", "bin": { @@ -2715,9 +2715,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001797", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001797.tgz", - "integrity": "sha512-l8xKG+gwAIExZGl9FrF7KUwuOmk6wbEPC9Xoy/RtnWv1XG0Q4LFlagaLpUv3Kiza3W/wm27zy0yWJEieYKAP6w==", + "version": "1.0.30001799", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001799.tgz", + "integrity": "sha512-hG1bReV+OUU+MOqK4t/ZWI0tZOyz3rqS9XuhOUz1cIcbwBKjOyJEJuw9ER5JuNyqxNk8u/JUVbGibBOL1yrjFw==", "dev": true, "funding": [ { @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.371", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.371.tgz", - "integrity": "sha512-e9htk9mAYL6AzmkEhSvVVw7IWGSBJ/Bqdn2eRyRLrj1g6sncN4WbFt5qnILYoCktktr45pyjIrOiRvBThQ808w==", + "version": "1.5.372", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.372.tgz", + "integrity": "sha512-M3yhbAlilnwqC8D21t28UCDGHyitShTmmLRU/H+b74P6Ski16Nb9HONYEaVpMj/pwC7BEo5B95FpjODLCWbtfA==", "dev": true, "license": "ISC" }, From d18d575c22a85925bff1ab563873bfd907103a2b Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Tue, 16 Jun 2026 10:05:31 +0000 Subject: [PATCH 02/35] Changes generated by f6b23429e1db4af5f6d559a8933d94ab86835e19 This commit was automatically created from gocardless/client-library-templates@f6b23429e1db4af5f6d559a8933d94ab86835e19 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/27609840302 --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index f88083f1..f78a879d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.372", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.372.tgz", - "integrity": "sha512-M3yhbAlilnwqC8D21t28UCDGHyitShTmmLRU/H+b74P6Ski16Nb9HONYEaVpMj/pwC7BEo5B95FpjODLCWbtfA==", + "version": "1.5.373", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.373.tgz", + "integrity": "sha512-G2Hym8JIf/QreuseqkDibgH8Ci8KfJzqGDKdakbhSx9UltwRBH2cBLAWU/lBX0sCdv0TlhyxQyDCnSfxgMWsjA==", "dev": true, "license": "ISC" }, From 604c3dcb6835e5f0b49f30e58150d3708ad1e266 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Tue, 16 Jun 2026 13:11:25 +0000 Subject: [PATCH 03/35] Changes generated by c1a246cf193597d4a75b4787fe464fa9d5cbf101 This commit was automatically created from gocardless/client-library-templates@c1a246cf193597d4a75b4787fe464fa9d5cbf101 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/27619830471 --- src/services/billingRequestTemplateService.ts | 56 ++----------------- src/types/Types.ts | 41 ++------------ 2 files changed, 9 insertions(+), 88 deletions(-) diff --git a/src/services/billingRequestTemplateService.ts b/src/services/billingRequestTemplateService.ts index 40404c3d..203e1b1b 100644 --- a/src/services/billingRequestTemplateService.ts +++ b/src/services/billingRequestTemplateService.ts @@ -64,33 +64,9 @@ interface BillingRequestTemplateCreateRequest { mandate_request_scheme?: string; - // Verification preference for the mandate. One of: - // - // - // By default, all Billing Requests use the `recommended` verification - // preference. It uses GoCardless payment intelligence solution to determine if - // a payer is fraudulent or not. The verification mechanism is based on the - // response and the payer may be asked to verify themselves. If the feature is - // not available, `recommended` behaves like `minimum`. - // - // If you never wish to take advantage of our reduced risk products and Verified - // Mandates as they are released in new schemes, please use the `minimum` - // verification preference. - // - // See [Billing Requests: Creating Verified - // Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/) - // for more information. + // Verification preference for the mandate. - mandate_request_verify?: `${Types.BillingRequestTemplateMandateRequestVerify}`; + mandate_request_verify?: string; // Key-value store of custom data. Up to 3 keys are permitted, with key names up // to 50 characters and values up to 500 characters. @@ -168,33 +144,9 @@ interface BillingRequestTemplateUpdateRequest { mandate_request_scheme?: string; - // Verification preference for the mandate. One of: - // - // - // By default, all Billing Requests use the `recommended` verification - // preference. It uses GoCardless payment intelligence solution to determine if - // a payer is fraudulent or not. The verification mechanism is based on the - // response and the payer may be asked to verify themselves. If the feature is - // not available, `recommended` behaves like `minimum`. - // - // If you never wish to take advantage of our reduced risk products and Verified - // Mandates as they are released in new schemes, please use the `minimum` - // verification preference. - // - // See [Billing Requests: Creating Verified - // Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/) - // for more information. + // Verification preference for the mandate. - mandate_request_verify?: `${Types.BillingRequestTemplateMandateRequestVerify}`; + mandate_request_verify?: string; // Key-value store of custom data. Up to 3 keys are permitted, with key names up // to 50 characters and values up to 500 characters. diff --git a/src/types/Types.ts b/src/types/Types.ts index 6bd0d737..a6ba43bf 100644 --- a/src/types/Types.ts +++ b/src/types/Types.ts @@ -1552,7 +1552,7 @@ export type BillingRequestTemplate = { // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. - mandate_request_currency?: string; + mandate_request_currency?: string | null; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. @@ -1571,32 +1571,8 @@ export type BillingRequestTemplate = { // from a list of your available schemes. mandate_request_scheme?: string | null; - // Verification preference for the mandate. One of: - // - // - // By default, all Billing Requests use the `recommended` verification - // preference. It uses GoCardless payment intelligence solution to determine - // if a payer is fraudulent or not. The verification mechanism is based on the - // response and the payer may be asked to verify themselves. If the feature is - // not available, `recommended` behaves like `minimum`. - // - // If you never wish to take advantage of our reduced risk products and - // Verified Mandates as they are released in new schemes, please use the - // `minimum` verification preference. - // - // See [Billing Requests: Creating Verified - // Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/) - // for more information. - mandate_request_verify?: `${BillingRequestTemplateMandateRequestVerify}`; + // Verification preference for the mandate. + mandate_request_verify?: string | null; // Key-value store of custom data. Up to 3 keys are permitted, with key names // up to 50 characters and values up to 500 characters. @@ -1607,12 +1583,12 @@ export type BillingRequestTemplate = { name?: string; // Amount in full. - payment_request_amount?: string; + payment_request_amount?: string | null; // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. `GBP` and `EUR` supported; `GBP` with your customers in the UK and // for `EUR` with your customers in supported Eurozone countries only. - payment_request_currency?: string; + payment_request_currency?: string | null; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. @@ -1647,13 +1623,6 @@ export type BillingRequestTemplateCreateRequestLinks = { creditor?: string; }; -export enum BillingRequestTemplateMandateRequestVerify { - Minimum = 'minimum', - Recommended = 'recommended', - WhenAvailable = 'when_available', - Always = 'always', -} - /** Type for a billingrequesttemplatemandaterequestconstraints resource. */ export type BillingRequestTemplateMandateRequestConstraints = { // The latest date at which payments can be taken, must occur after start_date From 5b39a6004243218bcdce59eec2f787e500018ca1 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Wed, 17 Jun 2026 10:41:14 +0000 Subject: [PATCH 04/35] Changes generated by e013f9636cf85e8b930aa03c9fef525b8ab9702a This commit was automatically created from gocardless/client-library-templates@e013f9636cf85e8b930aa03c9fef525b8ab9702a by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/27683052467 --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index f78a879d..e993bd93 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.373", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.373.tgz", - "integrity": "sha512-G2Hym8JIf/QreuseqkDibgH8Ci8KfJzqGDKdakbhSx9UltwRBH2cBLAWU/lBX0sCdv0TlhyxQyDCnSfxgMWsjA==", + "version": "1.5.375", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.375.tgz", + "integrity": "sha512-ZWP5eB4BVPW/ZYo9252hQZHZ5XavtsTgpbhcmMmRwymavC5AsLWQWBPaKMeNd2LW0KGby5HPXvj7+sr4ta5j/Q==", "dev": true, "license": "ISC" }, From d1572e96ed013019a5808330b86422eea2956ab9 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Thu, 18 Jun 2026 09:11:58 +0000 Subject: [PATCH 05/35] Changes generated by c044284e48f384dcbdd21dd9e6c286469afb5d55 This commit was automatically created from gocardless/client-library-templates@c044284e48f384dcbdd21dd9e6c286469afb5d55 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/27749059265 --- package-lock.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index e993bd93..f7aa0fe2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2486,9 +2486,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.10.37", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.37.tgz", - "integrity": "sha512-girxaJ7WZssDOFhzCGZTDKoTa1gk6A1TbflaYTpykLJ4UU9Fz9kx1aREM8JCuoVHbL8X8T/mJg7w2oYSq72Oig==", + "version": "2.10.38", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.38.tgz", + "integrity": "sha512-31/02mVB4yuQU6adKk5SlY6m+mxDwUq5KZkyYgnLrrKl7TEm1+3PyDtDBz2kOv/wxZz41GHsvV1A/u6RmiyBvw==", "dev": true, "license": "Apache-2.0", "bin": { @@ -5422,9 +5422,9 @@ "license": "MIT" }, "node_modules/node-releases": { - "version": "2.0.47", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.47.tgz", - "integrity": "sha512-Uzmd6LXpouKo8EUK68IjH4+E01w/hXyV3R3g/geCJo+rXLNfh1xucB+LOzYEOQPSiUK3h/xZf0cQGcSsmyL2Og==", + "version": "2.0.48", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.48.tgz", + "integrity": "sha512-1uz8041X6LoI6ZSdZacM9lVY28vuzDlSKitnpbSNK0RfKoIJkX29NBPVEFXhnuSuEOA9Ww0xnPJ+ILWbGAv8DA==", "dev": true, "license": "MIT", "engines": { From b92247e1a664b22b69a3f16f435852336190e2df Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Mon, 22 Jun 2026 09:18:25 +0000 Subject: [PATCH 06/35] Changes generated by 893a370c1e1fa2eb153215ac032eb19dbcae5641 This commit was automatically created from gocardless/client-library-templates@893a370c1e1fa2eb153215ac032eb19dbcae5641 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/27942292067 --- package-lock.json | 24 ++++++++++++------------ src/types/Types.ts | 1 + 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/package-lock.json b/package-lock.json index f7aa0fe2..3416e68e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.375", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.375.tgz", - "integrity": "sha512-ZWP5eB4BVPW/ZYo9252hQZHZ5XavtsTgpbhcmMmRwymavC5AsLWQWBPaKMeNd2LW0KGby5HPXvj7+sr4ta5j/Q==", + "version": "1.5.376", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.376.tgz", + "integrity": "sha512-cUVA7/RvbFTEuw/i3obUwDTRIXojaxkResf+ibByPFxjc6XK3VNtcQXV0NSbAlJ0FMjcJGgftVVB4Qo184EXvA==", "dev": true, "license": "ISC" }, @@ -6489,9 +6489,9 @@ "license": "ISC" }, "node_modules/semver": { - "version": "7.8.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.4.tgz", - "integrity": "sha512-rUCObTnP32Q08R2uuIrt7r9PlEonuTmtuXYcW6s5kjdlj3xbnwe+21yXptAUYcMAABLkYYTtnmzb3w3EDZfueA==", + "version": "7.8.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz", + "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==", "dev": true, "license": "ISC", "bin": { @@ -7160,9 +7160,9 @@ } }, "node_modules/uuid": { - "version": "14.0.0", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-14.0.0.tgz", - "integrity": "sha512-Qo+uWgilfSmAhXCMav1uYFynlQO7fMFiMVZsQqZRMIXp0O7rR7qjkj+cPvBHLgBqi960QCoo/PH2/6ZtVqKvrg==", + "version": "14.0.1", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-14.0.1.tgz", + "integrity": "sha512-6ZxzVpzDXDa3bJWaHilVayA+BH/1zmxCJoVgvmqJnid/gPoKHxUrS/aC/T6LGQtNHT+XHG9fXPJB4d+IrU30Ew==", "funding": [ "https://github.com/sponsors/broofa", "https://github.com/sponsors/ctavan" @@ -7428,9 +7428,9 @@ "license": "ISC" }, "node_modules/yargs": { - "version": "17.7.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", - "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", + "version": "17.7.3", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.3.tgz", + "integrity": "sha512-GZtjxm/J/4TSxuL3FNYjCmLktBTnIw/rVmKSIyKeYAZpmJB2ig9VauCC5xsa82GNKVKDAqpOn3KVzNt0zmrU0g==", "dev": true, "license": "MIT", "dependencies": { diff --git a/src/types/Types.ts b/src/types/Types.ts index a6ba43bf..487cabe7 100644 --- a/src/types/Types.ts +++ b/src/types/Types.ts @@ -4543,6 +4543,7 @@ export enum ExportExportType { PartnerFees = 'partner_fees', PaymentsImportTemplate = 'payments_import_template', PaymentAccountStatement = 'payment_account_statement', + OutboundPaymentsIndex = 'outbound_payments_index', } /** Type for a fundsavailability resource. */ From 86fd7f20de144e3dbe62999fdcad4e8b41633f24 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Tue, 23 Jun 2026 12:21:56 +0000 Subject: [PATCH 07/35] Changes generated by 06d9e2b0f0d8f492f0524a746b2450f91606e9c9 This commit was automatically created from gocardless/client-library-templates@06d9e2b0f0d8f492f0524a746b2450f91606e9c9 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/28025677221 --- package-lock.json | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/package-lock.json b/package-lock.json index 3416e68e..8eb9187c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1513,9 +1513,9 @@ } }, "node_modules/@tybys/wasm-util": { - "version": "0.10.2", - "resolved": "https://registry.npmjs.org/@tybys/wasm-util/-/wasm-util-0.10.2.tgz", - "integrity": "sha512-RoBvJ2X0wuKlWFIjrwffGw1IqZHKQqzIchKaadZZfnNpsAYp2mM0h36JtPCjNDAHGgYez/15uMBpfGwchhiMgg==", + "version": "0.10.3", + "resolved": "https://registry.npmjs.org/@tybys/wasm-util/-/wasm-util-0.10.3.tgz", + "integrity": "sha512-F3fo1MYrRJYL3zER0OUOmkutjr1Vp23m7OsSgp7nq4SP6OqX6C/56XFIPAl5bt3zaBRjmW7SGz3u/6LwFpYcOg==", "dev": true, "license": "MIT", "optional": true, @@ -1911,9 +1911,9 @@ } }, "node_modules/@ungap/structured-clone": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.1.tgz", - "integrity": "sha512-mUFwbeTqrVgDQxFveS+df2yfap6iuP20NAKAsBt5jDEoOTDew+zwLAOilHCeQJOVSvmgCX4ogqIrA0mnyr08yQ==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.2.tgz", + "integrity": "sha512-5jsZFwgR5rTdKwidH9Qmat75RKwqfpKlWWB1frDkljN127mwqBu8K0PYo7/hFpF03IEJpfVPpCQDY/eDx3iHvA==", "dev": true, "license": "ISC" }, @@ -2530,9 +2530,9 @@ } }, "node_modules/browserslist": { - "version": "4.28.2", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.2.tgz", - "integrity": "sha512-48xSriZYYg+8qXna9kwqjIVzuQxi+KYWp2+5nCYnYKPTr0LvD89Jqk2Or5ogxz0NUMfIjhh2lIUX/LyX9B4oIg==", + "version": "4.28.4", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.4.tgz", + "integrity": "sha512-MTc8i/x9jBQd1iMw2CFGS+rwMa07eYjLR0CCTLDACl9xhxy+nIs3KeML/biicXtk9JrZ6dnnTatmc7ErPXIxqw==", "dev": true, "funding": [ { @@ -2550,10 +2550,10 @@ ], "license": "MIT", "dependencies": { - "baseline-browser-mapping": "^2.10.12", - "caniuse-lite": "^1.0.30001782", - "electron-to-chromium": "^1.5.328", - "node-releases": "^2.0.36", + "baseline-browser-mapping": "^2.10.38", + "caniuse-lite": "^1.0.30001799", + "electron-to-chromium": "^1.5.376", + "node-releases": "^2.0.48", "update-browserslist-db": "^1.2.3" }, "bin": { @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.376", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.376.tgz", - "integrity": "sha512-cUVA7/RvbFTEuw/i3obUwDTRIXojaxkResf+ibByPFxjc6XK3VNtcQXV0NSbAlJ0FMjcJGgftVVB4Qo184EXvA==", + "version": "1.5.377", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.377.tgz", + "integrity": "sha512-cH1jZgJHoezfTnKfKwnScpHywTFVnJUNITDPREFdhNjiuD502+QFpG0Qk7G8jhsV/f+CEAFlIrzP1fT+IMb92g==", "dev": true, "license": "ISC" }, From 5e88b20547dbd4573b7f27e8f0c20c749c66c0e7 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Wed, 24 Jun 2026 13:06:56 +0000 Subject: [PATCH 08/35] Changes generated by 4a3dbd08ce76970c2141ebcf5ee47aa595ac7d58 This commit was automatically created from gocardless/client-library-templates@4a3dbd08ce76970c2141ebcf5ee47aa595ac7d58 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/28100566294 --- package-lock.json | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/package-lock.json b/package-lock.json index 8eb9187c..fff0f46b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1289,14 +1289,14 @@ } }, "node_modules/@napi-rs/wasm-runtime": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/@napi-rs/wasm-runtime/-/wasm-runtime-1.1.5.tgz", - "integrity": "sha512-AWPoBRJ9tsnVhor4sjO7rkni+7p+2IAEFj6cx06UgP10jkQHqay/36uRV/bFkgrh18D9vb4cr8Q0Pthskgzy+Q==", + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/@napi-rs/wasm-runtime/-/wasm-runtime-1.1.6.tgz", + "integrity": "sha512-ZLv/JdUfkvOy9eCnnBaGfiO+XimbjebAeO+MRQqD/B+FR1tnRN0tpKSJHRbE8sFfS6aqsXZ67TQjfwfsxULVbg==", "dev": true, "license": "MIT", "optional": true, "dependencies": { - "@tybys/wasm-util": "^0.10.2" + "@tybys/wasm-util": "^0.10.3" }, "funding": { "type": "github", @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.377", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.377.tgz", - "integrity": "sha512-cH1jZgJHoezfTnKfKwnScpHywTFVnJUNITDPREFdhNjiuD502+QFpG0Qk7G8jhsV/f+CEAFlIrzP1fT+IMb92g==", + "version": "1.5.378", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.378.tgz", + "integrity": "sha512-VinvOAuuPmdD1guEgGv5f2Qp7/vlfqOrUOMYNnOD4wj3pit8kRsQHzfIf6teyUGWo15Tg5+bOJaRunvyltpVWQ==", "dev": true, "license": "ISC" }, @@ -5422,9 +5422,9 @@ "license": "MIT" }, "node_modules/node-releases": { - "version": "2.0.48", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.48.tgz", - "integrity": "sha512-1uz8041X6LoI6ZSdZacM9lVY28vuzDlSKitnpbSNK0RfKoIJkX29NBPVEFXhnuSuEOA9Ww0xnPJ+ILWbGAv8DA==", + "version": "2.0.49", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.49.tgz", + "integrity": "sha512-f06bl1D+8ZDkn2oOQQKAh5/otFWqVnM1Q5oerA8Pex7UfT66Tx4IPHIqVVFKqFT3FUtaDstdgkM7yT7JWhqxfw==", "dev": true, "license": "MIT", "engines": { From 5ed6f3863c223841237781fc05350ec6fac4f457 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Fri, 26 Jun 2026 10:48:47 +0000 Subject: [PATCH 09/35] Changes generated by d97c5f53b394eaa852733dc030b77590b491794c This commit was automatically created from gocardless/client-library-templates@d97c5f53b394eaa852733dc030b77590b491794c by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/28233224177 --- package-lock.json | 27 ++++++++++++++------------- src/types/Types.ts | 6 ++++++ 2 files changed, 20 insertions(+), 13 deletions(-) diff --git a/package-lock.json b/package-lock.json index fff0f46b..4e4e51dc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2486,9 +2486,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.10.38", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.38.tgz", - "integrity": "sha512-31/02mVB4yuQU6adKk5SlY6m+mxDwUq5KZkyYgnLrrKl7TEm1+3PyDtDBz2kOv/wxZz41GHsvV1A/u6RmiyBvw==", + "version": "2.10.40", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.40.tgz", + "integrity": "sha512-BSSLZ9/Cjjv7Gtj5B68ZzXcXUg8iOf3fme+FCuh8rC/Go+Kmh8cox7M3A8dolou16s64QjLPOSdngh7GxXvkSw==", "dev": true, "license": "Apache-2.0", "bin": { @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.378", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.378.tgz", - "integrity": "sha512-VinvOAuuPmdD1guEgGv5f2Qp7/vlfqOrUOMYNnOD4wj3pit8kRsQHzfIf6teyUGWo15Tg5+bOJaRunvyltpVWQ==", + "version": "1.5.379", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.379.tgz", + "integrity": "sha512-v/qV5aV5EUA2pGilzUCq5/eyOloZAqDZBu9UMBIzgPpLlprjSR6zswsWBTv0KpqxLGUAZEwhO95ZCt7srymNVA==", "dev": true, "license": "ISC" }, @@ -5422,9 +5422,9 @@ "license": "MIT" }, "node_modules/node-releases": { - "version": "2.0.49", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.49.tgz", - "integrity": "sha512-f06bl1D+8ZDkn2oOQQKAh5/otFWqVnM1Q5oerA8Pex7UfT66Tx4IPHIqVVFKqFT3FUtaDstdgkM7yT7JWhqxfw==", + "version": "2.0.50", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.50.tgz", + "integrity": "sha512-J6l92tKHX6w8Jy5nO1Vuc01NoIiRGi/d6qBKVxh+IQ8Cr3b6HbVNfKiF8ZpFKufTwpwxMmce2W3iQZ861ZRyTg==", "dev": true, "license": "MIT", "engines": { @@ -6259,12 +6259,13 @@ "license": "MIT" }, "node_modules/qs": { - "version": "6.15.2", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.15.2.tgz", - "integrity": "sha512-Rzq0KEyX/w/tEybncDgdkZrJgVUsUMk3xjh3t5bv3S1HTAtg+uOYt72+ZfwiQwKdysThkTBdL/rTi6HDmX9Ddw==", + "version": "6.15.3", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.15.3.tgz", + "integrity": "sha512-O9gl3zCl5h5blw1KGUzQKhA5oUXSl8rwUIM5o0S3nCXMliSvy5Dzx7/DJcI+SwgICv+IneSZwhBh1oSyEHA71A==", "license": "BSD-3-Clause", "dependencies": { - "side-channel": "^1.1.0" + "es-define-property": "^1.0.1", + "side-channel": "^1.1.1" }, "engines": { "node": ">=0.6" diff --git a/src/types/Types.ts b/src/types/Types.ts index 487cabe7..f267ba0f 100644 --- a/src/types/Types.ts +++ b/src/types/Types.ts @@ -7468,6 +7468,9 @@ export type VerificationDetail = { // The company's registration number. company_number?: string; + // The country code of the company's address. + country_code?: string; + // A summary describing what the company does. description?: string; @@ -7482,6 +7485,9 @@ export type VerificationDetail = { // The company's postal code. postal_code?: string; + + // The region of the company's address. + region?: string | null; }; /** Type for a verificationdetailcreaterequestlinks resource. */ From f3543dcd8ee573ff87cb0765a2e459d9476633b2 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Mon, 29 Jun 2026 09:30:02 +0000 Subject: [PATCH 10/35] Changes generated by 9472ef74550235eb4a7850c7fd27f4a2a0f6aef5 This commit was automatically created from gocardless/client-library-templates@9472ef74550235eb4a7850c7fd27f4a2a0f6aef5 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/28362216004 --- package-lock.json | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index 4e4e51dc..57931b80 100644 --- a/package-lock.json +++ b/package-lock.json @@ -773,9 +773,9 @@ } }, "node_modules/@istanbuljs/load-nyc-config/node_modules/js-yaml": { - "version": "3.14.2", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.2.tgz", - "integrity": "sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg==", + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.15.0.tgz", + "integrity": "sha512-ttBQIIQPDeLjpPOohtUdXuXUVoA2uIB6fEH9HyJ7234s5mBJ5wTx20njxplLZQgLaOfpmPQA7X2t5AX6tIPbog==", "dev": true, "license": "MIT", "dependencies": { @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.379", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.379.tgz", - "integrity": "sha512-v/qV5aV5EUA2pGilzUCq5/eyOloZAqDZBu9UMBIzgPpLlprjSR6zswsWBTv0KpqxLGUAZEwhO95ZCt7srymNVA==", + "version": "1.5.380", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.380.tgz", + "integrity": "sha512-W6d5AbuEoRayO447cqrg6lKJIlscgRnnxOZl/08kfV71BQDoEBC7Wwis68z87LjyK6f4kWyTaubuDbhHKrZkbA==", "dev": true, "license": "ISC" }, @@ -4917,9 +4917,9 @@ "license": "MIT" }, "node_modules/js-yaml": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.2.0.tgz", - "integrity": "sha512-ePWsvanv0DWuDRsW8dnt+R4jQ31SCRCQ7hhNcPXZPsoBZiemuZNYGf7adZdqX2D86j6rvKp3RpCxVTSb8WQlOw==", + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.3.0.tgz", + "integrity": "sha512-1td788aAnnZ5qs7V2QIRl1owjtYpbKt749Y3xauqQgwIIGF/xXWz1wMTEBx5O3LK3lXLVuqXPdPxj2BoFHaW9Q==", "dev": true, "funding": [ { From e42a5ef3d27088d55f18573a3c9d2783b05bdc7c Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Fri, 3 Jul 2026 08:43:36 +0000 Subject: [PATCH 11/35] Changes generated by c8b2b85ecec13373a17e4667caacd41aab5d2c62 This commit was automatically created from gocardless/client-library-templates@c8b2b85ecec13373a17e4667caacd41aab5d2c62 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/28649088961 --- package-lock.json | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/package-lock.json b/package-lock.json index 57931b80..7bc887a3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2486,9 +2486,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.10.40", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.40.tgz", - "integrity": "sha512-BSSLZ9/Cjjv7Gtj5B68ZzXcXUg8iOf3fme+FCuh8rC/Go+Kmh8cox7M3A8dolou16s64QjLPOSdngh7GxXvkSw==", + "version": "2.10.41", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.41.tgz", + "integrity": "sha512-WwS7MHhqGHHlaVsqRZnhvCEMS0owDX+SxRlve7JkuH7My1Ara3ZriTmCQupPfYjxMZ8I/tgxtJYr2t7taHaH4A==", "dev": true, "license": "Apache-2.0", "bin": { @@ -2715,9 +2715,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001799", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001799.tgz", - "integrity": "sha512-hG1bReV+OUU+MOqK4t/ZWI0tZOyz3rqS9XuhOUz1cIcbwBKjOyJEJuw9ER5JuNyqxNk8u/JUVbGibBOL1yrjFw==", + "version": "1.0.30001800", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001800.tgz", + "integrity": "sha512-MMHtuAz9Ys840zAY5F4k6fV5GaivZ9sPk+nz0mY+GYVzRBnYkN0mpqkSR92oWRQ19yQWo4HvBV/FnC16AJX8MA==", "dev": true, "funding": [ { @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.380", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.380.tgz", - "integrity": "sha512-W6d5AbuEoRayO447cqrg6lKJIlscgRnnxOZl/08kfV71BQDoEBC7Wwis68z87LjyK6f4kWyTaubuDbhHKrZkbA==", + "version": "1.5.385", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.385.tgz", + "integrity": "sha512-78sa/M08MNAYHQfjoWMvOlKQqZ0ElhSm/L5HNUc96VZ3b+KvDVnngFm8sYQy0XrhTRgAhggHr5abA7yTvRdo4Q==", "dev": true, "license": "ISC" }, @@ -5683,9 +5683,9 @@ "license": "ISC" }, "node_modules/picomatch": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", - "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", + "version": "4.0.5", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.5.tgz", + "integrity": "sha512-RvwwcruNjI1ncT5xRakeyS9Lf8lcItv34KD+aif+VH9kduAyfYBipGh12274xtenIPZ119/R9BdTBa8gAwSh0A==", "dev": true, "license": "MIT", "engines": { From acd5fa3659bcb9c73931b2f117b3cc1fb548bab3 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Tue, 7 Jul 2026 10:45:06 +0000 Subject: [PATCH 12/35] Changes generated by 5bc32e9481786eea9c3d32e230fdacc4a3d47f50 This commit was automatically created from gocardless/client-library-templates@5bc32e9481786eea9c3d32e230fdacc4a3d47f50 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/28860199105 --- package-lock.json | 32 ++-- src/services/paymentService.ts | 4 + src/types/Types.ts | 296 ++++++++++++++++++++++++--------- 3 files changed, 240 insertions(+), 92 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7bc887a3..619e6e7e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2486,9 +2486,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.10.41", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.41.tgz", - "integrity": "sha512-WwS7MHhqGHHlaVsqRZnhvCEMS0owDX+SxRlve7JkuH7My1Ara3ZriTmCQupPfYjxMZ8I/tgxtJYr2t7taHaH4A==", + "version": "2.10.42", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.42.tgz", + "integrity": "sha512-c/jurFrDLyui7o1J86yLkRu4LMsTYcBohveus7/I2Hzdn9KIP2bdJPTue/lR1KH46enoPbD77GKeSYNdyPoD3Q==", "dev": true, "license": "Apache-2.0", "bin": { @@ -2530,9 +2530,9 @@ } }, "node_modules/browserslist": { - "version": "4.28.4", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.4.tgz", - "integrity": "sha512-MTc8i/x9jBQd1iMw2CFGS+rwMa07eYjLR0CCTLDACl9xhxy+nIs3KeML/biicXtk9JrZ6dnnTatmc7ErPXIxqw==", + "version": "4.28.5", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.5.tgz", + "integrity": "sha512-Cu2E6QejHWzuDMTkuwgpABFgDfZrXLQq5V13YOACZx4mFAG4IwGTbTfHPMr4WtxlHoXSM8FIuRwYYCz5XiabaQ==", "dev": true, "funding": [ { @@ -2550,10 +2550,10 @@ ], "license": "MIT", "dependencies": { - "baseline-browser-mapping": "^2.10.38", - "caniuse-lite": "^1.0.30001799", - "electron-to-chromium": "^1.5.376", - "node-releases": "^2.0.48", + "baseline-browser-mapping": "^2.10.42", + "caniuse-lite": "^1.0.30001800", + "electron-to-chromium": "^1.5.387", + "node-releases": "^2.0.50", "update-browserslist-db": "^1.2.3" }, "bin": { @@ -2715,9 +2715,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001800", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001800.tgz", - "integrity": "sha512-MMHtuAz9Ys840zAY5F4k6fV5GaivZ9sPk+nz0mY+GYVzRBnYkN0mpqkSR92oWRQ19yQWo4HvBV/FnC16AJX8MA==", + "version": "1.0.30001803", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001803.tgz", + "integrity": "sha512-g/uHREV2ZpK9qMalCsWaxmA6ol+DX8GYhuf3T40RKoP+oL7vhRJh8LNt73PCjpnR6l14FzfPrB5Yux4PKm2meg==", "dev": true, "funding": [ { @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.385", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.385.tgz", - "integrity": "sha512-78sa/M08MNAYHQfjoWMvOlKQqZ0ElhSm/L5HNUc96VZ3b+KvDVnngFm8sYQy0XrhTRgAhggHr5abA7yTvRdo4Q==", + "version": "1.5.388", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.388.tgz", + "integrity": "sha512-Pl/aJaqOOxYxda3vcx1IKSJimwYXHDkEnGn0F+kG2EE68dDtx2uCinaS+Vih8Z91B9t8CSAbiF/HKyWcnXjhzw==", "dev": true, "license": "ISC" }, diff --git a/src/services/paymentService.ts b/src/services/paymentService.ts index bbd3408d..40f6a47b 100644 --- a/src/services/paymentService.ts +++ b/src/services/paymentService.ts @@ -11,6 +11,10 @@ interface PaymentListResponse extends Types.APIResponse { interface PaymentCreateRequest { // Amount, in the lowest denomination for the currency (e.g. pence in GBP, cents // in EUR). + // + // For Variable Recurring Payments (VRP), this must not exceed the mandate's + // `max_amount_per_payment` + // constraint. amount: string; diff --git a/src/types/Types.ts b/src/types/Types.ts index f267ba0f..f8bbf7cb 100644 --- a/src/types/Types.ts +++ b/src/types/Types.ts @@ -698,6 +698,10 @@ export type BillingRequestInstalmentScheduleRequest = { export type BillingRequestInstalmentScheduleRequestInstalmentsWithDate = { // Amount, in the lowest denomination for the currency (e.g. pence in GBP, // cents in EUR). + // + // For Variable Recurring Payments (VRP), this must not exceed the mandate's + // `max_amount_per_payment` + // constraint. amount: string; // A future date on which the payment should be collected. If the date @@ -931,17 +935,27 @@ export type BillingRequestMandateRequestConstraints = { // end_date?: string; - // The maximum amount that can be charged for a single payment. Required for - // PayTo and VRP. + // The maximum amount that can be charged for a single payment in the lowest + // denomination for the currency (e.g. pence in GBP, cents in EUR). _Note:_ + // Required for PayTo and VRP. max_amount_per_payment?: number; // A constraint where you can specify info (free text string) about how - // payments are calculated. _Note:_ This is only supported for ACH and PAD - // schemes. + // payments are calculated. For use when payments vary and cannot be expressed + // as a fixed amount and frequency. _Note:_ This is only supported for ACH and + // PAD schemes. // payment_method?: string; - // List of periodic limits and constraints which apply to them + // Caps on the total amount and/or number of payments that can be collected + // within a + // repeating period (e.g. no more than a set amount per month), as opposed to + // `max_amount_per_payment` which caps a single payment. + // + // _Note:_ Required for VRP, where exactly one periodic limit must be + // provided. Optional for + // PayTo. + // periodic_limits?: BillingRequestMandateRequestConstraintsPeriodicLimit[]; // The date from which payments can be taken. @@ -955,32 +969,54 @@ export type BillingRequestMandateRequestConstraints = { /** Type for a billingrequestmandaterequestconstraintsperiodiclimit resource. */ export type BillingRequestMandateRequestConstraintsPeriodicLimit = { - // The alignment of the period. - // - // `calendar` - this will finish on the end of the current period. For example - // this will expire on the Monday for the current week or the January for the - // next year. - // - // `creation_date` - this will finish on the next instance of the current - // period. For example Monthly it will expire on the same day of the next - // month, or yearly the same day of the next year. + // The alignment of the period. Defaults to `creation_date` if not specified. + // + // `calendar` - the period follows fixed calendar boundaries, the same for + // every mandate: + // `week` runs Monday to Sunday, `month` runs from the 1st to the last day of + // the calendar + // month, and `year` runs from 1 January to 31 December. If the mandate starts + // partway + // through a period, the limit for that first period is reduced proportionally + // to the days + // remaining (e.g. a monthly limit starting on the 15th gives roughly half the + // limit for + // that first month). + // + // `creation_date` - the period follows the mandate's own start date rather + // than the + // calendar. For example, if the mandate starts on the 15th, each monthly + // period runs from + // the 15th to the 14th of the following month. The first period is a full + // period, not + // reduced proportionally. + // + // _Note:_ Has no effect when period is `flexible`. // alignment?: `${BillingRequestMandateRequestConstraintsPeriodicLimitAlignment}`; // The maximum number of payments that can be collected in this periodic // limit. - // _Note:_ This is only supported for the PayTo scheme, where it is required. + // + // _Note:_ Only supported for the PayTo scheme, where it is optional. // max_payments?: number; // The maximum total amount that can be charged for all payments in this - // periodic limit. - // Required for VRP. + // periodic limit, + // in the lowest denomination for the currency (e.g. pence in GBP, cents in + // EUR). + // + // _Note:_ Required for VRP. This is not permitted for the PayTo scheme. // max_total_amount?: number; - // The repeating period for this mandate. Defaults to flexible for PayTo if - // not specified. + // The repeating period for this mandate. Required whenever a periodic limit + // is provided + // (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, + // this + // defaults to flexible. + // period?: `${BillingRequestMandateRequestConstraintsPeriodicLimitPeriod}`; }; @@ -1636,17 +1672,27 @@ export type BillingRequestTemplateMandateRequestConstraints = { // end_date?: string; - // The maximum amount that can be charged for a single payment. Required for - // PayTo and VRP. + // The maximum amount that can be charged for a single payment in the lowest + // denomination for the currency (e.g. pence in GBP, cents in EUR). _Note:_ + // Required for PayTo and VRP. max_amount_per_payment?: number; // A constraint where you can specify info (free text string) about how - // payments are calculated. _Note:_ This is only supported for ACH and PAD - // schemes. + // payments are calculated. For use when payments vary and cannot be expressed + // as a fixed amount and frequency. _Note:_ This is only supported for ACH and + // PAD schemes. // payment_method?: string; - // List of periodic limits and constraints which apply to them + // Caps on the total amount and/or number of payments that can be collected + // within a + // repeating period (e.g. no more than a set amount per month), as opposed to + // `max_amount_per_payment` which caps a single payment. + // + // _Note:_ Required for VRP, where exactly one periodic limit must be + // provided. Optional for + // PayTo. + // periodic_limits?: BillingRequestTemplateMandateRequestConstraintsPeriodicLimit[]; // The date from which payments can be taken. @@ -1660,32 +1706,54 @@ export type BillingRequestTemplateMandateRequestConstraints = { /** Type for a billingrequesttemplatemandaterequestconstraintsperiodiclimit resource. */ export type BillingRequestTemplateMandateRequestConstraintsPeriodicLimit = { - // The alignment of the period. - // - // `calendar` - this will finish on the end of the current period. For example - // this will expire on the Monday for the current week or the January for the - // next year. - // - // `creation_date` - this will finish on the next instance of the current - // period. For example Monthly it will expire on the same day of the next - // month, or yearly the same day of the next year. + // The alignment of the period. Defaults to `creation_date` if not specified. + // + // `calendar` - the period follows fixed calendar boundaries, the same for + // every mandate: + // `week` runs Monday to Sunday, `month` runs from the 1st to the last day of + // the calendar + // month, and `year` runs from 1 January to 31 December. If the mandate starts + // partway + // through a period, the limit for that first period is reduced proportionally + // to the days + // remaining (e.g. a monthly limit starting on the 15th gives roughly half the + // limit for + // that first month). + // + // `creation_date` - the period follows the mandate's own start date rather + // than the + // calendar. For example, if the mandate starts on the 15th, each monthly + // period runs from + // the 15th to the 14th of the following month. The first period is a full + // period, not + // reduced proportionally. + // + // _Note:_ Has no effect when period is `flexible`. // alignment?: `${BillingRequestTemplateMandateRequestConstraintsPeriodicLimitAlignment}`; // The maximum number of payments that can be collected in this periodic // limit. - // _Note:_ This is only supported for the PayTo scheme, where it is required. + // + // _Note:_ Only supported for the PayTo scheme, where it is optional. // max_payments?: number; // The maximum total amount that can be charged for all payments in this - // periodic limit. - // Required for VRP. + // periodic limit, + // in the lowest denomination for the currency (e.g. pence in GBP, cents in + // EUR). + // + // _Note:_ Required for VRP. This is not permitted for the PayTo scheme. // max_total_amount?: number; - // The repeating period for this mandate. Defaults to flexible for PayTo if - // not specified. + // The repeating period for this mandate. Required whenever a periodic limit + // is provided + // (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, + // this + // defaults to flexible. + // period?: `${BillingRequestTemplateMandateRequestConstraintsPeriodicLimitPeriod}`; }; @@ -2058,17 +2126,27 @@ export type BillingRequestWithActionMandateRequestConstraints = { // end_date?: string; - // The maximum amount that can be charged for a single payment. Required for - // PayTo and VRP. + // The maximum amount that can be charged for a single payment in the lowest + // denomination for the currency (e.g. pence in GBP, cents in EUR). _Note:_ + // Required for PayTo and VRP. max_amount_per_payment?: number; // A constraint where you can specify info (free text string) about how - // payments are calculated. _Note:_ This is only supported for ACH and PAD - // schemes. + // payments are calculated. For use when payments vary and cannot be expressed + // as a fixed amount and frequency. _Note:_ This is only supported for ACH and + // PAD schemes. // payment_method?: string; - // List of periodic limits and constraints which apply to them + // Caps on the total amount and/or number of payments that can be collected + // within a + // repeating period (e.g. no more than a set amount per month), as opposed to + // `max_amount_per_payment` which caps a single payment. + // + // _Note:_ Required for VRP, where exactly one periodic limit must be + // provided. Optional for + // PayTo. + // periodic_limits?: BillingRequestWithActionMandateRequestConstraintsPeriodicLimit[]; // The date from which payments can be taken. @@ -2082,32 +2160,54 @@ export type BillingRequestWithActionMandateRequestConstraints = { /** Type for a billingrequestwithactionmandaterequestconstraintsperiodiclimit resource. */ export type BillingRequestWithActionMandateRequestConstraintsPeriodicLimit = { - // The alignment of the period. - // - // `calendar` - this will finish on the end of the current period. For example - // this will expire on the Monday for the current week or the January for the - // next year. - // - // `creation_date` - this will finish on the next instance of the current - // period. For example Monthly it will expire on the same day of the next - // month, or yearly the same day of the next year. + // The alignment of the period. Defaults to `creation_date` if not specified. + // + // `calendar` - the period follows fixed calendar boundaries, the same for + // every mandate: + // `week` runs Monday to Sunday, `month` runs from the 1st to the last day of + // the calendar + // month, and `year` runs from 1 January to 31 December. If the mandate starts + // partway + // through a period, the limit for that first period is reduced proportionally + // to the days + // remaining (e.g. a monthly limit starting on the 15th gives roughly half the + // limit for + // that first month). + // + // `creation_date` - the period follows the mandate's own start date rather + // than the + // calendar. For example, if the mandate starts on the 15th, each monthly + // period runs from + // the 15th to the 14th of the following month. The first period is a full + // period, not + // reduced proportionally. + // + // _Note:_ Has no effect when period is `flexible`. // alignment?: `${BillingRequestWithActionMandateRequestConstraintsPeriodicLimitAlignment}`; // The maximum number of payments that can be collected in this periodic // limit. - // _Note:_ This is only supported for the PayTo scheme, where it is required. + // + // _Note:_ Only supported for the PayTo scheme, where it is optional. // max_payments?: number; // The maximum total amount that can be charged for all payments in this - // periodic limit. - // Required for VRP. + // periodic limit, + // in the lowest denomination for the currency (e.g. pence in GBP, cents in + // EUR). + // + // _Note:_ Required for VRP. This is not permitted for the PayTo scheme. // max_total_amount?: number; - // The repeating period for this mandate. Defaults to flexible for PayTo if - // not specified. + // The repeating period for this mandate. Required whenever a periodic limit + // is provided + // (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, + // this + // defaults to flexible. + // period?: `${BillingRequestWithActionMandateRequestConstraintsPeriodicLimitPeriod}`; }; @@ -2789,6 +2889,10 @@ export type BillingRequestWithActionBillingRequestsInstalmentScheduleRequest = { export type BillingRequestWithActionBillingRequestsInstalmentScheduleRequestInstalmentsWithDate = { // Amount, in the lowest denomination for the currency (e.g. pence in GBP, // cents in EUR). + // + // For Variable Recurring Payments (VRP), this must not exceed the mandate's + // `max_amount_per_payment` + // constraint. amount: string; // A future date on which the payment should be collected. If the date @@ -3022,17 +3126,27 @@ export type BillingRequestWithActionBillingRequestsMandateRequestConstraints = { // end_date?: string; - // The maximum amount that can be charged for a single payment. Required for - // PayTo and VRP. + // The maximum amount that can be charged for a single payment in the lowest + // denomination for the currency (e.g. pence in GBP, cents in EUR). _Note:_ + // Required for PayTo and VRP. max_amount_per_payment?: number; // A constraint where you can specify info (free text string) about how - // payments are calculated. _Note:_ This is only supported for ACH and PAD - // schemes. + // payments are calculated. For use when payments vary and cannot be expressed + // as a fixed amount and frequency. _Note:_ This is only supported for ACH and + // PAD schemes. // payment_method?: string; - // List of periodic limits and constraints which apply to them + // Caps on the total amount and/or number of payments that can be collected + // within a + // repeating period (e.g. no more than a set amount per month), as opposed to + // `max_amount_per_payment` which caps a single payment. + // + // _Note:_ Required for VRP, where exactly one periodic limit must be + // provided. Optional for + // PayTo. + // periodic_limits?: BillingRequestWithActionBillingRequestsMandateRequestConstraintsPeriodicLimit[]; // The date from which payments can be taken. @@ -3046,32 +3160,54 @@ export type BillingRequestWithActionBillingRequestsMandateRequestConstraints = { /** Type for a billingrequestwithactionbillingrequestsmandaterequestconstraintsperiodiclimit resource. */ export type BillingRequestWithActionBillingRequestsMandateRequestConstraintsPeriodicLimit = { - // The alignment of the period. - // - // `calendar` - this will finish on the end of the current period. For example - // this will expire on the Monday for the current week or the January for the - // next year. - // - // `creation_date` - this will finish on the next instance of the current - // period. For example Monthly it will expire on the same day of the next - // month, or yearly the same day of the next year. + // The alignment of the period. Defaults to `creation_date` if not specified. + // + // `calendar` - the period follows fixed calendar boundaries, the same for + // every mandate: + // `week` runs Monday to Sunday, `month` runs from the 1st to the last day of + // the calendar + // month, and `year` runs from 1 January to 31 December. If the mandate starts + // partway + // through a period, the limit for that first period is reduced proportionally + // to the days + // remaining (e.g. a monthly limit starting on the 15th gives roughly half the + // limit for + // that first month). + // + // `creation_date` - the period follows the mandate's own start date rather + // than the + // calendar. For example, if the mandate starts on the 15th, each monthly + // period runs from + // the 15th to the 14th of the following month. The first period is a full + // period, not + // reduced proportionally. + // + // _Note:_ Has no effect when period is `flexible`. // alignment?: `${BillingRequestWithActionBillingRequestsMandateRequestConstraintsPeriodicLimitAlignment}`; // The maximum number of payments that can be collected in this periodic // limit. - // _Note:_ This is only supported for the PayTo scheme, where it is required. + // + // _Note:_ Only supported for the PayTo scheme, where it is optional. // max_payments?: number; // The maximum total amount that can be charged for all payments in this - // periodic limit. - // Required for VRP. + // periodic limit, + // in the lowest denomination for the currency (e.g. pence in GBP, cents in + // EUR). + // + // _Note:_ Required for VRP. This is not permitted for the PayTo scheme. // max_total_amount?: number; - // The repeating period for this mandate. Defaults to flexible for PayTo if - // not specified. + // The repeating period for this mandate. Required whenever a periodic limit + // is provided + // (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, + // this + // defaults to flexible. + // period?: `${BillingRequestWithActionBillingRequestsMandateRequestConstraintsPeriodicLimitPeriod}`; }; @@ -4624,6 +4760,10 @@ export enum InstalmentScheduleCurrency { export type InstalmentScheduleInstalment = { // Amount, in the lowest denomination for the currency (e.g. pence in GBP, // cents in EUR). + // + // For Variable Recurring Payments (VRP), this must not exceed the mandate's + // `max_amount_per_payment` + // constraint. amount: string; // A future date on which the payment should be collected. If the date @@ -5998,6 +6138,10 @@ export type PayerThemeCreateForCreditorRequestLinks = { export type Payment = { // Amount, in the lowest denomination for the currency (e.g. pence in GBP, // cents in EUR). + // + // For Variable Recurring Payments (VRP), this must not exceed the mandate's + // `max_amount_per_payment` + // constraint. amount?: string; // Amount [refunded](#core-endpoints-refunds), in the lowest denomination for From dcd6887c3f98c9658505d32bc792d6ca0a0997d6 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Tue, 14 Jul 2026 17:46:08 +0000 Subject: [PATCH 13/35] Changes generated by 0e52fa170fb1e7a538fd16be889f703d99a3870e This commit was automatically created from gocardless/client-library-templates@0e52fa170fb1e7a538fd16be889f703d99a3870e by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/29354977158 --- package-lock.json | 60 +++++++++++++++++++++++------------------------ 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/package-lock.json b/package-lock.json index 619e6e7e..574752e6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1462,9 +1462,9 @@ } }, "node_modules/@sinclair/typebox": { - "version": "0.34.49", - "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.34.49.tgz", - "integrity": "sha512-brySQQs7Jtn0joV8Xh9ZV/hZb9Ozb0pmazDIASBkYKCjXrXU3mpcFahmK/z4YDhGkQvP9mWJbVyahdtU5wQA+A==", + "version": "0.34.52", + "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.34.52.tgz", + "integrity": "sha512-XiMQh7qqVlxZzcVD+kkGMNGMzcTrDMLWI7S4x7z1MkCkbDPrekpZXEUK0eZqZFMuHQg2a2DZOcDIh9o5v3Gonw==", "dev": true, "license": "MIT" }, @@ -1911,9 +1911,9 @@ } }, "node_modules/@ungap/structured-clone": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.2.tgz", - "integrity": "sha512-5jsZFwgR5rTdKwidH9Qmat75RKwqfpKlWWB1frDkljN127mwqBu8K0PYo7/hFpF03IEJpfVPpCQDY/eDx3iHvA==", + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.3.tgz", + "integrity": "sha512-60YRaenCQcVjYEKOcG824+DRGGIQ3VKErcBoAEDJZz5bKIs2ZG+X/H9Nk+Q6EVkwJk5QNApxbrc5QtBSwtrXAg==", "dev": true, "license": "ISC" }, @@ -2486,9 +2486,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.10.42", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.42.tgz", - "integrity": "sha512-c/jurFrDLyui7o1J86yLkRu4LMsTYcBohveus7/I2Hzdn9KIP2bdJPTue/lR1KH46enoPbD77GKeSYNdyPoD3Q==", + "version": "2.10.43", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.43.tgz", + "integrity": "sha512-AjYpR78kDWAY3Efj+cDTFH9t9SCoL7OoTp1BOb0mQV7S+6CiLwnWM3FyxhJtdPufDFKzmCSFoUncKjWgJEZTCQ==", "dev": true, "license": "Apache-2.0", "bin": { @@ -2506,9 +2506,9 @@ "license": "MIT" }, "node_modules/brace-expansion": { - "version": "1.1.15", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.15.tgz", - "integrity": "sha512-EwOCDEex4quD37XhqM3omwtMoJjr//isUZz1JopUNWms+4Z2ViyM/k1YIRePpoVNnQhENnxtFjLaxNHrT7xIUg==", + "version": "1.1.16", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.16.tgz", + "integrity": "sha512-IDw48K2/2kRkg9LdJxurvq3lV3aBgq0REY89duEqFRthjlPdXHKMj7EnQOXVckxzgisinf3nHfrcE2FufFLXMw==", "dev": true, "license": "MIT", "dependencies": { @@ -2530,9 +2530,9 @@ } }, "node_modules/browserslist": { - "version": "4.28.5", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.5.tgz", - "integrity": "sha512-Cu2E6QejHWzuDMTkuwgpABFgDfZrXLQq5V13YOACZx4mFAG4IwGTbTfHPMr4WtxlHoXSM8FIuRwYYCz5XiabaQ==", + "version": "4.28.6", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.6.tgz", + "integrity": "sha512-FQBYNK15VMslhLHpA7+n+n1GOlF1kId2xcCg7/j95f24AOF6VDYMNH4mFxF7KuaTdv627faazpOAjFzMrfJOUw==", "dev": true, "funding": [ { @@ -2551,9 +2551,9 @@ "license": "MIT", "dependencies": { "baseline-browser-mapping": "^2.10.42", - "caniuse-lite": "^1.0.30001800", - "electron-to-chromium": "^1.5.387", - "node-releases": "^2.0.50", + "caniuse-lite": "^1.0.30001803", + "electron-to-chromium": "^1.5.389", + "node-releases": "^2.0.51", "update-browserslist-db": "^1.2.3" }, "bin": { @@ -2715,9 +2715,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001803", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001803.tgz", - "integrity": "sha512-g/uHREV2ZpK9qMalCsWaxmA6ol+DX8GYhuf3T40RKoP+oL7vhRJh8LNt73PCjpnR6l14FzfPrB5Yux4PKm2meg==", + "version": "1.0.30001805", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001805.tgz", + "integrity": "sha512-52noaS3DubycKSXaU30TwPGIp+POyQSUVa5jBEq3vkRkY0kjyb3LQgvhU6WGyCcyXqVLWO0Cw0Q6BSdD0kUfVA==", "dev": true, "funding": [ { @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.388", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.388.tgz", - "integrity": "sha512-Pl/aJaqOOxYxda3vcx1IKSJimwYXHDkEnGn0F+kG2EE68dDtx2uCinaS+Vih8Z91B9t8CSAbiF/HKyWcnXjhzw==", + "version": "1.5.389", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.389.tgz", + "integrity": "sha512-cEto7aeOqBfU1D+c5py5pE+ooscKE75JifxLBdFUZsqAxRS6y7kebtxAZvICszSl05gPjYHDTjY+lXpyGvpJbg==", "dev": true, "license": "ISC" }, @@ -3838,9 +3838,9 @@ } }, "node_modules/glob/node_modules/brace-expansion": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.1.tgz", - "integrity": "sha512-WR1cURNjuvBLMZBMbqM0UoE+WAfdUcEV1ccD8PVBVOI+Z3ND4+SZbN8RsfT2bMuG1qwz5RFvPukSZm5fF2D5eA==", + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.2.tgz", + "integrity": "sha512-w5JZcKgdhDOgOwm8H+KgbosopHMuGcl6qbulwjtz3SM7I7P3yW1eAjzMPLrIE+NQ9vjgANKHWeMHnrT0OXW1oA==", "dev": true, "license": "MIT", "dependencies": { @@ -5422,9 +5422,9 @@ "license": "MIT" }, "node_modules/node-releases": { - "version": "2.0.50", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.50.tgz", - "integrity": "sha512-J6l92tKHX6w8Jy5nO1Vuc01NoIiRGi/d6qBKVxh+IQ8Cr3b6HbVNfKiF8ZpFKufTwpwxMmce2W3iQZ861ZRyTg==", + "version": "2.0.51", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.51.tgz", + "integrity": "sha512-wRNIrw4DmVLKQlbgOMdkMx27Wrpzes2hh5Jtbi2bjPd+4wJstWIqP5A+lscnqbm0xxmT5Bpg8Lec5ItEBwx6BQ==", "dev": true, "license": "MIT", "engines": { From 74d5131954d7d9df91a01c9767cb1b4b02529ace Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Wed, 15 Jul 2026 15:56:48 +0000 Subject: [PATCH 14/35] Changes generated by b609bedea0be4bf7586a9c9d68bb073776b2cb54 This commit was automatically created from gocardless/client-library-templates@b609bedea0be4bf7586a9c9d68bb073776b2cb54 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/29430149954 --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 574752e6..b67e3cd8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.389", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.389.tgz", - "integrity": "sha512-cEto7aeOqBfU1D+c5py5pE+ooscKE75JifxLBdFUZsqAxRS6y7kebtxAZvICszSl05gPjYHDTjY+lXpyGvpJbg==", + "version": "1.5.392", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.392.tgz", + "integrity": "sha512-1yQq3VQCZRwsnYc67Oc+1fge6Lwtn0hzi6zmEVkB61Zx21kTbwJAW4dFLadl5Rc1tKhG/kSpYXnfiAhu0f0a1g==", "dev": true, "license": "ISC" }, From 110760c1522d9c8dc5ca8f79351b9350a71203f7 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Thu, 16 Jul 2026 09:48:15 +0000 Subject: [PATCH 15/35] Changes generated by a82d24b22f7daac241ff35eac6587c56b1965292 This commit was automatically created from gocardless/client-library-templates@a82d24b22f7daac241ff35eac6587c56b1965292 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/29488360887 --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index b67e3cd8..97985f04 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2715,9 +2715,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001805", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001805.tgz", - "integrity": "sha512-52noaS3DubycKSXaU30TwPGIp+POyQSUVa5jBEq3vkRkY0kjyb3LQgvhU6WGyCcyXqVLWO0Cw0Q6BSdD0kUfVA==", + "version": "1.0.30001806", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001806.tgz", + "integrity": "sha512-72Cuvd95zbSYPKq6Fhg8eDJRlzgWDf7/mtoZv6Qe/DYNCEBdNxoA3+rZAU2ZhGCpZlns3EssFavaZomckT5Uuw==", "dev": true, "funding": [ { From f0e950064f7530b25817f7c18fad172cd3116ea8 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Fri, 17 Jul 2026 12:47:43 +0000 Subject: [PATCH 16/35] Changes generated by 9ff3d4ad98f94450fa72e803addb16fd6aff5658 This commit was automatically created from gocardless/client-library-templates@9ff3d4ad98f94450fa72e803addb16fd6aff5658 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/29581421295 --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 97985f04..ebadd206 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.392", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.392.tgz", - "integrity": "sha512-1yQq3VQCZRwsnYc67Oc+1fge6Lwtn0hzi6zmEVkB61Zx21kTbwJAW4dFLadl5Rc1tKhG/kSpYXnfiAhu0f0a1g==", + "version": "1.5.393", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.393.tgz", + "integrity": "sha512-kiDJdIUawuEIcp9XoICKp1iTYDEbgguIPq526N1Q7jIQDeQ3CqoMx71025PI/7E48Ddtw2HuWsVjY7afEgNxmg==", "dev": true, "license": "ISC" }, From 107966aedef82e005fce68221c2cfc89f5388729 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Mon, 20 Jul 2026 14:44:27 +0000 Subject: [PATCH 17/35] Changes generated by 60c9c8347683e91d547ef7ed703e285c4e86c9f6 This commit was automatically created from gocardless/client-library-templates@60c9c8347683e91d547ef7ed703e285c4e86c9f6 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/29751807432 --- src/services/balanceService.ts | 3 +- .../bankAccountHolderVerificationService.ts | 4 +- src/services/bankAuthorisationService.ts | 12 +- src/services/bankDetailsLookupService.ts | 24 +- src/services/billingRequestFlowService.ts | 6 +- src/services/billingRequestService.ts | 93 +- src/services/billingRequestTemplateService.ts | 22 +- .../billingRequestWithActionService.ts | 16 +- src/services/blockService.ts | 7 +- src/services/creditorBankAccountService.ts | 43 +- src/services/creditorService.ts | 10 +- src/services/customerBankAccountService.ts | 43 +- src/services/customerService.ts | 60 +- src/services/eventService.ts | 111 +- src/services/instalmentScheduleService.ts | 148 +- src/services/institutionService.ts | 9 +- src/services/mandateImportEntryService.ts | 12 +- src/services/mandatePdfService.ts | 46 +- src/services/mandateService.ts | 57 +- src/services/negativeBalanceLimitService.ts | 4 +- src/services/outboundPaymentImportService.ts | 21 +- src/services/outboundPaymentService.ts | 57 +- src/services/payerAuthorisationService.ts | 22 +- src/services/paymentService.ts | 154 +- src/services/payoutService.ts | 19 +- src/services/redirectFlowService.ts | 2 +- src/services/refundService.ts | 70 +- src/services/subscriptionService.ts | 88 +- src/types/Types.ts | 2911 +++++++++-------- 29 files changed, 2203 insertions(+), 1871 deletions(-) diff --git a/src/services/balanceService.ts b/src/services/balanceService.ts index f120701d..1c75a6a1 100644 --- a/src/services/balanceService.ts +++ b/src/services/balanceService.ts @@ -17,7 +17,8 @@ interface BalanceListRequest { before?: string; - // ID of a [creditor](#core-endpoints-creditors). + // ID of a creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). creditor: string; diff --git a/src/services/bankAccountHolderVerificationService.ts b/src/services/bankAccountHolderVerificationService.ts index ba07a6c0..80a6a432 100644 --- a/src/services/bankAccountHolderVerificationService.ts +++ b/src/services/bankAccountHolderVerificationService.ts @@ -13,8 +13,8 @@ interface BankAccountHolderVerificationCreateRequest { links: Types.BankAccountHolderVerificationCreateRequestLinks; // Type of the verification that has been performed - // eg. [Confirmation of - // Payee](https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/) + // eg. Confirmation of Payee + // (https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/) type: `${Types.BankAccountHolderVerificationType}`; } diff --git a/src/services/bankAuthorisationService.ts b/src/services/bankAuthorisationService.ts index 14c4455c..239eea83 100644 --- a/src/services/bankAuthorisationService.ts +++ b/src/services/bankAuthorisationService.ts @@ -24,11 +24,13 @@ interface BankAuthorisationCreateRequest { // // Please note: bank authorisations can still fail despite an `outcome=success` // on the `redirect_uri`. It is therefore recommended to wait for the relevant - // bank authorisation event, such as - // [`BANK_AUTHORISATION_AUTHORISED`](#billing-request-bankauthorisationauthorised), - // [`BANK_AUTHORISATION_DENIED`](#billing-request-bankauthorisationdenied), or - // [`BANK_AUTHORISATION_FAILED`](#billing-request-bankauthorisationfailed) in - // order to show the correct outcome to the user. + // bank authorisation event, such as `BANK_AUTHORISATION_AUTHORISED` + // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationauthorised), + // `BANK_AUTHORISATION_DENIED` + // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationdenied), + // or `BANK_AUTHORISATION_FAILED` + // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationfailed) + // in order to show the correct outcome to the user. // // The BillingRequestFlow ID will also be appended to the `redirect_uri` as // query parameter `id=BRF123`. diff --git a/src/services/bankDetailsLookupService.ts b/src/services/bankDetailsLookupService.ts index 0dbbd4b0..0f9e51e5 100644 --- a/src/services/bankDetailsLookupService.ts +++ b/src/services/bankDetailsLookupService.ts @@ -15,29 +15,33 @@ interface BankDetailsLookupCreateRequest { account_holder_name?: string; - // Bank account number - see [local details](#appendix-local-bank-details) for - // more information. Alternatively you can provide an `iban`. + // Bank account number - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. account_number?: string; - // Bank code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Bank code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. bank_code?: string; - // Branch code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Branch code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. branch_code?: string; - // [ISO - // 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) // alpha-2 code. Must be provided if specifying local details. country_code?: string; - // International Bank Account Number. Alternatively you can provide [local - // details](#appendix-local-bank-details). + // International Bank Account Number. Alternatively you can provide local + // details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details). iban?: string; } diff --git a/src/services/billingRequestFlowService.ts b/src/services/billingRequestFlowService.ts index 0e6c451e..8a2d11a2 100644 --- a/src/services/billingRequestFlowService.ts +++ b/src/services/billingRequestFlowService.ts @@ -24,8 +24,8 @@ interface BillingRequestFlowCreateRequest { exit_uri?: string; - // Sets the default language of the Billing Request Flow and the customer. [ISO - // 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. + // Sets the default language of the Billing Request Flow and the customer. ISO + // 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. language?: string; @@ -38,7 +38,6 @@ interface BillingRequestFlowCreateRequest { // // You can only lock bank account if these have already been completed as a part // of the billing request. - // lock_bank_account?: boolean; @@ -55,7 +54,6 @@ interface BillingRequestFlowCreateRequest { // // You can only lock customer details if these have already been completed as a // part of the billing request. - // lock_customer_details?: boolean; diff --git a/src/services/billingRequestService.ts b/src/services/billingRequestService.ts index 3870bcf6..ebc6885a 100644 --- a/src/services/billingRequestService.ts +++ b/src/services/billingRequestService.ts @@ -13,8 +13,8 @@ interface BillingRequestCreateRequest { // direct debit. // Should not be set if GoCardless payment intelligence feature is used. // - // See [Billing Requests: Retain customers with - // Fallbacks](https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/) + // See Billing Requests: Retain customers with Fallbacks + // (https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/) // for more information. fallback_enabled?: boolean; @@ -44,9 +44,9 @@ interface BillingRequestCreateRequest { // Specifies the underlying purpose of the payment. Defines the specific reason // or type of service/goods the payment relates to, improving straight-through // processing and compliance. - // See [VRP Commercial Payment Purpose - // Codes](https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) - // for the complete list of valid codes. + // See VRP Commercial Payment Purpose Codes + // (https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) for + // the complete list of valid codes. payment_purpose_code?: string; @@ -56,9 +56,9 @@ interface BillingRequestCreateRequest { // Specifies the high-level purpose/category of a mandate and/or payment using a // set of pre-defined categories. Provides context on the nature and reason for // the payment to facilitate processing and compliance. - // See [Billing Request Purpose - // Codes](https://developer.gocardless.com/billing-request-purpose-codes/) for - // the complete list of valid codes. + // See Billing Request Purpose Codes + // (https://developer.gocardless.com/billing-request-purpose-codes/) for the + // complete list of valid codes. purpose_code?: `${Types.BillingRequestPurposeCode}`; @@ -78,54 +78,63 @@ interface BillingRequestCollectBankAccountRequest { // Name of the account holder, as known by the bank. The full name provided when // the customer is created is stored and is available via the API, but is // transliterated, upcased, and truncated to 18 characters in bank submissions. - // This field is required unless the request includes a [customer bank account - // token](#javascript-flow-customer-bank-account-tokens). + // This field is required unless the request includes a customer bank account + // token + // (https://developer.gocardless.com/api-reference/#javascript-flow-customer-bank-account-tokens). account_holder_name?: string; - // Bank account number - see [local details](#appendix-local-bank-details) for - // more information. Alternatively you can provide an `iban`. + // Bank account number - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. account_number?: string; - // Account number suffix (only for bank accounts denominated in NZD) - see - // [local details](#local-bank-details-new-zealand) for more information. + // Account number suffix (only for bank accounts denominated in NZD) - see local + // details + // (https://developer.gocardless.com/api-reference/#local-bank-details-new-zealand) + // for more information. account_number_suffix?: string; // Bank account type. Required for USD-denominated bank accounts. Must not be - // provided for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // provided for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${Types.BillingRequestAccountType}`; - // Bank code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Bank code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. bank_code?: string; - // Branch code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Branch code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. branch_code?: string; - // [ISO 3166-1 alpha-2 - // code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). + // ISO 3166-1 alpha-2 code + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). // Defaults to the country code of the `iban` if supplied, otherwise is // required. country_code?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. currency?: string; - // International Bank Account Number. Alternatively you can provide [local - // details](#appendix-local-bank-details). IBANs are not accepted for Swedish - // bank accounts denominated in SEK - you must supply [local - // details](#local-bank-details-sweden). + // International Bank Account Number. Alternatively you can provide local + // details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details). + // IBANs are not accepted for Swedish bank accounts denominated in SEK - you + // must supply local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-sweden). iban?: string; @@ -182,8 +191,9 @@ interface BillingRequestListRequest { // The creation date of this BillingRequest. created_at?: Types.CreatedAtFilter; - // ID of a [customer](#core-endpoints-customers). If specified, this endpoint - // will return all requests for the given customer. + // ID of a customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers). + // If specified, this endpoint will return all requests for the given customer. customer?: string; @@ -192,15 +202,12 @@ interface BillingRequestListRequest { limit?: string; // One of: - // + // + // - `pending`: the billing request is pending and can be used + // - `ready_to_fulfil`: the billing request is ready to fulfil + // - `fulfilling`: the billing request is currently undergoing fulfilment + // - `fulfilled`: the billing request has been fulfilled and a payment created + // - `cancelled`: the billing request has been cancelled and cannot be used status?: `${Types.BillingRequestStatus}`; } @@ -216,8 +223,8 @@ interface BillingRequestNotifyRequest { } interface BillingRequestChooseCurrencyRequest { - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. currency: string; @@ -229,8 +236,8 @@ interface BillingRequestChooseCurrencyRequest { } interface BillingRequestSelectInstitutionRequest { - // [ISO - // 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) // alpha-2 code. The country code of the institution. If nothing is provided, // institutions with the country code 'GB' are returned by default. diff --git a/src/services/billingRequestTemplateService.ts b/src/services/billingRequestTemplateService.ts index 203e1b1b..d0495e2f 100644 --- a/src/services/billingRequestTemplateService.ts +++ b/src/services/billingRequestTemplateService.ts @@ -39,14 +39,12 @@ interface BillingRequestTemplateCreateRequest { // required for PayTo and VRP. mandate_request_constraints?: Types.BillingRequestTemplateMandateRequestConstraints; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. mandate_request_currency?: string; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. - // mandate_request_description?: string; @@ -82,15 +80,14 @@ interface BillingRequestTemplateCreateRequest { payment_request_amount?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. `GBP` and `EUR` supported; `GBP` with your customers in the UK and for - // `EUR` with your customers in supported Eurozone countries only. + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // `GBP` and `EUR` supported; `GBP` with your customers in the UK and for `EUR` + // with your customers in supported Eurozone countries only. payment_request_currency?: string; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. - // payment_request_description?: string; @@ -119,14 +116,12 @@ interface BillingRequestTemplateUpdateRequest { // required for PayTo and VRP. mandate_request_constraints?: Types.BillingRequestTemplateMandateRequestConstraints; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. mandate_request_currency?: string; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. - // mandate_request_description?: string; @@ -162,15 +157,14 @@ interface BillingRequestTemplateUpdateRequest { payment_request_amount?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. `GBP` and `EUR` supported; `GBP` with your customers in the UK and for - // `EUR` with your customers in supported Eurozone countries only. + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // `GBP` and `EUR` supported; `GBP` with your customers in the UK and for `EUR` + // with your customers in supported Eurozone countries only. payment_request_currency?: string; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. - // payment_request_description?: string; diff --git a/src/services/billingRequestWithActionService.ts b/src/services/billingRequestWithActionService.ts index 6986c622..c87cdc8a 100644 --- a/src/services/billingRequestWithActionService.ts +++ b/src/services/billingRequestWithActionService.ts @@ -16,8 +16,8 @@ interface BillingRequestWithActionCreateWithActionsRequest { // direct debit. // Should not be set if GoCardless payment intelligence feature is used. // - // See [Billing Requests: Retain customers with - // Fallbacks](https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/) + // See Billing Requests: Retain customers with Fallbacks + // (https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/) // for more information. fallback_enabled?: boolean; @@ -44,9 +44,9 @@ interface BillingRequestWithActionCreateWithActionsRequest { // Specifies the underlying purpose of the payment. Defines the specific reason // or type of service/goods the payment relates to, improving straight-through // processing and compliance. - // See [VRP Commercial Payment Purpose - // Codes](https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) - // for the complete list of valid codes. + // See VRP Commercial Payment Purpose Codes + // (https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) for + // the complete list of valid codes. payment_purpose_code?: string; @@ -56,9 +56,9 @@ interface BillingRequestWithActionCreateWithActionsRequest { // Specifies the high-level purpose/category of a mandate and/or payment using a // set of pre-defined categories. Provides context on the nature and reason for // the payment to facilitate processing and compliance. - // See [Billing Request Purpose - // Codes](https://developer.gocardless.com/billing-request-purpose-codes/) for - // the complete list of valid codes. + // See Billing Request Purpose Codes + // (https://developer.gocardless.com/billing-request-purpose-codes/) for the + // complete list of valid codes. purpose_code?: `${Types.BillingRequestWithActionPurposeCode}`; } diff --git a/src/services/blockService.ts b/src/services/blockService.ts index 3d2700b8..3ca2c9ff 100644 --- a/src/services/blockService.ts +++ b/src/services/blockService.ts @@ -61,7 +61,8 @@ interface BlockListRequest { before?: string; - // ID of a [Block](#core-endpoints-blocks). + // ID of a Block + // (https://developer.gocardless.com/api-reference/#core-endpoints-blocks). block?: string; @@ -86,7 +87,9 @@ interface BlockListRequest { reason_type?: `${Types.BlockReasonType}`; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this // resource was updated. updated_at?: string; diff --git a/src/services/creditorBankAccountService.ts b/src/services/creditorBankAccountService.ts index 9a23980d..f3c8f055 100644 --- a/src/services/creditorBankAccountService.ts +++ b/src/services/creditorBankAccountService.ts @@ -10,49 +10,56 @@ interface CreditorBankAccountListResponse extends Types.APIResponse { interface CreditorBankAccountCreateRequest { // Name of the account holder, as known by the bank. Usually this is the same as - // the name stored with the linked [creditor](#core-endpoints-creditors). This - // field will be transliterated, upcased and truncated to 18 characters. + // the name stored with the linked creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). + // This field will be transliterated, upcased and truncated to 18 characters. account_holder_name: string; - // Bank account number - see [local details](#appendix-local-bank-details) for - // more information. Alternatively you can provide an `iban`. + // Bank account number - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. account_number?: string; // Bank account type. Required for USD-denominated bank accounts. Must not be - // provided for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // provided for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${Types.CreditorBankAccountAccountType}`; - // Bank code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Bank code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. bank_code?: string; - // Branch code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Branch code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. branch_code?: string; - // [ISO 3166-1 alpha-2 - // code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). + // ISO 3166-1 alpha-2 code + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). // Defaults to the country code of the `iban` if supplied, otherwise is // required. country_code?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. currency?: string; - // International Bank Account Number. Alternatively you can provide [local - // details](#appendix-local-bank-details). IBANs are not accepted for Swedish - // bank accounts denominated in SEK - you must supply [local - // details](#local-bank-details-sweden). + // International Bank Account Number. Alternatively you can provide local + // details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details). + // IBANs are not accepted for Swedish bank accounts denominated in SEK - you + // must supply local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-sweden). iban?: string; diff --git a/src/services/creditorService.ts b/src/services/creditorService.ts index 810306b7..97aca388 100644 --- a/src/services/creditorService.ts +++ b/src/services/creditorService.ts @@ -16,12 +16,11 @@ interface CreditorCreateRequest { // sent to that creditor could be `ACME-8G7Q8`. // // This prefix is also used for refunds in EUR and GBP. - // bank_reference_prefix?: string; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code: string; @@ -72,7 +71,6 @@ interface CreditorUpdateRequest { // sent to that creditor could be `ACME-8G7Q8`. // // This prefix is also used for refunds in EUR and GBP. - // bank_reference_prefix?: string; @@ -80,8 +78,8 @@ interface CreditorUpdateRequest { city?: string; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string; diff --git a/src/services/customerBankAccountService.ts b/src/services/customerBankAccountService.ts index 92ef9893..4f44a196 100644 --- a/src/services/customerBankAccountService.ts +++ b/src/services/customerBankAccountService.ts @@ -12,49 +12,56 @@ interface CustomerBankAccountCreateRequest { // Name of the account holder, as known by the bank. The full name provided when // the customer is created is stored and is available via the API, but is // transliterated, upcased, and truncated to 18 characters in bank submissions. - // This field is required unless the request includes a [customer bank account - // token](#javascript-flow-customer-bank-account-tokens). + // This field is required unless the request includes a customer bank account + // token + // (https://developer.gocardless.com/api-reference/#javascript-flow-customer-bank-account-tokens). account_holder_name?: string; - // Bank account number - see [local details](#appendix-local-bank-details) for - // more information. Alternatively you can provide an `iban`. + // Bank account number - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. account_number?: string; // Bank account type. Required for USD-denominated bank accounts. Must not be - // provided for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // provided for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${Types.CustomerBankAccountAccountType}`; - // Bank code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Bank code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. bank_code?: string; - // Branch code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Branch code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. branch_code?: string; - // [ISO 3166-1 alpha-2 - // code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). + // ISO 3166-1 alpha-2 code + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). // Defaults to the country code of the `iban` if supplied, otherwise is // required. country_code?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. currency?: string; - // International Bank Account Number. Alternatively you can provide [local - // details](#appendix-local-bank-details). IBANs are not accepted for Swedish - // bank accounts denominated in SEK - you must supply [local - // details](#local-bank-details-sweden). + // International Bank Account Number. Alternatively you can provide local + // details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details). + // IBANs are not accepted for Swedish bank accounts denominated in SEK - you + // must supply local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-sweden). iban?: string; diff --git a/src/services/customerService.ts b/src/services/customerService.ts index 704e7f6d..c04085a1 100644 --- a/src/services/customerService.ts +++ b/src/services/customerService.ts @@ -33,8 +33,8 @@ interface CustomerCreateRequest { company_name?: string; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string; @@ -57,13 +57,13 @@ interface CustomerCreateRequest { given_name?: string; - // [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used + // ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used // as the language for notification emails sent by GoCardless if your - // organisation does not send its own (see [compliance - // requirements](#appendix-compliance-requirements)). Currently only "en", "fr", - // "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are supported. If this - // is not provided, the language will be chosen based on the `country_code` (if - // supplied) or default to "en". + // organisation does not send its own (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). + // Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", + // "sv" are supported. If this is not provided, the language will be chosen + // based on the `country_code` (if supplied) or default to "en". language?: string; @@ -72,7 +72,7 @@ interface CustomerCreateRequest { metadata?: Types.JsonMap; - // [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, + // ITU E.123 (https://en.wikipedia.org/wiki/E.123) formatted phone number, // including country code. phone_number?: string; @@ -82,7 +82,7 @@ interface CustomerCreateRequest { postal_code?: string; // The customer's address region, county or department. For US customers a 2 - // letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code + // letter ISO3166-2:US (https://en.wikipedia.org/wiki/ISO_3166-2:US) state code // is required (e.g. `CA` for California). region?: string; @@ -111,8 +111,8 @@ interface CustomerListRequest { // The creation date of this Customer. created_at?: Types.CreatedAtFilter; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. currency?: `${Types.CustomerCurrency}`; @@ -123,20 +123,18 @@ interface CustomerListRequest { // The direction to sort in. // One of: - // + // + // - `asc` + // - `desc` sort_direction?: `${Types.CustomerSortDirection}`; // Field by which to sort records. // One of: - // + // + // - `name` + // - `company_name` + // - `created_at` sort_field?: `${Types.CustomerSortField}`; } @@ -166,8 +164,8 @@ interface CustomerUpdateRequest { company_name?: string; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string; @@ -190,13 +188,13 @@ interface CustomerUpdateRequest { given_name?: string; - // [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used + // ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Used // as the language for notification emails sent by GoCardless if your - // organisation does not send its own (see [compliance - // requirements](#appendix-compliance-requirements)). Currently only "en", "fr", - // "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are supported. If this - // is not provided, the language will be chosen based on the `country_code` (if - // supplied) or default to "en". + // organisation does not send its own (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). + // Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", + // "sv" are supported. If this is not provided, the language will be chosen + // based on the `country_code` (if supplied) or default to "en". language?: string; @@ -205,7 +203,7 @@ interface CustomerUpdateRequest { metadata?: Types.JsonMap; - // [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, + // ITU E.123 (https://en.wikipedia.org/wiki/E.123) formatted phone number, // including country code. phone_number?: string; @@ -215,7 +213,7 @@ interface CustomerUpdateRequest { postal_code?: string; // The customer's address region, county or department. For US customers a 2 - // letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code + // letter ISO3166-2:US (https://en.wikipedia.org/wiki/ISO_3166-2:US) state code // is required (e.g. `CA` for California). region?: string; diff --git a/src/services/eventService.ts b/src/services/eventService.ts index b0abdb1f..82c8f0ee 100644 --- a/src/services/eventService.ts +++ b/src/services/eventService.ts @@ -21,16 +21,19 @@ interface EventListRequest { before?: string; - // ID of a [billing request](#billing-requests-billing-requests). If specified, - // this endpoint will return all events for the given billing request. + // ID of a billing request + // (https://developer.gocardless.com/api-reference/#billing-requests-billing-requests). + // If specified, this endpoint will return all events for the given billing + // request. billing_request?: string; // The creation date of this Event. created_at?: Types.CreatedAtFilter; - // ID of an [creditor](#core-endpoints-creditors). If specified, this endpoint - // will return all events for the given creditor. + // ID of an creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). + // If specified, this endpoint will return all events for the given creditor. creditor?: string; @@ -41,25 +44,25 @@ interface EventListRequest { // Includes linked resources in the response. Must be used with the // `resource_type` parameter specified. The include should be one of: - // + // + // - `billing_request` + // - `creditor` + // - `instalment_schedule` + // - `mandate` + // - `payer_authorisation` + // - `payment` + // - `payout` + // - `refund` + // - `scheme_identifier` + // - `subscription` + // - `outbound_payment` + // - `payment_account_transaction` include?: `${Types.EventInclude}`; - // ID of an [instalment schedule](#core-endpoints-instalment-schedules). If - // specified, this endpoint will return all events for the given instalment + // ID of an instalment schedule + // (https://developer.gocardless.com/api-reference/#core-endpoints-instalment-schedules). + // If specified, this endpoint will return all events for the given instalment // schedule. instalment_schedule?: string; @@ -68,13 +71,15 @@ interface EventListRequest { limit?: string; - // ID of a [mandate](#core-endpoints-mandates). If specified, this endpoint will - // return all events for the given mandate. + // ID of a mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates). If + // specified, this endpoint will return all events for the given mandate. mandate?: string; - // ID of an [outbound_payment](#core-endpoints-outbound-payments). If specified, - // this endpoint will return all events for the given payment. + // ID of an outbound_payment + // (https://developer.gocardless.com/api-reference/#core-endpoints-outbound-payments). + // If specified, this endpoint will return all events for the given payment. outbound_payment?: string; @@ -83,12 +88,14 @@ interface EventListRequest { parent_event?: string; - // ID of a [payer authorisation](#core-endpoints-payer-authorisations). + // ID of a payer authorisation + // (https://developer.gocardless.com/api-reference/#core-endpoints-payer-authorisations). payer_authorisation?: string; - // ID of a [payment](#core-endpoints-payments). If specified, this endpoint will - // return all events for the given payment. + // ID of a payment + // (https://developer.gocardless.com/api-reference/#core-endpoints-payments). If + // specified, this endpoint will return all events for the given payment. payment?: string; @@ -97,13 +104,15 @@ interface EventListRequest { payment_account_transaction?: string; - // ID of a [payout](#core-endpoints-payouts). If specified, this endpoint will - // return all events for the given payout. + // ID of a payout + // (https://developer.gocardless.com/api-reference/#core-endpoints-payouts). If + // specified, this endpoint will return all events for the given payout. payout?: string; - // ID of a [refund](#core-endpoints-refunds). If specified, this endpoint will - // return all events for the given refund. + // ID of a refund + // (https://developer.gocardless.com/api-reference/#core-endpoints-refunds). If + // specified, this endpoint will return all events for the given refund. refund?: string; @@ -113,32 +122,34 @@ interface EventListRequest { // `payout`, `refund`, `scheme_identifier`, `subscription`, `outbound_payment` // or `payment_account_transaction` parameters. // The type can be one of: - // + // + // - `billing_requests` + // - `creditors` + // - `exports` + // - `instalment_schedules` + // - `mandates` + // - `payer_authorisations` + // - `payments` + // - `payouts` + // - `refunds` + // - `scheme_identifiers` + // - `subscriptions` + // - `outbound_payments` + // - `payment_account_transactions` resource_type?: `${Types.EventResourceType}`; - // ID of a [scheme identifier](#core-endpoints-scheme-identifiers). If - // specified, this endpoint will return all events for the given scheme + // ID of a scheme identifier + // (https://developer.gocardless.com/api-reference/#core-endpoints-scheme-identifiers). + // If specified, this endpoint will return all events for the given scheme // identifier. scheme_identifier?: string; - // ID of a [subscription](#core-endpoints-subscriptions). If specified, this - // endpoint will return all events for the given subscription. + // ID of a subscription + // (https://developer.gocardless.com/api-reference/#core-endpoints-subscriptions). + // If specified, this endpoint will return all events for the given + // subscription. subscription?: string; } diff --git a/src/services/instalmentScheduleService.ts b/src/services/instalmentScheduleService.ts index 4abe506b..58cd1749 100644 --- a/src/services/instalmentScheduleService.ts +++ b/src/services/instalmentScheduleService.ts @@ -15,15 +15,15 @@ interface InstalmentScheduleCreateWithDatesRequest { app_fee?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. currency: `${Types.InstalmentScheduleCurrency}`; // An explicit array of instalment payments, each specifying at least an - // `amount` and `charge_date`. See [create (with - // dates)](#instalment-schedules-create-with-dates) + // `amount` and `charge_date`. See create (with dates) + // (https://developer.gocardless.com/api-reference/#instalment-schedules-create-with-dates) instalments: Types.InstalmentScheduleInstalment[]; @@ -42,29 +42,51 @@ interface InstalmentScheduleCreateWithDatesRequest { name: string; // An optional reference that will appear on your customer's bank statement. The - // character limit for this reference is dependent on the scheme.
- // ACH - 10 characters
Autogiro - 11 - // characters
Bacs - 10 characters
- // BECS - 30 characters
BECS NZ - 12 - // characters
Betalingsservice - 30 characters
- // Faster Payments - 18 characters
PAD - - // scheme doesn't offer references
PayTo - 18 - // characters
SEPA - 140 characters
Note that this - // reference must be unique (for each merchant) for the BECS scheme as it is a - // scheme requirement.

Restricted: - // You can only specify a payment reference for Bacs payments (that is, when - // collecting from the UK) if you're on the GoCardless Plus, Pro or Enterprise - // packages.

Restricted: - // You can not specify a payment reference for Faster Payments.

+ // character limit for this reference is dependent on the scheme. + // ACH + // Autogiro + // Bacs + // BECS + // BECS NZ + // Betalingsservice + // Faster Payments + // PAD + // PayTo + // SEPA + // Note that this reference must be unique (for each merchant) for the BECS + // scheme as it is a scheme requirement. Restricted: You can only specify a + // payment reference for Bacs payments (that is, when collecting from the UK) if + // you're on the GoCardless Plus, Pro or Enterprise packages + // (https://gocardless.com/pricing). + // Restricted: You can not specify a payment reference for Faster Payments. payment_reference?: string; - // On failure, automatically retry payments using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

+ // On failure, automatically retry payments using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is `false`. + // Important: To be able to use intelligent retries, Success+ needs to be + // enabled in GoCardless dashboard (https://manage.gocardless.com/success-plus). + // retry_if_possible?: boolean; @@ -86,8 +108,8 @@ interface InstalmentScheduleCreateWithScheduleRequest { app_fee?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. currency: `${Types.InstalmentScheduleCurrency}`; @@ -95,8 +117,8 @@ interface InstalmentScheduleCreateWithScheduleRequest { // Frequency of the payments you want to create, together with an array of // payment // amounts to be collected, with a specified start date for the first payment. - // See [create (with schedule)](#instalment-schedules-create-with-schedule) - // + // See create (with schedule) + // (https://developer.gocardless.com/api-reference/#instalment-schedules-create-with-schedule) instalments: Types.InstalmentScheduleInstalments; // Resources linked to this InstalmentSchedule. @@ -114,29 +136,51 @@ interface InstalmentScheduleCreateWithScheduleRequest { name: string; // An optional reference that will appear on your customer's bank statement. The - // character limit for this reference is dependent on the scheme.
- // ACH - 10 characters
Autogiro - 11 - // characters
Bacs - 10 characters
- // BECS - 30 characters
BECS NZ - 12 - // characters
Betalingsservice - 30 characters
- // Faster Payments - 18 characters
PAD - - // scheme doesn't offer references
PayTo - 18 - // characters
SEPA - 140 characters
Note that this - // reference must be unique (for each merchant) for the BECS scheme as it is a - // scheme requirement.

Restricted: - // You can only specify a payment reference for Bacs payments (that is, when - // collecting from the UK) if you're on the GoCardless Plus, Pro or Enterprise - // packages.

Restricted: - // You can not specify a payment reference for Faster Payments.

+ // character limit for this reference is dependent on the scheme. + // ACH + // Autogiro + // Bacs + // BECS + // BECS NZ + // Betalingsservice + // Faster Payments + // PAD + // PayTo + // SEPA + // Note that this reference must be unique (for each merchant) for the BECS + // scheme as it is a scheme requirement. Restricted: You can only specify a + // payment reference for Bacs payments (that is, when collecting from the UK) if + // you're on the GoCardless Plus, Pro or Enterprise packages + // (https://gocardless.com/pricing). + // Restricted: You can not specify a payment reference for Faster Payments. payment_reference?: string; - // On failure, automatically retry payments using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

+ // On failure, automatically retry payments using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is `false`. + // Important: To be able to use intelligent retries, Success+ needs to be + // enabled in GoCardless dashboard (https://manage.gocardless.com/success-plus). + // retry_if_possible?: boolean; @@ -163,7 +207,8 @@ interface InstalmentScheduleListRequest { // The creation date of this InstalmentSchedule. created_at?: Types.CreatedAtFilter; - // ID of the associated [customer](#core-endpoints-customers). + // ID of the associated customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers). customer?: string; @@ -171,8 +216,9 @@ interface InstalmentScheduleListRequest { limit?: string; - // ID of the associated [mandate](#core-endpoints-mandates) which the instalment - // schedule will create payments against. + // ID of the associated mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // which the instalment schedule will create payments against. mandate?: string; diff --git a/src/services/institutionService.ts b/src/services/institutionService.ts index 24000b90..65ae3b11 100644 --- a/src/services/institutionService.ts +++ b/src/services/institutionService.ts @@ -14,8 +14,8 @@ interface InstitutionListRequest { branch_code?: string; - // [ISO - // 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) // alpha-2 code. The country code of the institution. If nothing is provided, // institutions with the country code 'GB' are returned by default. @@ -36,8 +36,8 @@ interface InstitutionListRequest { } interface InstitutionListForBillingRequestRequest { - // [ISO - // 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) // alpha-2 code. The country code of the institution. If nothing is provided, // institutions with the country code 'GB' are returned by default. @@ -51,7 +51,6 @@ interface InstitutionListForBillingRequestRequest { // Indicates whether to include temporarily disabled institutions in the // response. // If not provided or set to false, only enabled institutions will be returned. - // include_disabled?: boolean; diff --git a/src/services/mandateImportEntryService.ts b/src/services/mandateImportEntryService.ts index 9278c87a..6db97170 100644 --- a/src/services/mandateImportEntryService.ts +++ b/src/services/mandateImportEntryService.ts @@ -29,7 +29,6 @@ interface MandateImportEntryCreateRequest { // processed by GoCardless) to identify the records that have been created. // Limited // to 255 characters. - // record_identifier?: string; } @@ -52,12 +51,11 @@ interface MandateImportEntryListRequest { mandate_import: string; // One of: - // + // + // - `sucessfully_processed`: the entry has been imported and the associated + // records created. + // - `unsuccessfully_processed`: the entry could not be processed due to an + // error, see the 'processing_errors' value status?: `${Types.MandateImportEntryStatus}`; } diff --git a/src/services/mandatePdfService.ts b/src/services/mandatePdfService.ts index c93303d8..472dd51f 100644 --- a/src/services/mandatePdfService.ts +++ b/src/services/mandatePdfService.ts @@ -10,19 +10,22 @@ interface MandatePdfListResponse extends Types.APIResponse { interface MandatePdfCreateRequest { // Name of the account holder, as known by the bank. Usually this matches the - // name of the [customer](#core-endpoints-customers). This field cannot exceed - // 18 characters. + // name of the customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers). + // This field cannot exceed 18 characters. account_holder_name?: string; - // Bank account number - see [local details](#appendix-local-bank-details) for - // more information. Alternatively you can provide an `iban`. + // Bank account number - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. account_number?: string; // Bank account type. Required for USD-denominated bank accounts. Must not be - // provided for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // provided for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${Types.MandatePdfAccountType}`; @@ -38,18 +41,21 @@ interface MandatePdfCreateRequest { address_line3?: string; - // Bank code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Bank code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. bank_code?: string; - // SWIFT BIC. Will be derived automatically if a valid `iban` or [local - // details](#appendix-local-bank-details) are provided. + // SWIFT BIC. Will be derived automatically if a valid `iban` or local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // are provided. bic?: string; - // Branch code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Branch code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. branch_code?: string; @@ -62,8 +68,8 @@ interface MandatePdfCreateRequest { company_name?: string; - // [ISO - // 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) // alpha-2 code. Required if providing local details. country_code?: string; @@ -85,9 +91,10 @@ interface MandatePdfCreateRequest { given_name?: string; - // International Bank Account Number. Alternatively you can provide [local - // details](#appendix-local-bank-details). IBANs cannot be provided for Autogiro - // mandates. + // International Bank Account Number. Alternatively you can provide local + // details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details). + // IBANs cannot be provided for Autogiro mandates. iban?: string; @@ -114,14 +121,15 @@ interface MandatePdfCreateRequest { postal_code?: string; // The customer's address region, county or department. For US customers a 2 - // letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state code + // letter ISO3166-2:US (https://en.wikipedia.org/wiki/ISO_3166-2:US) state code // is required (e.g. `CA` for California). region?: string; // Direct Debit scheme. Can be supplied or automatically detected from the bank // account details provided. If you do not provide a scheme, you must provide - // either a mandate, an `iban`, or [local details](#appendix-local-bank-details) + // either a mandate, an `iban`, or local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) // including a `country_code`. scheme?: string; diff --git a/src/services/mandateService.ts b/src/services/mandateService.ts index 22e2d95a..d5fc1e16 100644 --- a/src/services/mandateService.ts +++ b/src/services/mandateService.ts @@ -9,17 +9,16 @@ interface MandateListResponse extends Types.APIResponse { } interface MandateCreateRequest { - // This field is ACH specific, sometimes referred to as [SEC - // code](https://www.moderntreasury.com/learn/sec-codes). + // This field is ACH specific, sometimes referred to as SEC code + // (https://www.moderntreasury.com/learn/sec-codes). // // This is the way that the payer gives authorisation to the merchant. - // web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC + // web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC // code: WEB) - // telephone: Authorisation is provided orally over telephone (maps to SEC - // code: TEL) - // paper: Authorisation is provided in writing and signed, or similarly + // telephone: Authorisation is provided orally over telephone (maps to SEC code: + // TEL) + // paper: Authorisation is provided in writing and signed, or similarly // authenticated (maps to SEC code: PPD) - // authorisation_source?: `${Types.MandateAuthorisationSource}`; @@ -37,20 +36,19 @@ interface MandateCreateRequest { // // Not required for creating offline mandates where `authorisation_source` is // set to telephone or paper. - // payer_ip_address?: string; - // Unique reference. Different schemes have different length and [character - // set](#appendix-character-sets) requirements. GoCardless will generate a - // unique reference satisfying the different scheme requirements if this field - // is left blank. + // Unique reference. Different schemes have different length and character set + // (https://developer.gocardless.com/api-reference/#appendix-character-sets) + // requirements. GoCardless will generate a unique reference satisfying the + // different scheme requirements if this field is left blank. reference?: string; - // Bank payment scheme to which this mandate and - // associated payments are submitted. Can be supplied or automatically detected - // from the customer's bank account. + // Bank payment scheme to which this mandate and associated payments are + // submitted. Can be supplied or automatically detected from the customer's bank + // account. scheme?: string; } @@ -67,21 +65,24 @@ interface MandateListRequest { // The creation date of this Mandate. created_at?: Types.CreatedAtFilter; - // ID of a [creditor](#core-endpoints-creditors). If specified, this endpoint - // will return all mandates for the given creditor. Cannot be used in - // conjunction with `customer` or `customer_bank_account` + // ID of a creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). + // If specified, this endpoint will return all mandates for the given creditor. + // Cannot be used in conjunction with `customer` or `customer_bank_account` creditor?: string; - // ID of a [customer](#core-endpoints-customers). If specified, this endpoint - // will return all mandates for the given customer. Cannot be used in - // conjunction with `customer_bank_account` or `creditor` + // ID of a customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers). + // If specified, this endpoint will return all mandates for the given customer. + // Cannot be used in conjunction with `customer_bank_account` or `creditor` customer?: string; - // ID of a [customer bank account](#core-endpoints-customer-bank-accounts). If - // specified, this endpoint will return all mandates for the given bank account. - // Cannot be used in conjunction with `customer` or `creditor` + // ID of a customer bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts). + // If specified, this endpoint will return all mandates for the given bank + // account. Cannot be used in conjunction with `customer` or `creditor` customer_bank_account?: string; @@ -93,10 +94,10 @@ interface MandateListRequest { mandate_type?: `${Types.MandateMandateType}`; - // Unique reference. Different schemes have different length and [character - // set](#appendix-character-sets) requirements. GoCardless will generate a - // unique reference satisfying the different scheme requirements if this field - // is left blank. + // Unique reference. Different schemes have different length and character set + // (https://developer.gocardless.com/api-reference/#appendix-character-sets) + // requirements. GoCardless will generate a unique reference satisfying the + // different scheme requirements if this field is left blank. reference?: string; diff --git a/src/services/negativeBalanceLimitService.ts b/src/services/negativeBalanceLimitService.ts index db6fb59a..aa1959c5 100644 --- a/src/services/negativeBalanceLimitService.ts +++ b/src/services/negativeBalanceLimitService.ts @@ -21,8 +21,8 @@ interface NegativeBalanceLimitListRequest { creditor?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. currency?: `${Types.NegativeBalanceLimitCurrency}`; diff --git a/src/services/outboundPaymentImportService.ts b/src/services/outboundPaymentImportService.ts index 6411c600..c91f96fb 100644 --- a/src/services/outboundPaymentImportService.ts +++ b/src/services/outboundPaymentImportService.ts @@ -34,17 +34,16 @@ interface OutboundPaymentImportListRequest { limit?: string; // The status of the outbound payment import. - // + // + // - `created`: The initial state of a new import. + // - `validating`: Import validation in progress. + // - `invalid`: Import validation failed. + // - `valid`: Import validation succeeded. + // - `processing`: Authorisation received; payments are being generated. + // - `processed`: All entries have been successfully converted into outbound + // payments. + // - `cancelled`: The import was cancelled by a user or automatically expired by + // the system. status?: `${Types.OutboundPaymentImportStatus}`; } diff --git a/src/services/outboundPaymentService.ts b/src/services/outboundPaymentService.ts index 0d1ad7f2..16373447 100644 --- a/src/services/outboundPaymentService.ts +++ b/src/services/outboundPaymentService.ts @@ -32,9 +32,12 @@ interface OutboundPaymentCreateRequest { metadata?: Types.JsonMap; // An optional reference that will appear on your customer's bank statement. - // The character limit for this reference is dependent on the scheme.
- // Faster Payments - 18 characters, including: - // "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789 &-./"
+ // The character limit for this reference is dependent on the scheme. + // + // Faster Payments reference?: string; @@ -68,9 +71,12 @@ interface OutboundPaymentWithdrawRequest { metadata?: Types.JsonMap; // An optional reference that will appear on your customer's bank statement. - // The character limit for this reference is dependent on the scheme.
- // Faster Payments - 18 characters, including: - // "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789 &-./"
+ // The character limit for this reference is dependent on the scheme. + // + // Faster Payments reference?: string; @@ -109,25 +115,26 @@ interface OutboundPaymentListRequest { limit?: string; // One of: - // + // + // - `verifying`: The payment has been created + // (https://developer.gocardless.com/api-reference/#outbound-payments-create-an-outbound-payment) + // and the verification process has begun. + // - `pending_approval`: The payment is awaiting approval + // (https://developer.gocardless.com/api-reference/#outbound-payments-approve-an-outbound-payment). + // - `scheduled`: The payment has passed verification & approval + // (https://developer.gocardless.com/api-reference/#outbound-payments-approve-an-outbound-payment), + // but processing has not yet begun. + // - `executing`: The execution date has arrived and the payment has been placed + // in queue for processing. + // - `executed`: The payment has been accepted by the scheme and is now on its + // way to the recipient. + // - `cancelled`: The payment has been cancelled + // (https://developer.gocardless.com/api-reference/#outbound-payments-cancel-an-outbound-payment) + // or was not approved + // (https://developer.gocardless.com/api-reference/#outbound-payments-approve-an-outbound-payment) + // on time. + // - `failed`: The payment was not sent, usually due to an error while or after + // executing. status?: `${Types.OutboundPaymentStatus}`; } diff --git a/src/services/payerAuthorisationService.ts b/src/services/payerAuthorisationService.ts index 2587ebe2..eef4cf8a 100644 --- a/src/services/payerAuthorisationService.ts +++ b/src/services/payerAuthorisationService.ts @@ -10,29 +10,31 @@ interface PayerAuthorisationListResponse extends Types.APIResponse { interface PayerAuthorisationCreateRequest { // All details required for the creation of a - // [Customer Bank Account](#core-endpoints-customer-bank-accounts). + // Customer Bank Account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts). bank_account: Types.PayerAuthorisationBankAccount; - // All details required for the creation of a - // [Customer](#core-endpoints-customers). + // All details required for the creation of a Customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers). customer: Types.PayerAuthorisationCustomer; - // All details required for the creation of a - // [Mandate](#core-endpoints-mandates). + // All details required for the creation of a Mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates). mandate: Types.PayerAuthorisationMandate; } interface PayerAuthorisationUpdateRequest { // All details required for the creation of a - // [Customer Bank Account](#core-endpoints-customer-bank-accounts). + // Customer Bank Account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts). bank_account: Types.PayerAuthorisationBankAccount; - // All details required for the creation of a - // [Customer](#core-endpoints-customers). + // All details required for the creation of a Customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers). customer: Types.PayerAuthorisationCustomer; - // All details required for the creation of a - // [Mandate](#core-endpoints-mandates). + // All details required for the creation of a Mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates). mandate: Types.PayerAuthorisationMandate; } diff --git a/src/services/paymentService.ts b/src/services/paymentService.ts index 40f6a47b..a583a179 100644 --- a/src/services/paymentService.ts +++ b/src/services/paymentService.ts @@ -25,22 +25,23 @@ interface PaymentCreateRequest { // A future date on which the payment should be collected. If not specified, the // payment will be collected as soon as possible. If the value is before the - // [mandate](#core-endpoints-mandates)'s `next_possible_charge_date` creation - // will fail. If the value is not a working day it will be rolled forwards to - // the next available one. + // mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates)'s + // `next_possible_charge_date` creation will fail. If the value is not a working + // day it will be rolled forwards to the next available one. charge_date?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. currency: `${Types.PaymentCurrency}`; // A human-readable description of the payment. This will be included in the // notification email GoCardless sends to your customer if your organisation - // does not send its own notifications (see [compliance - // requirements](#appendix-compliance-requirements)). + // does not send its own notifications (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). description?: string; @@ -61,40 +62,61 @@ interface PaymentCreateRequest { // Indicates how a Variable Recurring Payment (VRP) is initiated, by or on // behalf of the payer. - // + // recurring subscription payment). psu_interaction_type?: `${Types.PaymentPsuInteractionType}`; // An optional reference that will appear on your customer's bank statement. The - // character limit for this reference is dependent on the scheme.
- // ACH - 10 characters
Autogiro - 11 - // characters
Bacs - 10 characters
- // BECS - 30 characters
BECS NZ - 12 - // characters
Betalingsservice - 30 characters
- // Faster Payments - 18 characters
PAD - - // scheme doesn't offer references
PayTo - 18 - // characters
SEPA - 140 characters
Note that this - // reference must be unique (for each merchant) for the BECS scheme as it is a - // scheme requirement.

Restricted: - // You can only specify a payment reference for Bacs payments (that is, when - // collecting from the UK) if you're on the GoCardless Plus, Pro or Enterprise - // packages.

Restricted: - // You can not specify a payment reference for Faster Payments.

+ // character limit for this reference is dependent on the scheme. + // ACH + // Autogiro + // Bacs + // BECS + // BECS NZ + // Betalingsservice + // Faster Payments + // PAD + // PayTo + // SEPA + // Note that this reference must be unique (for each merchant) for the BECS + // scheme as it is a scheme requirement. Restricted: You can only specify a + // payment reference for Bacs payments (that is, when collecting from the UK) if + // you're on the GoCardless Plus, Pro or Enterprise packages + // (https://gocardless.com/pricing). + // Restricted: You can not specify a payment reference for Faster Payments. reference?: string; - // On failure, automatically retry the payment using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

+ // On failure, automatically retry the payment using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is `false`. + // Important: To be able to use intelligent retries, Success+ needs to be + // enabled in GoCardless dashboard (https://manage.gocardless.com/success-plus). + // retry_if_possible?: boolean; } @@ -119,8 +141,8 @@ interface PaymentListRequest { creditor?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. currency?: `${Types.PaymentCurrency}`; @@ -148,39 +170,36 @@ interface PaymentListRequest { // The direction to sort in. // One of: - // + // + // - `asc` + // - `desc` sort_direction?: `${Types.PaymentSortDirection}`; // Field by which to sort records. // One of: - // + // + // - `charge_date` + // - `amount` sort_field?: `${Types.PaymentSortField}`; // One of: - // + // + // - `pending_customer_approval`: we're waiting for the customer to approve this + // payment + // - `pending_submission`: the payment has been created, but not yet submitted + // to the banks + // - `submitted`: the payment has been submitted to the banks + // - `confirmed`: the payment has been confirmed as collected + // - `paid_out`: the payment has been included in a payout + // (https://developer.gocardless.com/api-reference/#core-endpoints-payouts) + // - `cancelled`: the payment has been cancelled + // - `customer_approval_denied`: the customer has denied approval for the + // payment. You should contact the customer directly + // - `failed`: the payment failed to be processed. Note that payments can fail + // after being confirmed if the failure message is sent late by the banks. + // - `charged_back`: the payment has been charged back status?: `${Types.PaymentStatus}`; @@ -195,11 +214,11 @@ interface PaymentUpdateRequest { metadata?: Types.JsonMap; - // On failure, automatically retry the payment using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

+ // On failure, automatically retry the payment using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is `false`. + // Important: To be able to use intelligent retries, Success+ needs to be + // enabled in GoCardless dashboard (https://manage.gocardless.com/success-plus). + // retry_if_possible?: boolean; } @@ -214,9 +233,10 @@ interface PaymentCancelRequest { interface PaymentRetryRequest { // A future date on which the payment should be collected. If not specified, the // payment will be collected as soon as possible. If the value is before the - // [mandate](#core-endpoints-mandates)'s `next_possible_charge_date` creation - // will fail. If the value is not a working day it will be rolled forwards to - // the next available one. + // mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates)'s + // `next_possible_charge_date` creation will fail. If the value is not a working + // day it will be rolled forwards to the next available one. charge_date?: string; diff --git a/src/services/payoutService.ts b/src/services/payoutService.ts index d6c0b777..3ad4d9b7 100644 --- a/src/services/payoutService.ts +++ b/src/services/payoutService.ts @@ -28,8 +28,8 @@ interface PayoutListRequest { creditor_bank_account?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. currency?: `${Types.PayoutCurrency}`; @@ -39,7 +39,7 @@ interface PayoutListRequest { limit?: string; // Key-value store of custom data. Up to 3 keys are permitted, with key names up - // to 50 characters and values up to 500 characters. _Note:_ This should not be + // to 50 characters and values up to 500 characters. Note: This should not be // used for storing PII data. metadata?: Types.JsonMap; @@ -53,13 +53,12 @@ interface PayoutListRequest { reference?: string; // One of: - // + // + // - `pending`: the payout has been created, but not yet sent to your bank or it + // is in the process of being exchanged through our FX provider. + // - `paid`: the payout has been sent to the your bank. FX payouts will become + // `paid` after we emit the `fx_rate_confirmed` webhook. + // - `bounced`: the payout bounced when sent, the payout can be retried. status?: `${Types.PayoutStatus}`; } diff --git a/src/services/redirectFlowService.ts b/src/services/redirectFlowService.ts index e991f7c1..ed0849c7 100644 --- a/src/services/redirectFlowService.ts +++ b/src/services/redirectFlowService.ts @@ -18,7 +18,7 @@ interface RedirectFlowCreateRequest { links?: Types.RedirectFlowCreateRequestLinks; // Key-value store of custom data. Up to 3 keys are permitted, with key names up - // to 50 characters and values up to 500 characters. _Note:_ This should not be + // to 50 characters and values up to 500 characters. Note: This should not be // used for storing PII data. metadata?: Types.JsonMap; diff --git a/src/services/refundService.ts b/src/services/refundService.ts index 9f9004a6..dba49710 100644 --- a/src/services/refundService.ts +++ b/src/services/refundService.ts @@ -22,21 +22,43 @@ interface RefundCreateRequest { metadata?: Types.JsonMap; // An optional reference that will appear on your customer's bank statement. The - // character limit for this reference is dependent on the scheme.
- // ACH - 10 characters
Autogiro - 11 - // characters
Bacs - 10 characters
- // BECS - 30 characters
BECS NZ - 12 - // characters
Betalingsservice - 30 characters
- // Faster Payments - 18 characters
PAD - - // scheme doesn't offer references
PayTo - 18 - // characters
SEPA - 140 characters
Note that this - // reference must be unique (for each merchant) for the BECS scheme as it is a - // scheme requirement.

Restricted: - // You can only specify a payment reference for Bacs payments (that is, when - // collecting from the UK) if you're on the GoCardless Plus, Pro or Enterprise - // packages.

Restricted: - // You can not specify a payment reference for Faster Payments.

+ // character limit for this reference is dependent on the scheme. + // ACH + // Autogiro + // Bacs + // BECS + // BECS NZ + // Betalingsservice + // Faster Payments + // PAD + // PayTo + // SEPA + // Note that this reference must be unique (for each merchant) for the BECS + // scheme as it is a scheme requirement. Restricted: You can only specify a + // payment reference for Bacs payments (that is, when collecting from the UK) if + // you're on the GoCardless Plus, Pro or Enterprise packages + // (https://gocardless.com/pricing). + // Restricted: You can not specify a payment reference for Faster Payments. reference?: string; @@ -45,12 +67,12 @@ interface RefundCreateRequest { // other partial refunds against this payment, this value should be the sum of // the // existing refunds plus the amount of the refund being created. - //
+ // // Must be supplied if `links[payment]` is present. - //

It is possible to opt out of requiring - // `total_amount_confirmation`, please contact our support team for more - // information.

+ // + // It is possible to opt out of requiring `total_amount_confirmation`, please + // contact our support team (mailto:support@gocardless.com) for more + // information. total_amount_confirmation?: string; } @@ -81,11 +103,9 @@ interface RefundListRequest { payment?: string; // Whether a refund was issued against a mandate or a payment. One of: - // + // + // - `payment`: default returns refunds created against payments only + // - `mandate`: returns refunds created against mandates only refund_type?: `${Types.RefundRefundType}`; } diff --git a/src/services/subscriptionService.ts b/src/services/subscriptionService.ts index 816c6fec..9206fa8e 100644 --- a/src/services/subscriptionService.ts +++ b/src/services/subscriptionService.ts @@ -24,8 +24,8 @@ interface SubscriptionCreateRequest { count?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. + // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. currency: string; @@ -36,13 +36,12 @@ interface SubscriptionCreateRequest { day_of_month?: string; // Date on or after which no further payments should be created. - //
+ // // If this field is blank and `count` is not specified, the subscription will // continue forever. - //
- //

Deprecated: This field will be - // removed in a future API version. Use `count` to specify a number of payments - // instead.

+ // + // Deprecated: This field will be removed in a future API version. Use `count` + // to specify a number of payments instead. end_date?: string; @@ -68,7 +67,6 @@ interface SubscriptionCreateRequest { // Name of the month on which to charge a customer. Must be lowercase. Only // applies // when the interval_unit is `yearly`. - // month?: `${Types.SubscriptionMonth}`; @@ -81,26 +79,30 @@ interface SubscriptionCreateRequest { // payment // created and will appear on your customer's bank statement. See the // documentation for - // the [create payment endpoint](#payments-create-a-payment) for more details. - //
- //

Restricted: You need your own - // Service User Number to specify a payment reference for Bacs payments.

+ // the create payment endpoint + // (https://developer.gocardless.com/api-reference/#payments-create-a-payment) + // for more details. + // + // Restricted: You need your own Service User Number to specify a payment + // reference for Bacs payments. payment_reference?: string; - // On failure, automatically retry payments using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

+ // On failure, automatically retry payments using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is `false`. + // Important: To be able to use intelligent retries, Success+ needs to be + // enabled in GoCardless dashboard (https://manage.gocardless.com/success-plus). + // retry_if_possible?: boolean; // The date on which the first payment should be charged. Must be on or after - // the [mandate](#core-endpoints-mandates)'s `next_possible_charge_date`. When - // left blank and `month` or `day_of_month` are provided, this will be set to - // the date of the first payment. If created without `month` or `day_of_month` - // this will be set as the mandate's `next_possible_charge_date` + // the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates)'s + // `next_possible_charge_date`. When left blank and `month` or `day_of_month` + // are provided, this will be set to the date of the first payment. If created + // without `month` or `day_of_month` this will be set as the mandate's + // `next_possible_charge_date` start_date?: string; } @@ -131,14 +133,14 @@ interface SubscriptionListRequest { mandate?: string; // Upto 5 of: - // + // + // - `pending_customer_approval` + // - `customer_approval_denied` + // - `active` + // - `finished` + // - `cancelled` + // - `paused` + // // Omit entirely to include subscriptions in all states. status?: `${Types.SubscriptionStatus}`[]; @@ -170,18 +172,20 @@ interface SubscriptionUpdateRequest { // payment // created and will appear on your customer's bank statement. See the // documentation for - // the [create payment endpoint](#payments-create-a-payment) for more details. - //
- //

Restricted: You need your own - // Service User Number to specify a payment reference for Bacs payments.

+ // the create payment endpoint + // (https://developer.gocardless.com/api-reference/#payments-create-a-payment) + // for more details. + // + // Restricted: You need your own Service User Number to specify a payment + // reference for Bacs payments. payment_reference?: string; - // On failure, automatically retry payments using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

+ // On failure, automatically retry payments using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is `false`. + // Important: To be able to use intelligent retries, Success+ needs to be + // enabled in GoCardless dashboard (https://manage.gocardless.com/success-plus). + // retry_if_possible?: boolean; } @@ -195,11 +199,11 @@ interface SubscriptionPauseRequest { // The number of cycles to pause a subscription for. A cycle is one duration of // `interval` and `interval_unit`. This should be a non zero positive value. // For AUD subscriptions with `interval_unit: weekly` the minimum value varies - // between `3` & `4` because of the [mandatory minimum waiting - // period](#subscriptions-resume-a-subscription). + // between `3` & `4` because of the mandatory minimum waiting period + // (https://developer.gocardless.com/api-reference/#subscriptions-resume-a-subscription). // For NZD subscriptions with `interval_unit: weekly` the minimum value is `2` - // because of the [mandatory minimum waiting - // period](#subscriptions-resume-a-subscription). + // because of the mandatory minimum waiting period + // (https://developer.gocardless.com/api-reference/#subscriptions-resume-a-subscription). pause_cycles?: number; } diff --git a/src/types/Types.ts b/src/types/Types.ts index f8bbf7cb..7c1388b4 100644 --- a/src/types/Types.ts +++ b/src/types/Types.ts @@ -7,29 +7,29 @@ export type Balance = { amount?: number; // Type of the balance. Could be one of - // + // submitting the payouts to our partner bank. balance_type?: `${BalanceBalanceType}`; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: `${BalanceCurrency}`; - // Dynamic [timestamp](#api-usage-dates-and-times) recording when this - // resource was last updated. + // Dynamic timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times) + // recording when this resource was last updated. last_updated_at?: string; // Resources linked to this Balance. @@ -55,7 +55,8 @@ export enum BalanceCurrency { /** Type for a balancelinks resource. */ export type BalanceLinks = { - // ID of the associated [creditor](#core-endpoints-creditors). + // ID of the associated creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). creditor?: string; }; @@ -73,11 +74,11 @@ export type BankAccountDetail = { // Base64 URL encoded JWE header values, containing the following keys: // - // - `alg`: the asymmetric encryption type used to encrypt symmetric key, - // e.g: `RSA-OAEP`. - // - `enc`: the content encryption type, e.g: `A256GCM`. - // - `kid`: the ID of an RSA-2048 public key, from your JWKS, used to - // encrypt the AES key. + // - `alg`: the asymmetric encryption type used to encrypt symmetric key, e.g: + // `RSA-OAEP`. + // - `enc`: the content encryption type, e.g: `A256GCM`. + // - `kid`: the ID of an RSA-2048 public key, from your JWKS, used to encrypt + // the AES key. protected?: string; // Base64 URL encoded authentication tag, used to verify payload integrity @@ -96,31 +97,27 @@ export type BankAccountHolderVerification = { id: string; // Result of the verification, could be one of - // + // + // - `full_match`: The verification has confirmed that the account name + // exactly matches the details provided. + // - `partial_match`: The verification has confirmed that the account name is + // similar but does not match to the details provided. + // - `no_match`: The verification concludes the provided name does not match + // the account details. + // - `unable_to_match`: The verification could not be performed due to + // recipient bank issues or technical issues result?: `${BankAccountHolderVerificationResult}`; // The status of the bank account holder verification. - // // + // - `pending`: We have triggered the verification, but the result has not + // come back yet. + // - `completed`: The verification is complete and is ready to be used. status: `${BankAccountHolderVerificationStatus}`; // Type of the verification that has been performed - // eg. [Confirmation of - // Payee](https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/) + // eg. Confirmation of Payee + // (https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/) type: `${BankAccountHolderVerificationType}`; }; @@ -151,8 +148,9 @@ export type BankAuthorisation = { // Type of authorisation, can be either 'mandate' or 'payment'. authorisation_type?: `${BankAuthorisationAuthorisationType}`; - // Fixed [timestamp](#api-usage-dates-and-times), recording when the user has - // been authorised. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when the user has been authorised. authorised_at?: string | null; // Timestamp when the flow was created @@ -165,8 +163,9 @@ export type BankAuthorisation = { // Unique identifier, beginning with "BAU". id: string; - // Fixed [timestamp](#api-usage-dates-and-times), recording when the - // authorisation URL has been visited. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when the authorisation URL has been visited. last_visited_at?: string | null; // Resources linked to this BankAuthorisation. @@ -190,10 +189,13 @@ export type BankAuthorisation = { // Please note: bank authorisations can still fail despite an // `outcome=success` on the `redirect_uri`. It is therefore recommended to // wait for the relevant bank authorisation event, such as - // [`BANK_AUTHORISATION_AUTHORISED`](#billing-request-bankauthorisationauthorised), - // [`BANK_AUTHORISATION_DENIED`](#billing-request-bankauthorisationdenied), or - // [`BANK_AUTHORISATION_FAILED`](#billing-request-bankauthorisationfailed) in - // order to show the correct outcome to the user. + // `BANK_AUTHORISATION_AUTHORISED` + // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationauthorised), + // `BANK_AUTHORISATION_DENIED` + // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationdenied), + // or `BANK_AUTHORISATION_FAILED` + // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationfailed) + // in order to show the correct outcome to the user. // // The BillingRequestFlow ID will also be appended to the `redirect_uri` as // query parameter `id=BRF123`. @@ -207,8 +209,9 @@ export type BankAuthorisation = { /** Type for a bankauthorisationcreaterequestlinks resource. */ export type BankAuthorisationCreateRequestLinks = { - // ID of the [billing request](#billing-requests-billing-requests) against - // which this authorisation was created. + // ID of the billing request + // (https://developer.gocardless.com/api-reference/#billing-requests-billing-requests) + // against which this authorisation was created. billing_request?: string; }; @@ -219,19 +222,23 @@ export enum BankAuthorisationAuthorisationType { /** Type for a bankauthorisationlinks resource. */ export type BankAuthorisationLinks = { - // ID of the [billing request](#billing-requests-billing-requests) against - // which this authorisation was created. + // ID of the billing request + // (https://developer.gocardless.com/api-reference/#billing-requests-billing-requests) + // against which this authorisation was created. billing_request?: string; - // ID of the [institution](#billing-requests-institutions) against which this - // authorisation was created. + // ID of the institution + // (https://developer.gocardless.com/api-reference/#billing-requests-institutions) + // against which this authorisation was created. institution?: string; }; /** Type for a bankdetailslookup resource. */ export type BankDetailsLookup = { - // Array of [schemes](#mandates_scheme) supported for this bank account. This - // will be an empty array if the bank account is not reachable by any schemes. + // Array of schemes + // (https://developer.gocardless.com/api-reference/#mandates_scheme) supported + // for this bank account. This will be an empty array if the bank account is + // not reachable by any schemes. available_debit_schemes?: `${BankDetailsLookupAvailableDebitScheme}`[]; // The name of the bank with which the account is held (if available). @@ -239,9 +246,9 @@ export type BankDetailsLookup = { // ISO 9362 SWIFT BIC of the bank with which the account is held. // - //

Even if no BIC is returned for an account, GoCardless may - // still be able to collect payments from it - you should refer to the - // `available_debit_schemes` attribute to determine reachability.

+ // Even if no BIC is returned for an account, GoCardless may still be able to + // collect payments from it - you should refer to the + // `available_debit_schemes` attribute to determine reachability. bic?: string | null; }; @@ -264,16 +271,17 @@ export type BillingRequest = { // fulfilled. actions?: BillingRequestAction[]; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // (Optional) If true, this billing request can fallback from instant payment // to direct debit. // Should not be set if GoCardless payment intelligence feature is used. // - // See [Billing Requests: Retain customers with - // Fallbacks](https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/) + // See Billing Requests: Retain customers with Fallbacks + // (https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/) // for more information. fallback_enabled?: boolean; @@ -308,8 +316,8 @@ export type BillingRequest = { // Specifies the underlying purpose of the payment. Defines the specific // reason or type of service/goods the payment relates to, improving // straight-through processing and compliance. - // See [VRP Commercial Payment Purpose - // Codes](https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) + // See VRP Commercial Payment Purpose Codes + // (https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) // for the complete list of valid codes. payment_purpose_code?: string; @@ -319,25 +327,21 @@ export type BillingRequest = { // Specifies the high-level purpose/category of a mandate and/or payment using // a set of pre-defined categories. Provides context on the nature and reason // for the payment to facilitate processing and compliance. - // See [Billing Request Purpose - // Codes](https://developer.gocardless.com/billing-request-purpose-codes/) for - // the complete list of valid codes. + // See Billing Request Purpose Codes + // (https://developer.gocardless.com/billing-request-purpose-codes/) for the + // complete list of valid codes. purpose_code?: `${BillingRequestPurposeCode}`; // resources?: BillingRequestResources; // One of: - // + // + // - `pending`: the billing request is pending and can be used + // - `ready_to_fulfil`: the billing request is ready to fulfil + // - `fulfilling`: the billing request is currently undergoing fulfilment + // - `fulfilled`: the billing request has been fulfilled and a payment created + // - `cancelled`: the billing request has been cancelled and cannot be used status?: `${BillingRequestStatus}`; // Request for a subscription @@ -346,18 +350,19 @@ export type BillingRequest = { /** Type for a billingrequestcreaterequestlinks resource. */ export type BillingRequestCreateRequestLinks = { - // ID of the associated [creditor](#core-endpoints-creditors). Only required - // if your account manages multiple creditors. + // ID of the associated creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). + // Only required if your account manages multiple creditors. creditor?: string; - // ID of the [customer](#core-endpoints-customers) against which this request - // should be made. + // ID of the customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers) + // against which this request should be made. customer?: string; - // (Optional) ID of the - // [customer_bank_account](#core-endpoints-customer-bank-accounts) against - // which this request should be made. - // + // (Optional) ID of the customer_bank_account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts) + // against which this request should be made. customer_bank_account?: string; }; @@ -447,21 +452,21 @@ export type BillingRequestCustomer = { // Customer's first name. Required unless a `company_name` is provided. given_name?: string | null; - // [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. + // ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. // Used as the language for notification emails sent by GoCardless if your - // organisation does not send its own (see [compliance - // requirements](#appendix-compliance-requirements)). Currently only "en", - // "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are supported. - // If this is not provided and a customer was linked during billing request - // creation, the linked customer language will be used. Otherwise, the - // language is default to "en". + // organisation does not send its own (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). + // Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", + // "sv" are supported. If this is not provided and a customer was linked + // during billing request creation, the linked customer language will be used. + // Otherwise, the language is default to "en". language?: string | null; // Key-value store of custom data. Up to 3 keys are permitted, with key names // up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string }; - // [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, + // ITU E.123 (https://en.wikipedia.org/wiki/E.123) formatted phone number, // including country code. phone_number?: string | null; }; @@ -480,8 +485,8 @@ export type BillingRequestCustomerBillingDetail = { // The city of the customer's address. city?: string | null; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string | null; // For Danish customers only. The civic/company number (CPR or CVR) of the @@ -495,14 +500,13 @@ export type BillingRequestCustomerBillingDetail = { // // Not required for creating offline mandates where `authorisation_source` is // set to telephone or paper. - // ip_address?: string | null; // The customer's postal code. postal_code?: string | null; // The customer's address region, county or department. For US customers a 2 - // letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state + // letter ISO3166-2:US (https://en.wikipedia.org/wiki/ISO_3166-2:US) state // code is required (e.g. `CA` for California). region?: string | null; @@ -547,6 +551,7 @@ export type BillingRequestAction = { // Describes whether we inferred the institution from the provided bank // account details. One of: + // // - `not_needed`: we won't attempt to infer the institution as it is not // needed. Either because it was manually selected or the billing request does // not support this feature @@ -555,7 +560,6 @@ export type BillingRequestAction = { // - `failed`: we weren't able to infer the institution // - `success`: we inferred the institution and added it to the resources of a // Billing Request - // institution_guess_status?: `${BillingRequestActionInstitutionGuessStatus}`; // Informs you whether the action is required to fulfil the billing request or @@ -641,20 +645,20 @@ export type BillingRequestInstalmentScheduleRequest = { // denomination for the currency (e.g. pence in GBP, cents in EUR). app_fee?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "USD" and "CAD" are supported. currency?: string; // An explicit array of instalment payments, each specifying at least an - // `amount` and `charge_date`. See [create (with - // dates)](#instalment-schedules-create-with-dates) + // `amount` and `charge_date`. See create (with dates) + // (https://developer.gocardless.com/api-reference/#instalment-schedules-create-with-dates) instalments_with_dates?: BillingRequestInstalmentScheduleRequestInstalmentsWithDate[] | null; // Frequency of the payments you want to create, together with an array of // payment // amounts to be collected, with a specified start date for the first payment. - // See [create (with schedule)](#instalment-schedules-create-with-schedule) - // + // See create (with schedule) + // (https://developer.gocardless.com/api-reference/#instalment-schedules-create-with-schedule) instalments_with_schedule?: BillingRequestInstalmentScheduleRequestInstalmentsWithSchedule | null; // Resources linked to this BillingRequestInstalmentScheduleRequest. @@ -673,15 +677,16 @@ export type BillingRequestInstalmentScheduleRequest = { // payment // created and will appear on your customer's bank statement. See the // documentation for - // the [create payment endpoint](#payments-create-a-payment) for more details. - //
+ // the create payment endpoint + // (https://developer.gocardless.com/api-reference/#payments-create-a-payment) + // for more details. payment_reference?: string | null; - // On failure, automatically retry payments using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

+ // On failure, automatically retry payments using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is + // `false`. Important: To be able to use intelligent retries, Success+ needs + // to be enabled in GoCardless dashboard + // (https://manage.gocardless.com/success-plus). retry_if_possible?: boolean; // The total amount of the instalment schedule, defined as the sum of all @@ -706,14 +711,16 @@ export type BillingRequestInstalmentScheduleRequestInstalmentsWithDate = { // A future date on which the payment should be collected. If the date // is before the next_possible_charge_date on the - // [mandate](#core-endpoints-mandates), it will be automatically rolled + // mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates), + // it will be automatically rolled // forwards to that date. charge_date: string | null; // A human-readable description of the payment. This will be included in the // notification email GoCardless sends to your customer if your organisation - // does not send its own notifications (see [compliance - // requirements](#appendix-compliance-requirements)). + // does not send its own notifications (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). description?: string | null; }; @@ -721,12 +728,10 @@ export type BillingRequestInstalmentScheduleRequestInstalmentsWithDate = { export type BillingRequestInstalmentScheduleRequestInstalmentsWithSchedule = { // List of amounts of each instalment, in the lowest denomination for the // currency (e.g. cents in USD). - // amounts: string[]; // Number of `interval_units` between charge dates. Must be greater than or // equal to `1`. - // interval: number; // The unit of time between customer charge dates. One of `weekly`, `monthly` @@ -734,10 +739,12 @@ export type BillingRequestInstalmentScheduleRequestInstalmentsWithSchedule = { interval_unit: `${BillingRequestInstalmentScheduleRequestInstalmentsWithScheduleIntervalUnit}`; // The date on which the first payment should be charged. Must be on or after - // the [mandate](#core-endpoints-mandates)'s `next_possible_charge_date`. When - // left blank and `month` or `day_of_month` are provided, this will be set to - // the date of the first payment. If created without `month` or `day_of_month` - // this will be set as the mandate's `next_possible_charge_date` + // the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates)'s + // `next_possible_charge_date`. When left blank and `month` or `day_of_month` + // are provided, this will be set to the date of the first payment. If created + // without `month` or `day_of_month` this will be set as the mandate's + // `next_possible_charge_date` start_date?: string | null; }; @@ -749,30 +756,31 @@ export enum BillingRequestInstalmentScheduleRequestInstalmentsWithScheduleInterv /** Type for a billingrequestinstalmentschedulerequestlinks resource. */ export type BillingRequestInstalmentScheduleRequestLinks = { - // (Optional) ID of the - // [instalment_schedule](#core-endpoints-instalment-schedules) that was - // created from this instalment schedule request. - // + // (Optional) ID of the instalment_schedule + // (https://developer.gocardless.com/api-reference/#core-endpoints-instalment-schedules) + // that was created from this instalment schedule request. instalment_schedule?: string; }; /** Type for a billingrequestlinks resource. */ export type BillingRequestLinks = { - // (Optional) ID of the [bank - // authorisation](#billing-requests-bank-authorisations) that was used to - // verify this request. + // (Optional) ID of the bank authorisation + // (https://developer.gocardless.com/api-reference/#billing-requests-bank-authorisations) + // that was used to verify this request. bank_authorisation?: string; - // ID of the associated [creditor](#core-endpoints-creditors). + // ID of the associated creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). creditor?: string; - // ID of the [customer](#core-endpoints-customers) that will be used for this - // request + // ID of the customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers) + // that will be used for this request customer?: string; - // (Optional) ID of the - // [customer_bank_account](#core-endpoints-customer-bank-accounts) that will - // be used for this request + // (Optional) ID of the customer_bank_account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts) + // that will be used for this request customer_bank_account?: string; // ID of the customer billing detail that will be used for this request @@ -781,16 +789,17 @@ export type BillingRequestLinks = { // (Optional) ID of the associated instalment schedule request instalment_schedule_request?: string; - // (Optional) ID of the - // [instalment_schedule](#core-endpoints-instalment-schedules) that was - // created from this instalment schedule request. + // (Optional) ID of the instalment_schedule + // (https://developer.gocardless.com/api-reference/#core-endpoints-instalment-schedules) + // that was created from this instalment schedule request. instalment_schedule_request_instalment_schedule?: string; // (Optional) ID of the associated mandate request mandate_request?: string; - // (Optional) ID of the [mandate](#core-endpoints-mandates) that was created - // from this mandate request. this mandate request. + // (Optional) ID of the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // that was created from this mandate request. this mandate request. mandate_request_mandate?: string; // ID of the associated organisation. @@ -802,52 +811,51 @@ export type BillingRequestLinks = { // (Optional) ID of the associated payment request payment_request?: string; - // (Optional) ID of the [payment](#core-endpoints-payments) that was created - // from this payment request. + // (Optional) ID of the payment + // (https://developer.gocardless.com/api-reference/#core-endpoints-payments) + // that was created from this payment request. payment_request_payment?: string; // (Optional) ID of the associated subscription request subscription_request?: string; - // (Optional) ID of the [subscription](#core-endpoints-subscriptions) that was - // created from this subscription request. + // (Optional) ID of the subscription + // (https://developer.gocardless.com/api-reference/#core-endpoints-subscriptions) + // that was created from this subscription request. subscription_request_subscription?: string; }; /** Type for a billingrequestmandaterequest resource. */ export type BillingRequestMandateRequest = { - // This field is ACH specific, sometimes referred to as [SEC - // code](https://www.moderntreasury.com/learn/sec-codes). + // This field is ACH specific, sometimes referred to as SEC code + // (https://www.moderntreasury.com/learn/sec-codes). // // This is the way that the payer gives authorisation to the merchant. - // web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC + // web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC // code: WEB) - // telephone: Authorisation is provided orally over telephone (maps to SEC + // telephone: Authorisation is provided orally over telephone (maps to SEC // code: TEL) - // paper: Authorisation is provided in writing and signed, or similarly + // paper: Authorisation is provided in writing and signed, or similarly // authenticated (maps to SEC code: PPD) - // authorisation_source?: `${BillingRequestMandateRequestAuthorisationSource}`; // This attribute represents the authorisation type between the payer and // merchant. It can be set to `one_off`, // `recurring` or `standing` for ACH scheme. And `single`, `recurring` and - // `sporadic` for PAD scheme. _Note:_ This is only supported for ACH and PAD + // `sporadic` for PAD scheme. Note: This is only supported for ACH and PAD // schemes. - // consent_type?: string | null; // Constraints that will apply to the mandate_request. (Optional) Specifically // required for PayTo and VRP. constraints?: BillingRequestMandateRequestConstraints | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. currency?: string; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. - // description?: string | null; // This field will decide how GoCardless handles settlement of funds from the @@ -857,8 +865,7 @@ export type BillingRequestMandateRequest = { // out. // - `direct` will be a direct transfer from the payer's account to the // merchant where - // invoicing will be handled separately. - // + // invoicing will be handled separately. funds_settlement?: `${BillingRequestMandateRequestFundsSettlement}`; // Resources linked to this BillingRequestMandateRequest. @@ -889,16 +896,14 @@ export type BillingRequestMandateRequest = { sweeping?: boolean; // Verification preference for the mandate. One of: - // + // + // - `minimum`: only verify if absolutely required, such as when part of + // scheme rules + // - `recommended`: in addition to `minimum`, use the GoCardless payment + // intelligence solution to decide if a payer should be verified + // - `when_available`: if verification mechanisms are available, use them + // - `always`: as `when_available`, but fail to create the Billing Request if + // a mechanism isn't available // // By default, all Billing Requests use the `recommended` verification // preference. It uses GoCardless payment intelligence solution to determine @@ -910,8 +915,8 @@ export type BillingRequestMandateRequest = { // Verified Mandates as they are released in new schemes, please use the // `minimum` verification preference. // - // See [Billing Requests: Creating Verified - // Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/) + // See Billing Requests: Creating Verified Mandates + // (https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/) // for more information. verify?: `${BillingRequestMandateRequestVerify}`; }; @@ -932,19 +937,17 @@ export type BillingRequestMandateRequestConstraints = { // will not have an end date. Keep in mind the end date must take into account // how long it will // take the user to set up this agreement via the Billing Request. - // end_date?: string; // The maximum amount that can be charged for a single payment in the lowest - // denomination for the currency (e.g. pence in GBP, cents in EUR). _Note:_ + // denomination for the currency (e.g. pence in GBP, cents in EUR). Note: // Required for PayTo and VRP. max_amount_per_payment?: number; // A constraint where you can specify info (free text string) about how // payments are calculated. For use when payments vary and cannot be expressed - // as a fixed amount and frequency. _Note:_ This is only supported for ACH and + // as a fixed amount and frequency. Note: This is only supported for ACH and // PAD schemes. - // payment_method?: string; // Caps on the total amount and/or number of payments that can be collected @@ -952,10 +955,9 @@ export type BillingRequestMandateRequestConstraints = { // repeating period (e.g. no more than a set amount per month), as opposed to // `max_amount_per_payment` which caps a single payment. // - // _Note:_ Required for VRP, where exactly one periodic limit must be - // provided. Optional for + // Note: Required for VRP, where exactly one periodic limit must be provided. + // Optional for // PayTo. - // periodic_limits?: BillingRequestMandateRequestConstraintsPeriodicLimit[]; // The date from which payments can be taken. @@ -963,7 +965,6 @@ export type BillingRequestMandateRequestConstraints = { // This is an optional field and if it is not supplied the start date will be // set to the day // authorisation happens. - // start_date?: string; }; @@ -991,15 +992,13 @@ export type BillingRequestMandateRequestConstraintsPeriodicLimit = { // period, not // reduced proportionally. // - // _Note:_ Has no effect when period is `flexible`. - // + // Note: Has no effect when period is `flexible`. alignment?: `${BillingRequestMandateRequestConstraintsPeriodicLimitAlignment}`; // The maximum number of payments that can be collected in this periodic // limit. // - // _Note:_ Only supported for the PayTo scheme, where it is optional. - // + // Note: Only supported for the PayTo scheme, where it is optional. max_payments?: number; // The maximum total amount that can be charged for all payments in this @@ -1007,8 +1006,7 @@ export type BillingRequestMandateRequestConstraintsPeriodicLimit = { // in the lowest denomination for the currency (e.g. pence in GBP, cents in // EUR). // - // _Note:_ Required for VRP. This is not permitted for the PayTo scheme. - // + // Note: Required for VRP. This is not permitted for the PayTo scheme. max_total_amount?: number; // The repeating period for this mandate. Required whenever a periodic limit @@ -1016,7 +1014,6 @@ export type BillingRequestMandateRequestConstraintsPeriodicLimit = { // (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, // this // defaults to flexible. - // period?: `${BillingRequestMandateRequestConstraintsPeriodicLimitPeriod}`; }; @@ -1040,9 +1037,9 @@ export enum BillingRequestMandateRequestFundsSettlement { /** Type for a billingrequestmandaterequestlinks resource. */ export type BillingRequestMandateRequestLinks = { - // (Optional) ID of the [mandate](#core-endpoints-mandates) that was created - // from this mandate request. this mandate request. - // + // (Optional) ID of the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // that was created from this mandate request. this mandate request. mandate?: string; }; @@ -1063,14 +1060,13 @@ export type BillingRequestPaymentRequest = { // denomination for the currency (e.g. pence in GBP, cents in EUR). app_fee?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. `GBP` and `EUR` supported; `GBP` with your customers in the UK and // for `EUR` with your customers in supported Eurozone countries only. currency?: string; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. - // description?: string | null; // This field will decide how GoCardless handles settlement of funds from the @@ -1080,8 +1076,7 @@ export type BillingRequestPaymentRequest = { // out. // - `direct` will be a direct transfer from the payer's account to the // merchant where - // invoicing will be handled separately. - // + // invoicing will be handled separately. funds_settlement?: `${BillingRequestPaymentRequestFundsSettlement}`; // Resources linked to this BillingRequestPaymentRequest. @@ -1094,7 +1089,6 @@ export type BillingRequestPaymentRequest = { // A custom payment reference defined by the merchant. It is only available // for payments on the PayTo scheme or payments using the Direct Funds // settlement model on the Faster Payments scheme. - // reference?: string | null; // (Optional) A scheme used for Open Banking payments. Currently @@ -1113,8 +1107,9 @@ export enum BillingRequestPaymentRequestFundsSettlement { /** Type for a billingrequestpaymentrequestlinks resource. */ export type BillingRequestPaymentRequestLinks = { - // (Optional) ID of the [payment](#core-endpoints-payments) that was created - // from this payment request. + // (Optional) ID of the payment + // (https://developer.gocardless.com/api-reference/#core-endpoints-payments) + // that was created from this payment request. payment?: string; }; @@ -1139,8 +1134,9 @@ export type BillingRequestResourcesCustomer = { // "Personal PAD"). company_name?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // Customer's email address. Required in most cases, as this allows GoCardless @@ -1156,20 +1152,20 @@ export type BillingRequestResourcesCustomer = { // Unique identifier, beginning with "CU". id?: string; - // [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. + // ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. // Used as the language for notification emails sent by GoCardless if your - // organisation does not send its own (see [compliance - // requirements](#appendix-compliance-requirements)). Currently only "en", - // "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are supported. - // If this is not provided, the language will be chosen based on the - // `country_code` (if supplied) or default to "en". + // organisation does not send its own (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). + // Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", + // "sv" are supported. If this is not provided, the language will be chosen + // based on the `country_code` (if supplied) or default to "en". language?: string | null; // Key-value store of custom data. Up to 3 keys are permitted, with key names // up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string }; - // [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, + // ITU E.123 (https://en.wikipedia.org/wiki/E.123) formatted phone number, // including country code. phone_number?: string | null; }; @@ -1179,8 +1175,9 @@ export type BillingRequestResourcesCustomerBankAccount = { // Name of the account holder, as known by the bank. The full name provided // when the customer is created is stored and is available via the API, but is // transliterated, upcased, and truncated to 18 characters in bank - // submissions. This field is required unless the request includes a [customer - // bank account token](#javascript-flow-customer-bank-account-tokens). + // submissions. This field is required unless the request includes a customer + // bank account token + // (https://developer.gocardless.com/api-reference/#javascript-flow-customer-bank-account-tokens). account_holder_name?: string; // The last few digits of the account number. Currently 4 digits for NZD bank @@ -1188,8 +1185,9 @@ export type BillingRequestResourcesCustomerBankAccount = { account_number_ending?: string; // Bank account type. Required for USD-denominated bank accounts. Must not be - // provided for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // provided for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${BillingRequestResourcesCustomerBankAccountAccountType}`; // A token to uniquely refer to a set of bank account details. This feature is @@ -1199,17 +1197,18 @@ export type BillingRequestResourcesCustomerBankAccount = { // Name of bank, taken from the bank details. bank_name?: string; - // [ISO 3166-1 alpha-2 - // code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). + // ISO 3166-1 alpha-2 code + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). // Defaults to the country code of the `iban` if supplied, otherwise is // required. country_code?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: string | null; @@ -1226,6 +1225,19 @@ export type BillingRequestResourcesCustomerBankAccount = { // Key-value store of custom data. Up to 3 keys are permitted, with key names // up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string }; + + // The result of the payer name verification check performed when the bank + // account was created. Only present if a check was performed. + // + // - `full`: The name provided matches the name held by the bank. + // - `close`: The name provided is a close but not exact match to the name + // held by the bank. + // - `cannot_perform_verification`: A verification was attempted but could not + // be completed. This can happen for a number of reasons, including the + // account holder's bank not participating in the verification scheme, the + // account not being eligible for verification (e.g. the account holder has + // opted out), or the bank details not being resolvable, among others. + payer_name_verification_result?: `${BillingRequestResourcesCustomerBankAccountPayerNameVerificationResult}`; }; export enum BillingRequestResourcesCustomerBankAccountAccountType { @@ -1235,11 +1247,18 @@ export enum BillingRequestResourcesCustomerBankAccountAccountType { /** Type for a billingrequestresourcescustomerbankaccountlinks resource. */ export type BillingRequestResourcesCustomerBankAccountLinks = { - // ID of the [customer](#core-endpoints-customers) that owns this bank - // account. + // ID of the customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers) + // that owns this bank account. customer?: string; }; +export enum BillingRequestResourcesCustomerBankAccountPayerNameVerificationResult { + Full = 'full', + Close = 'close', + CannotPerformVerification = 'cannot_perform_verification', +} + /** Type for a billingrequestresourcescustomerbillingdetail resource. */ export type BillingRequestResourcesCustomerBillingDetail = { // The first line of the customer's address. @@ -1254,12 +1273,13 @@ export type BillingRequestResourcesCustomerBillingDetail = { // The city of the customer's address. city?: string | null; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // For Danish customers only. The civic/company number (CPR or CVR) of the @@ -1276,14 +1296,13 @@ export type BillingRequestResourcesCustomerBillingDetail = { // // Not required for creating offline mandates where `authorisation_source` is // set to telephone or paper. - // ip_address?: string | null; // The customer's postal code. postal_code?: string | null; // The customer's address region, county or department. For US customers a 2 - // letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state + // letter ISO3166-2:US (https://en.wikipedia.org/wiki/ISO_3166-2:US) state // code is required (e.g. `CA` for California). region?: string | null; @@ -1311,7 +1330,7 @@ export type BillingRequestSubscriptionRequest = { // The total number of payments that should be taken by this subscription. count?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "USD" and "CAD" are supported. currency?: string; @@ -1338,7 +1357,6 @@ export type BillingRequestSubscriptionRequest = { // Name of the month on which to charge a customer. Must be lowercase. Only // applies // when the interval_unit is `yearly`. - // month?: `${BillingRequestSubscriptionRequestMonth}`; // Optional name for the subscription. This will be set as the description on @@ -1349,15 +1367,16 @@ export type BillingRequestSubscriptionRequest = { // payment // created and will appear on your customer's bank statement. See the // documentation for - // the [create payment endpoint](#payments-create-a-payment) for more details. - //
+ // the create payment endpoint + // (https://developer.gocardless.com/api-reference/#payments-create-a-payment) + // for more details. payment_reference?: string | null; - // On failure, automatically retry payments using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

+ // On failure, automatically retry payments using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is + // `false`. Important: To be able to use intelligent retries, Success+ needs + // to be enabled in GoCardless dashboard + // (https://manage.gocardless.com/success-plus). retry_if_possible?: boolean; // The date on which the first payment should be charged. If fulfilled after @@ -1366,7 +1385,6 @@ export type BillingRequestSubscriptionRequest = { // set to the date of the first payment. // If created without `month` or `day_of_month` this will be set as the // mandate's `next_possible_charge_date`. - // start_date?: string | null; }; @@ -1378,9 +1396,9 @@ export enum BillingRequestSubscriptionRequestIntervalUnit { /** Type for a billingrequestsubscriptionrequestlinks resource. */ export type BillingRequestSubscriptionRequestLinks = { - // (Optional) ID of the [subscription](#core-endpoints-subscriptions) that was - // created from this subscription request. - // + // (Optional) ID of the subscription + // (https://developer.gocardless.com/api-reference/#core-endpoints-subscriptions) + // that was created from this subscription request. subscription?: string; }; @@ -1426,8 +1444,8 @@ export type BillingRequestFlow = { // Unique identifier, beginning with "BRF". id: string; - // Sets the default language of the Billing Request Flow and the customer. - // [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. + // Sets the default language of the Billing Request Flow and the customer. ISO + // 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. language?: string | null; // Resources linked to this BillingRequestFlow. @@ -1439,7 +1457,6 @@ export type BillingRequestFlow = { // // You can only lock bank account if these have already been completed as a // part of the billing request. - // lock_bank_account?: boolean; // If true, the payer will not be able to change their currency/scheme @@ -1454,7 +1471,6 @@ export type BillingRequestFlow = { // // You can only lock customer details if these have already been completed as // a part of the billing request. - // lock_customer_details?: boolean; // Bank account information used to prefill the payment page so your customer @@ -1498,23 +1514,26 @@ export type BillingRequestFlow = { /** Type for a billingrequestflowcreaterequestlinks resource. */ export type BillingRequestFlowCreateRequestLinks = { - // ID of the [billing request](#billing-requests-billing-requests) against - // which this flow was created. + // ID of the billing request + // (https://developer.gocardless.com/api-reference/#billing-requests-billing-requests) + // against which this flow was created. billing_request: string; }; /** Type for a billingrequestflowlinks resource. */ export type BillingRequestFlowLinks = { - // ID of the [billing request](#billing-requests-billing-requests) against - // which this flow was created. + // ID of the billing request + // (https://developer.gocardless.com/api-reference/#billing-requests-billing-requests) + // against which this flow was created. billing_request: string; }; /** Type for a billingrequestflowprefilledbankaccount resource. */ export type BillingRequestFlowPrefilledBankAccount = { // Bank account type for USD-denominated bank accounts. Must not be provided - // for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${BillingRequestFlowPrefilledBankAccountAccountType}`; }; @@ -1541,8 +1560,8 @@ export type BillingRequestFlowPrefilledCustomer = { // `given_name` and `family_name` are null. company_name?: string | null; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string | null; // For Danish customers only. The civic/company number (CPR or CVR) of the @@ -1575,8 +1594,9 @@ export type BillingRequestTemplate = { // based on this template, before being returned to the `redirect_uri`. authorisation_url?: string; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // Unique identifier, beginning with "BRT". @@ -1586,13 +1606,12 @@ export type BillingRequestTemplate = { // required for PayTo and VRP. mandate_request_constraints?: BillingRequestTemplateMandateRequestConstraints | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. mandate_request_currency?: string | null; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. - // mandate_request_description?: string | null; // Key-value store of custom data that will be applied to the mandate created @@ -1621,14 +1640,13 @@ export type BillingRequestTemplate = { // Amount in full. payment_request_amount?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. `GBP` and `EUR` supported; `GBP` with your customers in the UK and // for `EUR` with your customers in supported Eurozone countries only. payment_request_currency?: string | null; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. - // payment_request_description?: string | null; // Key-value store of custom data that will be applied to the payment created @@ -1647,15 +1665,17 @@ export type BillingRequestTemplate = { // URL that the payer can be redirected to after completing the request flow. redirect_uri?: string | null; - // Dynamic [timestamp](#api-usage-dates-and-times) recording when this - // resource was last updated. + // Dynamic timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times) + // recording when this resource was last updated. updated_at?: string; }; /** Type for a billingrequesttemplatecreaterequestlinks resource. */ export type BillingRequestTemplateCreateRequestLinks = { - // ID of the associated [creditor](#core-endpoints-creditors). Only required - // if your account manages multiple creditors. + // ID of the associated creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). + // Only required if your account manages multiple creditors. creditor?: string; }; @@ -1669,19 +1689,17 @@ export type BillingRequestTemplateMandateRequestConstraints = { // will not have an end date. Keep in mind the end date must take into account // how long it will // take the user to set up this agreement via the Billing Request. - // end_date?: string; // The maximum amount that can be charged for a single payment in the lowest - // denomination for the currency (e.g. pence in GBP, cents in EUR). _Note:_ + // denomination for the currency (e.g. pence in GBP, cents in EUR). Note: // Required for PayTo and VRP. max_amount_per_payment?: number; // A constraint where you can specify info (free text string) about how // payments are calculated. For use when payments vary and cannot be expressed - // as a fixed amount and frequency. _Note:_ This is only supported for ACH and + // as a fixed amount and frequency. Note: This is only supported for ACH and // PAD schemes. - // payment_method?: string; // Caps on the total amount and/or number of payments that can be collected @@ -1689,10 +1707,9 @@ export type BillingRequestTemplateMandateRequestConstraints = { // repeating period (e.g. no more than a set amount per month), as opposed to // `max_amount_per_payment` which caps a single payment. // - // _Note:_ Required for VRP, where exactly one periodic limit must be - // provided. Optional for + // Note: Required for VRP, where exactly one periodic limit must be provided. + // Optional for // PayTo. - // periodic_limits?: BillingRequestTemplateMandateRequestConstraintsPeriodicLimit[]; // The date from which payments can be taken. @@ -1700,7 +1717,6 @@ export type BillingRequestTemplateMandateRequestConstraints = { // This is an optional field and if it is not supplied the start date will be // set to the day // authorisation happens. - // start_date?: string; }; @@ -1728,15 +1744,13 @@ export type BillingRequestTemplateMandateRequestConstraintsPeriodicLimit = { // period, not // reduced proportionally. // - // _Note:_ Has no effect when period is `flexible`. - // + // Note: Has no effect when period is `flexible`. alignment?: `${BillingRequestTemplateMandateRequestConstraintsPeriodicLimitAlignment}`; // The maximum number of payments that can be collected in this periodic // limit. // - // _Note:_ Only supported for the PayTo scheme, where it is optional. - // + // Note: Only supported for the PayTo scheme, where it is optional. max_payments?: number; // The maximum total amount that can be charged for all payments in this @@ -1744,8 +1758,7 @@ export type BillingRequestTemplateMandateRequestConstraintsPeriodicLimit = { // in the lowest denomination for the currency (e.g. pence in GBP, cents in // EUR). // - // _Note:_ Required for VRP. This is not permitted for the PayTo scheme. - // + // Note: Required for VRP. This is not permitted for the PayTo scheme. max_total_amount?: number; // The repeating period for this mandate. Required whenever a periodic limit @@ -1753,7 +1766,6 @@ export type BillingRequestTemplateMandateRequestConstraintsPeriodicLimit = { // (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, // this // defaults to flexible. - // period?: `${BillingRequestTemplateMandateRequestConstraintsPeriodicLimitPeriod}`; }; @@ -1784,17 +1796,16 @@ export type BillingRequestWithAction = { // checkout flows. bank_authorisations?: BillingRequestWithActionBankAuthorisations; - // Billing Requests help create resources that require input or action from a + // Billing Requests help create resources that require input or action from a // customer. An example of required input might be additional customer billing // details, while an action would be asking a customer to authorise a payment // using their mobile banking app. // - // See [Billing Requests: - // Overview](https://developer.gocardless.com/getting-started/billing-requests/overview/) - // for how-to's, explanations and tutorials.

Important: All properties associated with - // `subscription_request` and `instalment_schedule_request` are only supported - // for ACH and PAD schemes.

+ // See Billing Requests: Overview + // (https://developer.gocardless.com/getting-started/billing-requests/overview/) + // for how-to's, explanations and tutorials. Important: All properties + // associated with `subscription_request` and `instalment_schedule_request` + // are only supported for ACH and PAD schemes. billing_requests: BillingRequestWithActionBillingRequests; }; @@ -1824,46 +1835,55 @@ export type BillingRequestWithActionActionsCollectBankAccount = { // Name of the account holder, as known by the bank. The full name provided // when the customer is created is stored and is available via the API, but is // transliterated, upcased, and truncated to 18 characters in bank - // submissions. This field is required unless the request includes a [customer - // bank account token](#javascript-flow-customer-bank-account-tokens). + // submissions. This field is required unless the request includes a customer + // bank account token + // (https://developer.gocardless.com/api-reference/#javascript-flow-customer-bank-account-tokens). account_holder_name?: string; - // Bank account number - see [local details](#appendix-local-bank-details) for - // more information. Alternatively you can provide an `iban`. + // Bank account number - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. account_number?: string | null; // Account number suffix (only for bank accounts denominated in NZD) - see - // [local details](#local-bank-details-new-zealand) for more information. + // local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-new-zealand) + // for more information. account_number_suffix?: string | null; // Bank account type. Required for USD-denominated bank accounts. Must not be - // provided for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // provided for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${BillingRequestWithActionActionsCollectBankAccountAccountType}`; - // Bank code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Bank code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. bank_code?: string | null; - // Branch code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Branch code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. branch_code?: string | null; - // [ISO 3166-1 alpha-2 - // code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). + // ISO 3166-1 alpha-2 code + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). // Defaults to the country code of the `iban` if supplied, otherwise is // required. country_code?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: string | null; - // International Bank Account Number. Alternatively you can provide [local - // details](#appendix-local-bank-details). IBANs are not accepted for Swedish - // bank accounts denominated in SEK - you must supply [local - // details](#local-bank-details-sweden). + // International Bank Account Number. Alternatively you can provide local + // details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details). + // IBANs are not accepted for Swedish bank accounts denominated in SEK - you + // must supply local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-sweden). iban?: string | null; // Key-value store of custom data. Up to 3 keys are permitted, with key names @@ -1908,21 +1928,21 @@ export type BillingRequestWithActionActionsCollectCustomerDetailsCustomer = { // Customer's first name. Required unless a `company_name` is provided. given_name?: string | null; - // [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. + // ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. // Used as the language for notification emails sent by GoCardless if your - // organisation does not send its own (see [compliance - // requirements](#appendix-compliance-requirements)). Currently only "en", - // "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are supported. - // If this is not provided and a customer was linked during billing request - // creation, the linked customer language will be used. Otherwise, the - // language is default to "en". + // organisation does not send its own (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). + // Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", + // "sv" are supported. If this is not provided and a customer was linked + // during billing request creation, the linked customer language will be used. + // Otherwise, the language is default to "en". language?: string | null; // Key-value store of custom data. Up to 3 keys are permitted, with key names // up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string }; - // [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, + // ITU E.123 (https://en.wikipedia.org/wiki/E.123) formatted phone number, // including country code. phone_number?: string | null; }; @@ -1941,8 +1961,8 @@ export type BillingRequestWithActionActionsCollectCustomerDetailsCustomerBilling // The city of the customer's address. city?: string | null; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string | null; // For Danish customers only. The civic/company number (CPR or CVR) of the @@ -1956,14 +1976,13 @@ export type BillingRequestWithActionActionsCollectCustomerDetailsCustomerBilling // // Not required for creating offline mandates where `authorisation_source` is // set to telephone or paper. - // ip_address?: string | null; // The customer's postal code. postal_code?: string | null; // The customer's address region, county or department. For US customers a 2 - // letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state + // letter ISO3166-2:US (https://en.wikipedia.org/wiki/ISO_3166-2:US) state // code is required (e.g. `CA` for California). region?: string | null; @@ -1991,8 +2010,8 @@ export type BillingRequestWithActionActionsConfirmPayerDetails = { /** Type for a billingrequestwithactionactionsselectinstitution resource. */ export type BillingRequestWithActionActionsSelectInstitution = { - // [ISO - // 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) // alpha-2 code. The country code of the institution. If nothing is provided, // institutions with the country code 'GB' are returned by default. country_code: string; @@ -2003,47 +2022,46 @@ export type BillingRequestWithActionActionsSelectInstitution = { /** Type for a billingrequestwithactioncreatewithactionsrequestlinks resource. */ export type BillingRequestWithActionCreateWithActionsRequestLinks = { - // ID of the associated [creditor](#core-endpoints-creditors). Only required - // if your account manages multiple creditors. + // ID of the associated creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). + // Only required if your account manages multiple creditors. creditor?: string; - // ID of the [customer](#core-endpoints-customers) against which this request - // should be made. + // ID of the customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers) + // against which this request should be made. customer?: string; - // (Optional) ID of the - // [customer_bank_account](#core-endpoints-customer-bank-accounts) against - // which this request should be made. - // + // (Optional) ID of the customer_bank_account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts) + // against which this request should be made. customer_bank_account?: string; }; /** Type for a billingrequestwithactionmandaterequest resource. */ export type BillingRequestWithActionMandateRequest = { - // This field is ACH specific, sometimes referred to as [SEC - // code](https://www.moderntreasury.com/learn/sec-codes). + // This field is ACH specific, sometimes referred to as SEC code + // (https://www.moderntreasury.com/learn/sec-codes). // // This is the way that the payer gives authorisation to the merchant. - // web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC + // web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC // code: WEB) - // telephone: Authorisation is provided orally over telephone (maps to SEC + // telephone: Authorisation is provided orally over telephone (maps to SEC // code: TEL) - // paper: Authorisation is provided in writing and signed, or similarly + // paper: Authorisation is provided in writing and signed, or similarly // authenticated (maps to SEC code: PPD) - // authorisation_source?: `${BillingRequestWithActionMandateRequestAuthorisationSource}`; // Constraints that will apply to the mandate_request. (Optional) Specifically // required for PayTo and VRP. constraints?: BillingRequestWithActionMandateRequestConstraints | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. currency?: string; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. - // description?: string | null; // This field will decide how GoCardless handles settlement of funds from the @@ -2053,18 +2071,17 @@ export type BillingRequestWithActionMandateRequest = { // out. // - `direct` will be a direct transfer from the payer's account to the // merchant where - // invoicing will be handled separately. - // + // invoicing will be handled separately. funds_settlement?: `${BillingRequestWithActionMandateRequestFundsSettlement}`; // Key-value store of custom data. Up to 3 keys are permitted, with key names // up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string }; - // Unique reference. Different schemes have different length and [character - // set](#appendix-character-sets) requirements. GoCardless will generate a - // unique reference satisfying the different scheme requirements if this field - // is left blank. + // Unique reference. Different schemes have different length and character set + // (https://developer.gocardless.com/api-reference/#appendix-character-sets) + // requirements. GoCardless will generate a unique reference satisfying the + // different scheme requirements if this field is left blank. reference?: string | null; // A bank payment scheme. Currently "ach", "autogiro", "bacs", "becs", @@ -2080,16 +2097,14 @@ export type BillingRequestWithActionMandateRequest = { sweeping?: boolean; // Verification preference for the mandate. One of: - // + // + // - `minimum`: only verify if absolutely required, such as when part of + // scheme rules + // - `recommended`: in addition to `minimum`, use the GoCardless payment + // intelligence solution to decide if a payer should be verified + // - `when_available`: if verification mechanisms are available, use them + // - `always`: as `when_available`, but fail to create the Billing Request if + // a mechanism isn't available // // By default, all Billing Requests use the `recommended` verification // preference. It uses GoCardless payment intelligence solution to determine @@ -2101,8 +2116,8 @@ export type BillingRequestWithActionMandateRequest = { // Verified Mandates as they are released in new schemes, please use the // `minimum` verification preference. // - // See [Billing Requests: Creating Verified - // Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/) + // See Billing Requests: Creating Verified Mandates + // (https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/) // for more information. verify?: `${BillingRequestWithActionMandateRequestVerify}`; }; @@ -2123,19 +2138,17 @@ export type BillingRequestWithActionMandateRequestConstraints = { // will not have an end date. Keep in mind the end date must take into account // how long it will // take the user to set up this agreement via the Billing Request. - // end_date?: string; // The maximum amount that can be charged for a single payment in the lowest - // denomination for the currency (e.g. pence in GBP, cents in EUR). _Note:_ + // denomination for the currency (e.g. pence in GBP, cents in EUR). Note: // Required for PayTo and VRP. max_amount_per_payment?: number; // A constraint where you can specify info (free text string) about how // payments are calculated. For use when payments vary and cannot be expressed - // as a fixed amount and frequency. _Note:_ This is only supported for ACH and + // as a fixed amount and frequency. Note: This is only supported for ACH and // PAD schemes. - // payment_method?: string; // Caps on the total amount and/or number of payments that can be collected @@ -2143,10 +2156,9 @@ export type BillingRequestWithActionMandateRequestConstraints = { // repeating period (e.g. no more than a set amount per month), as opposed to // `max_amount_per_payment` which caps a single payment. // - // _Note:_ Required for VRP, where exactly one periodic limit must be - // provided. Optional for + // Note: Required for VRP, where exactly one periodic limit must be provided. + // Optional for // PayTo. - // periodic_limits?: BillingRequestWithActionMandateRequestConstraintsPeriodicLimit[]; // The date from which payments can be taken. @@ -2154,7 +2166,6 @@ export type BillingRequestWithActionMandateRequestConstraints = { // This is an optional field and if it is not supplied the start date will be // set to the day // authorisation happens. - // start_date?: string; }; @@ -2182,15 +2193,13 @@ export type BillingRequestWithActionMandateRequestConstraintsPeriodicLimit = { // period, not // reduced proportionally. // - // _Note:_ Has no effect when period is `flexible`. - // + // Note: Has no effect when period is `flexible`. alignment?: `${BillingRequestWithActionMandateRequestConstraintsPeriodicLimitAlignment}`; // The maximum number of payments that can be collected in this periodic // limit. // - // _Note:_ Only supported for the PayTo scheme, where it is optional. - // + // Note: Only supported for the PayTo scheme, where it is optional. max_payments?: number; // The maximum total amount that can be charged for all payments in this @@ -2198,8 +2207,7 @@ export type BillingRequestWithActionMandateRequestConstraintsPeriodicLimit = { // in the lowest denomination for the currency (e.g. pence in GBP, cents in // EUR). // - // _Note:_ Required for VRP. This is not permitted for the PayTo scheme. - // + // Note: Required for VRP. This is not permitted for the PayTo scheme. max_total_amount?: number; // The repeating period for this mandate. Required whenever a periodic limit @@ -2207,7 +2215,6 @@ export type BillingRequestWithActionMandateRequestConstraintsPeriodicLimit = { // (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, // this // defaults to flexible. - // period?: `${BillingRequestWithActionMandateRequestConstraintsPeriodicLimitPeriod}`; }; @@ -2255,14 +2262,13 @@ export type BillingRequestWithActionPaymentRequest = { // denomination for the currency (e.g. pence in GBP, cents in EUR). app_fee?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. `GBP` and `EUR` supported; `GBP` with your customers in the UK and // for `EUR` with your customers in supported Eurozone countries only. currency?: string; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. - // description?: string | null; // This field will decide how GoCardless handles settlement of funds from the @@ -2272,8 +2278,7 @@ export type BillingRequestWithActionPaymentRequest = { // out. // - `direct` will be a direct transfer from the payer's account to the // merchant where - // invoicing will be handled separately. - // + // invoicing will be handled separately. funds_settlement?: `${BillingRequestWithActionPaymentRequestFundsSettlement}`; // Key-value store of custom data. Up to 3 keys are permitted, with key names @@ -2283,16 +2288,14 @@ export type BillingRequestWithActionPaymentRequest = { // A custom payment reference defined by the merchant. It is only available // for payments on the PayTo scheme or payments using the Direct Funds // settlement model on the Faster Payments scheme. - // reference?: string | null; - // On failure, automatically retry payments using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

Important: This is not applicable to Pay by - // Bank and VRP payments.

+ // On failure, automatically retry payments using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is + // `false`. Important: To be able to use intelligent retries, Success+ needs + // to be enabled in GoCardless dashboard + // (https://manage.gocardless.com/success-plus). + // Important: This is not applicable to Pay by Bank and VRP payments. retry_if_possible?: boolean; // (Optional) A scheme used for Open Banking payments. Currently @@ -2372,8 +2375,9 @@ export type BillingRequestWithActionBankAuthorisations = { // Type of authorisation, can be either 'mandate' or 'payment'. authorisation_type?: `${BillingRequestWithActionBankAuthorisationsAuthorisationType}`; - // Fixed [timestamp](#api-usage-dates-and-times), recording when the user has - // been authorised. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when the user has been authorised. authorised_at?: string | null; // Timestamp when the flow was created @@ -2386,8 +2390,9 @@ export type BillingRequestWithActionBankAuthorisations = { // Unique identifier, beginning with "BAU". id: string; - // Fixed [timestamp](#api-usage-dates-and-times), recording when the - // authorisation URL has been visited. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when the authorisation URL has been visited. last_visited_at?: string | null; // Resources linked to this BillingRequestWithActionBankAuthorisations. @@ -2411,10 +2416,13 @@ export type BillingRequestWithActionBankAuthorisations = { // Please note: bank authorisations can still fail despite an // `outcome=success` on the `redirect_uri`. It is therefore recommended to // wait for the relevant bank authorisation event, such as - // [`BANK_AUTHORISATION_AUTHORISED`](#billing-request-bankauthorisationauthorised), - // [`BANK_AUTHORISATION_DENIED`](#billing-request-bankauthorisationdenied), or - // [`BANK_AUTHORISATION_FAILED`](#billing-request-bankauthorisationfailed) in - // order to show the correct outcome to the user. + // `BANK_AUTHORISATION_AUTHORISED` + // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationauthorised), + // `BANK_AUTHORISATION_DENIED` + // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationdenied), + // or `BANK_AUTHORISATION_FAILED` + // (https://developer.gocardless.com/api-reference/#billing-request-bankauthorisationfailed) + // in order to show the correct outcome to the user. // // The BillingRequestFlow ID will also be appended to the `redirect_uri` as // query parameter `id=BRF123`. @@ -2428,8 +2436,9 @@ export type BillingRequestWithActionBankAuthorisations = { /** Type for a billingrequestwithactionbankauthorisationscreaterequestlinks resource. */ export type BillingRequestWithActionBankAuthorisationsCreateRequestLinks = { - // ID of the [billing request](#billing-requests-billing-requests) against - // which this authorisation was created. + // ID of the billing request + // (https://developer.gocardless.com/api-reference/#billing-requests-billing-requests) + // against which this authorisation was created. billing_request?: string; }; @@ -2440,12 +2449,14 @@ export enum BillingRequestWithActionBankAuthorisationsAuthorisationType { /** Type for a billingrequestwithactionbankauthorisationslinks resource. */ export type BillingRequestWithActionBankAuthorisationsLinks = { - // ID of the [billing request](#billing-requests-billing-requests) against - // which this authorisation was created. + // ID of the billing request + // (https://developer.gocardless.com/api-reference/#billing-requests-billing-requests) + // against which this authorisation was created. billing_request?: string; - // ID of the [institution](#billing-requests-institutions) against which this - // authorisation was created. + // ID of the institution + // (https://developer.gocardless.com/api-reference/#billing-requests-institutions) + // against which this authorisation was created. institution?: string; }; @@ -2455,16 +2466,17 @@ export type BillingRequestWithActionBillingRequests = { // fulfilled. actions?: BillingRequestWithActionBillingRequestsAction[]; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // (Optional) If true, this billing request can fallback from instant payment // to direct debit. // Should not be set if GoCardless payment intelligence feature is used. // - // See [Billing Requests: Retain customers with - // Fallbacks](https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/) + // See Billing Requests: Retain customers with Fallbacks + // (https://developer.gocardless.com/billing-requests/retain-customers-with-fallbacks/) // for more information. fallback_enabled?: boolean; @@ -2499,8 +2511,8 @@ export type BillingRequestWithActionBillingRequests = { // Specifies the underlying purpose of the payment. Defines the specific // reason or type of service/goods the payment relates to, improving // straight-through processing and compliance. - // See [VRP Commercial Payment Purpose - // Codes](https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) + // See VRP Commercial Payment Purpose Codes + // (https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/) // for the complete list of valid codes. payment_purpose_code?: string; @@ -2510,25 +2522,21 @@ export type BillingRequestWithActionBillingRequests = { // Specifies the high-level purpose/category of a mandate and/or payment using // a set of pre-defined categories. Provides context on the nature and reason // for the payment to facilitate processing and compliance. - // See [Billing Request Purpose - // Codes](https://developer.gocardless.com/billing-request-purpose-codes/) for - // the complete list of valid codes. + // See Billing Request Purpose Codes + // (https://developer.gocardless.com/billing-request-purpose-codes/) for the + // complete list of valid codes. purpose_code?: `${BillingRequestWithActionBillingRequestsPurposeCode}`; // resources?: BillingRequestWithActionBillingRequestsResources; // One of: - // + // + // - `pending`: the billing request is pending and can be used + // - `ready_to_fulfil`: the billing request is ready to fulfil + // - `fulfilling`: the billing request is currently undergoing fulfilment + // - `fulfilled`: the billing request has been fulfilled and a payment created + // - `cancelled`: the billing request has been cancelled and cannot be used status?: `${BillingRequestWithActionBillingRequestsStatus}`; // Request for a subscription @@ -2537,18 +2545,19 @@ export type BillingRequestWithActionBillingRequests = { /** Type for a billingrequestwithactionbillingrequestscreaterequestlinks resource. */ export type BillingRequestWithActionBillingRequestsCreateRequestLinks = { - // ID of the associated [creditor](#core-endpoints-creditors). Only required - // if your account manages multiple creditors. + // ID of the associated creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). + // Only required if your account manages multiple creditors. creditor?: string; - // ID of the [customer](#core-endpoints-customers) against which this request - // should be made. + // ID of the customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers) + // against which this request should be made. customer?: string; - // (Optional) ID of the - // [customer_bank_account](#core-endpoints-customer-bank-accounts) against - // which this request should be made. - // + // (Optional) ID of the customer_bank_account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts) + // against which this request should be made. customer_bank_account?: string; }; @@ -2638,21 +2647,21 @@ export type BillingRequestWithActionBillingRequestsCustomer = { // Customer's first name. Required unless a `company_name` is provided. given_name?: string | null; - // [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. + // ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. // Used as the language for notification emails sent by GoCardless if your - // organisation does not send its own (see [compliance - // requirements](#appendix-compliance-requirements)). Currently only "en", - // "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are supported. - // If this is not provided and a customer was linked during billing request - // creation, the linked customer language will be used. Otherwise, the - // language is default to "en". + // organisation does not send its own (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). + // Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", + // "sv" are supported. If this is not provided and a customer was linked + // during billing request creation, the linked customer language will be used. + // Otherwise, the language is default to "en". language?: string | null; // Key-value store of custom data. Up to 3 keys are permitted, with key names // up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string }; - // [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, + // ITU E.123 (https://en.wikipedia.org/wiki/E.123) formatted phone number, // including country code. phone_number?: string | null; }; @@ -2671,8 +2680,8 @@ export type BillingRequestWithActionBillingRequestsCustomerBillingDetail = { // The city of the customer's address. city?: string | null; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string | null; // For Danish customers only. The civic/company number (CPR or CVR) of the @@ -2686,14 +2695,13 @@ export type BillingRequestWithActionBillingRequestsCustomerBillingDetail = { // // Not required for creating offline mandates where `authorisation_source` is // set to telephone or paper. - // ip_address?: string | null; // The customer's postal code. postal_code?: string | null; // The customer's address region, county or department. For US customers a 2 - // letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state + // letter ISO3166-2:US (https://en.wikipedia.org/wiki/ISO_3166-2:US) state // code is required (e.g. `CA` for California). region?: string | null; @@ -2738,6 +2746,7 @@ export type BillingRequestWithActionBillingRequestsAction = { // Describes whether we inferred the institution from the provided bank // account details. One of: + // // - `not_needed`: we won't attempt to infer the institution as it is not // needed. Either because it was manually selected or the billing request does // not support this feature @@ -2746,7 +2755,6 @@ export type BillingRequestWithActionBillingRequestsAction = { // - `failed`: we weren't able to infer the institution // - `success`: we inferred the institution and added it to the resources of a // Billing Request - // institution_guess_status?: `${BillingRequestWithActionBillingRequestsActionInstitutionGuessStatus}`; // Informs you whether the action is required to fulfil the billing request or @@ -2832,20 +2840,20 @@ export type BillingRequestWithActionBillingRequestsInstalmentScheduleRequest = { // denomination for the currency (e.g. pence in GBP, cents in EUR). app_fee?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "USD" and "CAD" are supported. currency?: string; // An explicit array of instalment payments, each specifying at least an - // `amount` and `charge_date`. See [create (with - // dates)](#instalment-schedules-create-with-dates) + // `amount` and `charge_date`. See create (with dates) + // (https://developer.gocardless.com/api-reference/#instalment-schedules-create-with-dates) instalments_with_dates?: BillingRequestWithActionBillingRequestsInstalmentScheduleRequestInstalmentsWithDate[] | null; // Frequency of the payments you want to create, together with an array of // payment // amounts to be collected, with a specified start date for the first payment. - // See [create (with schedule)](#instalment-schedules-create-with-schedule) - // + // See create (with schedule) + // (https://developer.gocardless.com/api-reference/#instalment-schedules-create-with-schedule) instalments_with_schedule?: BillingRequestWithActionBillingRequestsInstalmentScheduleRequestInstalmentsWithSchedule | null; // Resources linked to this BillingRequestWithActionBillingRequestsInstalmentScheduleRequest. @@ -2864,15 +2872,16 @@ export type BillingRequestWithActionBillingRequestsInstalmentScheduleRequest = { // payment // created and will appear on your customer's bank statement. See the // documentation for - // the [create payment endpoint](#payments-create-a-payment) for more details. - //
+ // the create payment endpoint + // (https://developer.gocardless.com/api-reference/#payments-create-a-payment) + // for more details. payment_reference?: string | null; - // On failure, automatically retry payments using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

+ // On failure, automatically retry payments using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is + // `false`. Important: To be able to use intelligent retries, Success+ needs + // to be enabled in GoCardless dashboard + // (https://manage.gocardless.com/success-plus). retry_if_possible?: boolean; // The total amount of the instalment schedule, defined as the sum of all @@ -2897,14 +2906,16 @@ export type BillingRequestWithActionBillingRequestsInstalmentScheduleRequestInst // A future date on which the payment should be collected. If the date // is before the next_possible_charge_date on the - // [mandate](#core-endpoints-mandates), it will be automatically rolled + // mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates), + // it will be automatically rolled // forwards to that date. charge_date: string | null; // A human-readable description of the payment. This will be included in the // notification email GoCardless sends to your customer if your organisation - // does not send its own notifications (see [compliance - // requirements](#appendix-compliance-requirements)). + // does not send its own notifications (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). description?: string | null; }; @@ -2912,12 +2923,10 @@ export type BillingRequestWithActionBillingRequestsInstalmentScheduleRequestInst export type BillingRequestWithActionBillingRequestsInstalmentScheduleRequestInstalmentsWithSchedule = { // List of amounts of each instalment, in the lowest denomination for the // currency (e.g. cents in USD). - // amounts: string[]; // Number of `interval_units` between charge dates. Must be greater than or // equal to `1`. - // interval: number; // The unit of time between customer charge dates. One of `weekly`, `monthly` @@ -2925,10 +2934,12 @@ export type BillingRequestWithActionBillingRequestsInstalmentScheduleRequestInst interval_unit: `${BillingRequestWithActionBillingRequestsInstalmentScheduleRequestInstalmentsWithScheduleIntervalUnit}`; // The date on which the first payment should be charged. Must be on or after - // the [mandate](#core-endpoints-mandates)'s `next_possible_charge_date`. When - // left blank and `month` or `day_of_month` are provided, this will be set to - // the date of the first payment. If created without `month` or `day_of_month` - // this will be set as the mandate's `next_possible_charge_date` + // the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates)'s + // `next_possible_charge_date`. When left blank and `month` or `day_of_month` + // are provided, this will be set to the date of the first payment. If created + // without `month` or `day_of_month` this will be set as the mandate's + // `next_possible_charge_date` start_date?: string | null; }; @@ -2940,30 +2951,31 @@ export enum BillingRequestWithActionBillingRequestsInstalmentScheduleRequestInst /** Type for a billingrequestwithactionbillingrequestsinstalmentschedulerequestlinks resource. */ export type BillingRequestWithActionBillingRequestsInstalmentScheduleRequestLinks = { - // (Optional) ID of the - // [instalment_schedule](#core-endpoints-instalment-schedules) that was - // created from this instalment schedule request. - // + // (Optional) ID of the instalment_schedule + // (https://developer.gocardless.com/api-reference/#core-endpoints-instalment-schedules) + // that was created from this instalment schedule request. instalment_schedule?: string; }; /** Type for a billingrequestwithactionbillingrequestslinks resource. */ export type BillingRequestWithActionBillingRequestsLinks = { - // (Optional) ID of the [bank - // authorisation](#billing-requests-bank-authorisations) that was used to - // verify this request. + // (Optional) ID of the bank authorisation + // (https://developer.gocardless.com/api-reference/#billing-requests-bank-authorisations) + // that was used to verify this request. bank_authorisation?: string; - // ID of the associated [creditor](#core-endpoints-creditors). + // ID of the associated creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). creditor?: string; - // ID of the [customer](#core-endpoints-customers) that will be used for this - // request + // ID of the customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers) + // that will be used for this request customer?: string; - // (Optional) ID of the - // [customer_bank_account](#core-endpoints-customer-bank-accounts) that will - // be used for this request + // (Optional) ID of the customer_bank_account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts) + // that will be used for this request customer_bank_account?: string; // ID of the customer billing detail that will be used for this request @@ -2972,16 +2984,17 @@ export type BillingRequestWithActionBillingRequestsLinks = { // (Optional) ID of the associated instalment schedule request instalment_schedule_request?: string; - // (Optional) ID of the - // [instalment_schedule](#core-endpoints-instalment-schedules) that was - // created from this instalment schedule request. + // (Optional) ID of the instalment_schedule + // (https://developer.gocardless.com/api-reference/#core-endpoints-instalment-schedules) + // that was created from this instalment schedule request. instalment_schedule_request_instalment_schedule?: string; // (Optional) ID of the associated mandate request mandate_request?: string; - // (Optional) ID of the [mandate](#core-endpoints-mandates) that was created - // from this mandate request. this mandate request. + // (Optional) ID of the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // that was created from this mandate request. this mandate request. mandate_request_mandate?: string; // ID of the associated organisation. @@ -2993,52 +3006,51 @@ export type BillingRequestWithActionBillingRequestsLinks = { // (Optional) ID of the associated payment request payment_request?: string; - // (Optional) ID of the [payment](#core-endpoints-payments) that was created - // from this payment request. + // (Optional) ID of the payment + // (https://developer.gocardless.com/api-reference/#core-endpoints-payments) + // that was created from this payment request. payment_request_payment?: string; // (Optional) ID of the associated subscription request subscription_request?: string; - // (Optional) ID of the [subscription](#core-endpoints-subscriptions) that was - // created from this subscription request. + // (Optional) ID of the subscription + // (https://developer.gocardless.com/api-reference/#core-endpoints-subscriptions) + // that was created from this subscription request. subscription_request_subscription?: string; }; /** Type for a billingrequestwithactionbillingrequestsmandaterequest resource. */ export type BillingRequestWithActionBillingRequestsMandateRequest = { - // This field is ACH specific, sometimes referred to as [SEC - // code](https://www.moderntreasury.com/learn/sec-codes). + // This field is ACH specific, sometimes referred to as SEC code + // (https://www.moderntreasury.com/learn/sec-codes). // // This is the way that the payer gives authorisation to the merchant. - // web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC + // web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC // code: WEB) - // telephone: Authorisation is provided orally over telephone (maps to SEC + // telephone: Authorisation is provided orally over telephone (maps to SEC // code: TEL) - // paper: Authorisation is provided in writing and signed, or similarly + // paper: Authorisation is provided in writing and signed, or similarly // authenticated (maps to SEC code: PPD) - // authorisation_source?: `${BillingRequestWithActionBillingRequestsMandateRequestAuthorisationSource}`; // This attribute represents the authorisation type between the payer and // merchant. It can be set to `one_off`, // `recurring` or `standing` for ACH scheme. And `single`, `recurring` and - // `sporadic` for PAD scheme. _Note:_ This is only supported for ACH and PAD + // `sporadic` for PAD scheme. Note: This is only supported for ACH and PAD // schemes. - // consent_type?: string | null; // Constraints that will apply to the mandate_request. (Optional) Specifically // required for PayTo and VRP. constraints?: BillingRequestWithActionBillingRequestsMandateRequestConstraints | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. currency?: string; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. - // description?: string | null; // This field will decide how GoCardless handles settlement of funds from the @@ -3048,8 +3060,7 @@ export type BillingRequestWithActionBillingRequestsMandateRequest = { // out. // - `direct` will be a direct transfer from the payer's account to the // merchant where - // invoicing will be handled separately. - // + // invoicing will be handled separately. funds_settlement?: `${BillingRequestWithActionBillingRequestsMandateRequestFundsSettlement}`; // Resources linked to this BillingRequestWithActionBillingRequestsMandateRequest. @@ -3080,16 +3091,14 @@ export type BillingRequestWithActionBillingRequestsMandateRequest = { sweeping?: boolean; // Verification preference for the mandate. One of: - // + // + // - `minimum`: only verify if absolutely required, such as when part of + // scheme rules + // - `recommended`: in addition to `minimum`, use the GoCardless payment + // intelligence solution to decide if a payer should be verified + // - `when_available`: if verification mechanisms are available, use them + // - `always`: as `when_available`, but fail to create the Billing Request if + // a mechanism isn't available // // By default, all Billing Requests use the `recommended` verification // preference. It uses GoCardless payment intelligence solution to determine @@ -3101,8 +3110,8 @@ export type BillingRequestWithActionBillingRequestsMandateRequest = { // Verified Mandates as they are released in new schemes, please use the // `minimum` verification preference. // - // See [Billing Requests: Creating Verified - // Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/) + // See Billing Requests: Creating Verified Mandates + // (https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/) // for more information. verify?: `${BillingRequestWithActionBillingRequestsMandateRequestVerify}`; }; @@ -3123,19 +3132,17 @@ export type BillingRequestWithActionBillingRequestsMandateRequestConstraints = { // will not have an end date. Keep in mind the end date must take into account // how long it will // take the user to set up this agreement via the Billing Request. - // end_date?: string; // The maximum amount that can be charged for a single payment in the lowest - // denomination for the currency (e.g. pence in GBP, cents in EUR). _Note:_ + // denomination for the currency (e.g. pence in GBP, cents in EUR). Note: // Required for PayTo and VRP. max_amount_per_payment?: number; // A constraint where you can specify info (free text string) about how // payments are calculated. For use when payments vary and cannot be expressed - // as a fixed amount and frequency. _Note:_ This is only supported for ACH and + // as a fixed amount and frequency. Note: This is only supported for ACH and // PAD schemes. - // payment_method?: string; // Caps on the total amount and/or number of payments that can be collected @@ -3143,10 +3150,9 @@ export type BillingRequestWithActionBillingRequestsMandateRequestConstraints = { // repeating period (e.g. no more than a set amount per month), as opposed to // `max_amount_per_payment` which caps a single payment. // - // _Note:_ Required for VRP, where exactly one periodic limit must be - // provided. Optional for + // Note: Required for VRP, where exactly one periodic limit must be provided. + // Optional for // PayTo. - // periodic_limits?: BillingRequestWithActionBillingRequestsMandateRequestConstraintsPeriodicLimit[]; // The date from which payments can be taken. @@ -3154,7 +3160,6 @@ export type BillingRequestWithActionBillingRequestsMandateRequestConstraints = { // This is an optional field and if it is not supplied the start date will be // set to the day // authorisation happens. - // start_date?: string; }; @@ -3182,15 +3187,13 @@ export type BillingRequestWithActionBillingRequestsMandateRequestConstraintsPeri // period, not // reduced proportionally. // - // _Note:_ Has no effect when period is `flexible`. - // + // Note: Has no effect when period is `flexible`. alignment?: `${BillingRequestWithActionBillingRequestsMandateRequestConstraintsPeriodicLimitAlignment}`; // The maximum number of payments that can be collected in this periodic // limit. // - // _Note:_ Only supported for the PayTo scheme, where it is optional. - // + // Note: Only supported for the PayTo scheme, where it is optional. max_payments?: number; // The maximum total amount that can be charged for all payments in this @@ -3198,8 +3201,7 @@ export type BillingRequestWithActionBillingRequestsMandateRequestConstraintsPeri // in the lowest denomination for the currency (e.g. pence in GBP, cents in // EUR). // - // _Note:_ Required for VRP. This is not permitted for the PayTo scheme. - // + // Note: Required for VRP. This is not permitted for the PayTo scheme. max_total_amount?: number; // The repeating period for this mandate. Required whenever a periodic limit @@ -3207,7 +3209,6 @@ export type BillingRequestWithActionBillingRequestsMandateRequestConstraintsPeri // (for both VRP and PayTo). If periodic_limits is omitted entirely for PayTo, // this // defaults to flexible. - // period?: `${BillingRequestWithActionBillingRequestsMandateRequestConstraintsPeriodicLimitPeriod}`; }; @@ -3231,9 +3232,9 @@ export enum BillingRequestWithActionBillingRequestsMandateRequestFundsSettlement /** Type for a billingrequestwithactionbillingrequestsmandaterequestlinks resource. */ export type BillingRequestWithActionBillingRequestsMandateRequestLinks = { - // (Optional) ID of the [mandate](#core-endpoints-mandates) that was created - // from this mandate request. this mandate request. - // + // (Optional) ID of the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // that was created from this mandate request. this mandate request. mandate?: string; }; @@ -3254,14 +3255,13 @@ export type BillingRequestWithActionBillingRequestsPaymentRequest = { // denomination for the currency (e.g. pence in GBP, cents in EUR). app_fee?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. `GBP` and `EUR` supported; `GBP` with your customers in the UK and // for `EUR` with your customers in supported Eurozone countries only. currency?: string; // A human-readable description of the payment and/or mandate. This will be // displayed to the payer when authorising the billing request. - // description?: string | null; // This field will decide how GoCardless handles settlement of funds from the @@ -3271,8 +3271,7 @@ export type BillingRequestWithActionBillingRequestsPaymentRequest = { // out. // - `direct` will be a direct transfer from the payer's account to the // merchant where - // invoicing will be handled separately. - // + // invoicing will be handled separately. funds_settlement?: `${BillingRequestWithActionBillingRequestsPaymentRequestFundsSettlement}`; // Resources linked to this BillingRequestWithActionBillingRequestsPaymentRequest. @@ -3285,7 +3284,6 @@ export type BillingRequestWithActionBillingRequestsPaymentRequest = { // A custom payment reference defined by the merchant. It is only available // for payments on the PayTo scheme or payments using the Direct Funds // settlement model on the Faster Payments scheme. - // reference?: string | null; // (Optional) A scheme used for Open Banking payments. Currently @@ -3304,8 +3302,9 @@ export enum BillingRequestWithActionBillingRequestsPaymentRequestFundsSettlement /** Type for a billingrequestwithactionbillingrequestspaymentrequestlinks resource. */ export type BillingRequestWithActionBillingRequestsPaymentRequestLinks = { - // (Optional) ID of the [payment](#core-endpoints-payments) that was created - // from this payment request. + // (Optional) ID of the payment + // (https://developer.gocardless.com/api-reference/#core-endpoints-payments) + // that was created from this payment request. payment?: string; }; @@ -3330,8 +3329,9 @@ export type BillingRequestWithActionBillingRequestsResourcesCustomer = { // "Personal PAD"). company_name?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // Customer's email address. Required in most cases, as this allows GoCardless @@ -3347,20 +3347,20 @@ export type BillingRequestWithActionBillingRequestsResourcesCustomer = { // Unique identifier, beginning with "CU". id?: string; - // [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. + // ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. // Used as the language for notification emails sent by GoCardless if your - // organisation does not send its own (see [compliance - // requirements](#appendix-compliance-requirements)). Currently only "en", - // "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are supported. - // If this is not provided, the language will be chosen based on the - // `country_code` (if supplied) or default to "en". + // organisation does not send its own (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). + // Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", + // "sv" are supported. If this is not provided, the language will be chosen + // based on the `country_code` (if supplied) or default to "en". language?: string | null; // Key-value store of custom data. Up to 3 keys are permitted, with key names // up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string }; - // [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, + // ITU E.123 (https://en.wikipedia.org/wiki/E.123) formatted phone number, // including country code. phone_number?: string | null; }; @@ -3370,8 +3370,9 @@ export type BillingRequestWithActionBillingRequestsResourcesCustomerBankAccount // Name of the account holder, as known by the bank. The full name provided // when the customer is created is stored and is available via the API, but is // transliterated, upcased, and truncated to 18 characters in bank - // submissions. This field is required unless the request includes a [customer - // bank account token](#javascript-flow-customer-bank-account-tokens). + // submissions. This field is required unless the request includes a customer + // bank account token + // (https://developer.gocardless.com/api-reference/#javascript-flow-customer-bank-account-tokens). account_holder_name?: string; // The last few digits of the account number. Currently 4 digits for NZD bank @@ -3379,8 +3380,9 @@ export type BillingRequestWithActionBillingRequestsResourcesCustomerBankAccount account_number_ending?: string; // Bank account type. Required for USD-denominated bank accounts. Must not be - // provided for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // provided for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${BillingRequestWithActionBillingRequestsResourcesCustomerBankAccountAccountType}`; // A token to uniquely refer to a set of bank account details. This feature is @@ -3390,17 +3392,18 @@ export type BillingRequestWithActionBillingRequestsResourcesCustomerBankAccount // Name of bank, taken from the bank details. bank_name?: string; - // [ISO 3166-1 alpha-2 - // code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). + // ISO 3166-1 alpha-2 code + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). // Defaults to the country code of the `iban` if supplied, otherwise is // required. country_code?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: string | null; @@ -3417,6 +3420,19 @@ export type BillingRequestWithActionBillingRequestsResourcesCustomerBankAccount // Key-value store of custom data. Up to 3 keys are permitted, with key names // up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string }; + + // The result of the payer name verification check performed when the bank + // account was created. Only present if a check was performed. + // + // - `full`: The name provided matches the name held by the bank. + // - `close`: The name provided is a close but not exact match to the name + // held by the bank. + // - `cannot_perform_verification`: A verification was attempted but could not + // be completed. This can happen for a number of reasons, including the + // account holder's bank not participating in the verification scheme, the + // account not being eligible for verification (e.g. the account holder has + // opted out), or the bank details not being resolvable, among others. + payer_name_verification_result?: `${BillingRequestWithActionBillingRequestsResourcesCustomerBankAccountPayerNameVerificationResult}`; }; export enum BillingRequestWithActionBillingRequestsResourcesCustomerBankAccountAccountType { @@ -3426,11 +3442,18 @@ export enum BillingRequestWithActionBillingRequestsResourcesCustomerBankAccountA /** Type for a billingrequestwithactionbillingrequestsresourcescustomerbankaccountlinks resource. */ export type BillingRequestWithActionBillingRequestsResourcesCustomerBankAccountLinks = { - // ID of the [customer](#core-endpoints-customers) that owns this bank - // account. + // ID of the customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers) + // that owns this bank account. customer?: string; }; +export enum BillingRequestWithActionBillingRequestsResourcesCustomerBankAccountPayerNameVerificationResult { + Full = 'full', + Close = 'close', + CannotPerformVerification = 'cannot_perform_verification', +} + /** Type for a billingrequestwithactionbillingrequestsresourcescustomerbillingdetail resource. */ export type BillingRequestWithActionBillingRequestsResourcesCustomerBillingDetail = { // The first line of the customer's address. @@ -3445,12 +3468,13 @@ export type BillingRequestWithActionBillingRequestsResourcesCustomerBillingDetai // The city of the customer's address. city?: string | null; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // For Danish customers only. The civic/company number (CPR or CVR) of the @@ -3467,14 +3491,13 @@ export type BillingRequestWithActionBillingRequestsResourcesCustomerBillingDetai // // Not required for creating offline mandates where `authorisation_source` is // set to telephone or paper. - // ip_address?: string | null; // The customer's postal code. postal_code?: string | null; // The customer's address region, county or department. For US customers a 2 - // letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state + // letter ISO3166-2:US (https://en.wikipedia.org/wiki/ISO_3166-2:US) state // code is required (e.g. `CA` for California). region?: string | null; @@ -3502,7 +3525,7 @@ export type BillingRequestWithActionBillingRequestsSubscriptionRequest = { // The total number of payments that should be taken by this subscription. count?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "USD" and "CAD" are supported. currency?: string; @@ -3529,7 +3552,6 @@ export type BillingRequestWithActionBillingRequestsSubscriptionRequest = { // Name of the month on which to charge a customer. Must be lowercase. Only // applies // when the interval_unit is `yearly`. - // month?: `${BillingRequestWithActionBillingRequestsSubscriptionRequestMonth}`; // Optional name for the subscription. This will be set as the description on @@ -3540,15 +3562,16 @@ export type BillingRequestWithActionBillingRequestsSubscriptionRequest = { // payment // created and will appear on your customer's bank statement. See the // documentation for - // the [create payment endpoint](#payments-create-a-payment) for more details. - //
+ // the create payment endpoint + // (https://developer.gocardless.com/api-reference/#payments-create-a-payment) + // for more details. payment_reference?: string | null; - // On failure, automatically retry payments using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

+ // On failure, automatically retry payments using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is + // `false`. Important: To be able to use intelligent retries, Success+ needs + // to be enabled in GoCardless dashboard + // (https://manage.gocardless.com/success-plus). retry_if_possible?: boolean; // The date on which the first payment should be charged. If fulfilled after @@ -3557,7 +3580,6 @@ export type BillingRequestWithActionBillingRequestsSubscriptionRequest = { // set to the date of the first payment. // If created without `month` or `day_of_month` this will be set as the // mandate's `next_possible_charge_date`. - // start_date?: string | null; }; @@ -3569,9 +3591,9 @@ export enum BillingRequestWithActionBillingRequestsSubscriptionRequestIntervalUn /** Type for a billingrequestwithactionbillingrequestssubscriptionrequestlinks resource. */ export type BillingRequestWithActionBillingRequestsSubscriptionRequestLinks = { - // (Optional) ID of the [subscription](#core-endpoints-subscriptions) that was - // created from this subscription request. - // + // (Optional) ID of the subscription + // (https://developer.gocardless.com/api-reference/#core-endpoints-subscriptions) + // that was created from this subscription request. subscription?: string; }; @@ -3603,7 +3625,9 @@ export type Block = { // 'bank_name'. block_type?: `${BlockBlockType}`; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this // resource was created. created_at?: string; @@ -3638,7 +3662,9 @@ export type Block = { // a resource. resource_reference?: string; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this // resource was updated. updated_at?: string; }; @@ -3680,7 +3706,6 @@ export type Creditor = { // sent to that creditor could be `ACME-8G7Q8`. // // This prefix is also used for refunds in EUR and GBP. - // bank_reference_prefix?: string; // Boolean indicating whether the creditor is permitted to create refunds. @@ -3689,25 +3714,26 @@ export type Creditor = { // The city of the creditor's address. city?: string | null; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // The type of business of the creditor. Currently, `individual`, `company`, // `charity`, `partnership`, and `trust` are supported. creditor_type?: `${CreditorCreditorType}`; - // Boolean value indicating whether creditor has the [Custom Payment - // Pages](https://hub.gocardless.com/s/article/Custom-payment-pages) - // functionality enabled. + // Boolean value indicating whether creditor has the Custom Payment Pages + // (https://hub.gocardless.com/s/article/Custom-payment-pages) functionality + // enabled. custom_payment_pages_enabled?: boolean; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for - // the currency in which amounts will be paid out (after foreign exchange). + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the + // currency in which amounts will be paid out (after foreign exchange). // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. Present only if payouts will be (or were) made via foreign // exchange. @@ -3722,16 +3748,17 @@ export type Creditor = { // URL for the creditor's logo, which may be shown on their payment pages. logo_url?: string | null; - // Boolean value indicating whether creditor has the [Mandate - // Imports](#core-endpoints-mandate-imports) functionality enabled. + // Boolean value indicating whether creditor has the Mandate Imports + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandate-imports) + // functionality enabled. mandate_imports_enabled?: boolean; // Boolean value indicating whether the organisation is responsible for // sending all customer notifications (note this is separate from the - // functionality described - // [here](/getting-started/api/handling-customer-notifications/)). If you are - // a partner app, and this value is true, you should not send notifications on - // behalf of this organisation. + // functionality described here + // (https://developer.gocardless.com/getting-started/api/handling-customer-notifications/)). + // If you are a partner app, and this value is true, you should not send + // notifications on behalf of this organisation. merchant_responsible_for_notifications?: boolean; // The creditor's trading name. @@ -3748,27 +3775,28 @@ export type Creditor = { // // The support address, `phone_number` and `email` fields are for customers to // contact the merchant for support purposes. They must be displayed on the - // payment page, please see our [compliance - // requirements](#appendix-compliance-requirements) for more details. + // payment page, please see our compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements) + // for more details. scheme_identifiers?: CreditorSchemeIdentifier[]; // The creditor's verification status, indicating whether they can yet receive // payouts. For more details on handling verification as a partner, see our - // ["Helping your users get verified" - // guide](/getting-started/partners/helping-your-users-get-verified/). One of: - // + // verification flow. verification_status?: `${CreditorVerificationStatus}`; }; @@ -3782,36 +3810,44 @@ export enum CreditorCreditorType { /** Type for a creditorupdaterequestlinks resource. */ export type CreditorUpdateRequestLinks = { - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in AUD. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in AUD. default_aud_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in CAD. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in CAD. default_cad_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in DKK. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in DKK. default_dkk_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in EUR. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in EUR. default_eur_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in GBP. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in GBP. default_gbp_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in NZD. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in NZD. default_nzd_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in SEK. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in SEK. default_sek_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in USD. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in USD. default_usd_payout_account?: string | null; }; @@ -3828,36 +3864,44 @@ export enum CreditorFxPayoutCurrency { /** Type for a creditorlinks resource. */ export type CreditorLinks = { - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in AUD. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in AUD. default_aud_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in CAD. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in CAD. default_cad_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in DKK. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in DKK. default_dkk_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in EUR. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in EUR. default_eur_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in GBP. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in GBP. default_gbp_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in NZD. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in NZD. default_nzd_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in SEK. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in SEK. default_sek_payout_account?: string | null; - // ID of the [bank account](#core-endpoints-creditor-bank-accounts) which is - // set up to receive payouts in USD. + // ID of the bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which is set up to receive payouts in USD. default_usd_payout_account?: string | null; }; @@ -3879,12 +3923,13 @@ export type CreditorSchemeIdentifier = { // The city of the scheme identifier's support address. city?: string; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // The currency of the scheme identifier. @@ -3901,8 +3946,9 @@ export type CreditorSchemeIdentifier = { // this scheme identifier. // // By default, GoCardless sends these notifications automatically. Please see - // our [compliance requirements](#appendix-compliance-requirements) for more - // details. + // our compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements) + // for more details. minimum_advance_notice?: number; // The name which appears on customers' bank statements. This should usually @@ -3969,7 +4015,8 @@ export enum CreditorVerificationStatus { /** Type for a creditorbankaccount resource. */ export type CreditorBankAccount = { // Name of the account holder, as known by the bank. Usually this is the same - // as the name stored with the linked [creditor](#core-endpoints-creditors). + // as the name stored with the linked creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). // This field will be transliterated, upcased and truncated to 18 characters. account_holder_name?: string; @@ -3978,24 +4025,26 @@ export type CreditorBankAccount = { account_number_ending?: string; // Bank account type. Required for USD-denominated bank accounts. Must not be - // provided for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // provided for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${CreditorBankAccountAccountType}`; // Name of bank, taken from the bank details. bank_name?: string; - // [ISO 3166-1 alpha-2 - // code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). + // ISO 3166-1 alpha-2 code + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). // Defaults to the country code of the `iban` if supplied, otherwise is // required. country_code?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: string | null; @@ -4025,15 +4074,17 @@ export enum CreditorBankAccountAccountType { /** Type for a creditorbankaccountcreaterequestlinks resource. */ export type CreditorBankAccountCreateRequestLinks = { - // ID of the [creditor](#core-endpoints-creditors) that owns this bank - // account. + // ID of the creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors) + // that owns this bank account. creditor: string; }; /** Type for a creditorbankaccountlinks resource. */ export type CreditorBankAccountLinks = { - // ID of the [creditor](#core-endpoints-creditors) that owns this bank - // account. + // ID of the creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors) + // that owns this bank account. creditor?: string; }; @@ -4081,12 +4132,13 @@ export type Customer = { // "Personal PAD"). company_name?: string | null; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // For Danish customers only. The civic/company number (CPR or CVR) of the @@ -4107,20 +4159,20 @@ export type Customer = { // Unique identifier, beginning with "CU". id?: string; - // [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. + // ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. // Used as the language for notification emails sent by GoCardless if your - // organisation does not send its own (see [compliance - // requirements](#appendix-compliance-requirements)). Currently only "en", - // "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are supported. - // If this is not provided, the language will be chosen based on the - // `country_code` (if supplied) or default to "en". + // organisation does not send its own (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). + // Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", + // "sv" are supported. If this is not provided, the language will be chosen + // based on the `country_code` (if supplied) or default to "en". language?: string | null; // Key-value store of custom data. Up to 3 keys are permitted, with key names // up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string }; - // [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, + // ITU E.123 (https://en.wikipedia.org/wiki/E.123) formatted phone number, // including country code. phone_number?: string | null; @@ -4128,7 +4180,7 @@ export type Customer = { postal_code?: string | null; // The customer's address region, county or department. For US customers a 2 - // letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state + // letter ISO3166-2:US (https://en.wikipedia.org/wiki/ISO_3166-2:US) state // code is required (e.g. `CA` for California). region?: string | null; @@ -4171,8 +4223,9 @@ export type CustomerBankAccount = { // Name of the account holder, as known by the bank. The full name provided // when the customer is created is stored and is available via the API, but is // transliterated, upcased, and truncated to 18 characters in bank - // submissions. This field is required unless the request includes a [customer - // bank account token](#javascript-flow-customer-bank-account-tokens). + // submissions. This field is required unless the request includes a customer + // bank account token + // (https://developer.gocardless.com/api-reference/#javascript-flow-customer-bank-account-tokens). account_holder_name?: string; // The last few digits of the account number. Currently 4 digits for NZD bank @@ -4180,8 +4233,9 @@ export type CustomerBankAccount = { account_number_ending?: string; // Bank account type. Required for USD-denominated bank accounts. Must not be - // provided for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // provided for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${CustomerBankAccountAccountType}`; // A token to uniquely refer to a set of bank account details. This feature is @@ -4191,17 +4245,18 @@ export type CustomerBankAccount = { // Name of bank, taken from the bank details. bank_name?: string; - // [ISO 3166-1 alpha-2 - // code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). + // ISO 3166-1 alpha-2 code + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). // Defaults to the country code of the `iban` if supplied, otherwise is // required. country_code?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: string | null; @@ -4219,6 +4274,19 @@ export type CustomerBankAccount = { // up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string }; + // The result of the payer name verification check performed when the bank + // account was created. Only present if a check was performed. + // + // - `full`: The name provided matches the name held by the bank. + // - `close`: The name provided is a close but not exact match to the name + // held by the bank. + // - `cannot_perform_verification`: A verification was attempted but could not + // be completed. This can happen for a number of reasons, including the + // account holder's bank not participating in the verification scheme, the + // account not being eligible for verification (e.g. the account holder has + // opted out), or the bank details not being resolvable, among others. + payer_name_verification_result?: `${CustomerBankAccountPayerNameVerificationResult}`; + // Whether this customer bank account is registered as a trusted recipient for // Outbound Payments. Only present when the feature is enabled for the // organisation. @@ -4232,32 +4300,41 @@ export enum CustomerBankAccountAccountType { /** Type for a customerbankaccountcreaterequestlinks resource. */ export type CustomerBankAccountCreateRequestLinks = { - // ID of the [customer](#core-endpoints-customers) that owns this bank - // account. + // ID of the customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers) + // that owns this bank account. customer: string; - // ID of a [customer bank account - // token](#javascript-flow-customer-bank-account-tokens) to use in place of - // bank account parameters. + // ID of a customer bank account token + // (https://developer.gocardless.com/api-reference/#javascript-flow-customer-bank-account-tokens) + // to use in place of bank account parameters. customer_bank_account_token?: string; }; /** Type for a customerbankaccountlinks resource. */ export type CustomerBankAccountLinks = { - // ID of the [customer](#core-endpoints-customers) that owns this bank - // account. + // ID of the customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers) + // that owns this bank account. customer?: string; }; +export enum CustomerBankAccountPayerNameVerificationResult { + Full = 'full', + Close = 'close', + CannotPerformVerification = 'cannot_perform_verification', +} + /** Type for a customernotification resource. */ export type CustomerNotification = { // The action that was taken on the notification. Currently this can only be // `handled`, // which means the integrator sent the notification themselves. - // action_taken?: `${CustomerNotificationActionTaken}`; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this // action was taken. action_taken_at?: string | null; @@ -4273,16 +4350,15 @@ export type CustomerNotification = { // The type of notification the customer shall receive. // One of: - // + // + // - `payment_created` + // - `payment_cancelled` + // - `mandate_created` + // - `mandate_blocked` + // - `subscription_created` + // - `subscription_cancelled` + // - `instalment_schedule_created` + // - `instalment_schedule_cancelled` type?: `${CustomerNotificationType}`; }; @@ -4324,19 +4400,20 @@ export enum CustomerNotificationType { /** Type for a event resource. */ export type Event = { - // What has happened to the resource. See [Event Types](#event-types) for the + // What has happened to the resource. See Event Types + // (https://developer.gocardless.com/api-reference/#event-types) for the // possible actions. action?: string; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // Present only in webhooks when an integrator is authorised to send their own - // notifications. See - // [here](/getting-started/api/handling-customer-notifications/) + // notifications. See here + // (https://developer.gocardless.com/getting-started/api/handling-customer-notifications/) // for further information. - // customer_notifications?: EventCustomerNotification[] | null; // @@ -4354,32 +4431,29 @@ export type Event = { // // This field will only be populated if the `details[origin]` field is `api` // otherwise it will be an empty object. - // metadata?: JsonMap; // The metadata of the resource that the event is for. For example, this field // will have the same // value of the `mandate[metadata]` field on the response you would receive // from performing a GET request on a mandate. - // resource_metadata?: JsonMap; // The resource type for this event. One of: - // + // + // - `billing_requests` + // - `creditors` + // - `exports` + // - `instalment_schedules` + // - `mandates` + // - `payer_authorisations` + // - `payments` + // - `payouts` + // - `refunds` + // - `scheme_identifiers` + // - `subscriptions` + // - `outbound_payments` + // - `payment_account_transactions` resource_type?: `${EventResourceType}`; // Audit information about the source of the event. @@ -4413,8 +4487,9 @@ export type EventCustomerNotification = { // Whether or not the notification must be sent. mandatory?: boolean; - // See [here](#core-endpoints-customer-notifications) for a complete list of - // customer notification types. + // See here + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-notifications) + // for a complete list of customer notification types. type?: string; }; @@ -4424,7 +4499,7 @@ export type EventDetails = { // the bank account id of the new account bank_account_id?: string; - // What triggered the event. _Note:_ `cause` is our simplified and predictable + // What triggered the event. Note: `cause` is our simplified and predictable // key indicating what triggered the event. cause?: string; @@ -4432,7 +4507,7 @@ export type EventDetails = { // the currency of the new account currency?: string; - // Human readable description of the cause. _Note:_ Changes to event + // Human readable description of the cause. Note: Changes to event // descriptions are not considered breaking. description?: string; @@ -4441,22 +4516,20 @@ export type EventDetails = { // When will_attempt_retry is set to false, this field will contain // the reason the payment was not retried. This can be one of: - // + // + // - `failure_filter_applied`: The payment won't be intelligently retried as + // there is a high likelihood of failure on retry. + // - `other`: The payment won't be intelligently retried due to any other + // reason. not_retried_reason?: string; // Who initiated the event. One of: - // + // + // - `bank`: this event was triggered by a report from the banks + // - `gocardless`: this event was performed by GoCardless automatically + // - `api`: this event was triggered by an API endpoint + // - `customer`: this event was triggered by a Customer + // - `payer`: this event was triggered by a Payer origin?: `${EventDetailsOrigin}`; // When we send a creditor `creditor_updated` webhook, this tells you which @@ -4464,11 +4537,10 @@ export type EventDetails = { property?: string; // Set when a `bank` is the origin of the event. This is the reason code - // received in the report from the customer's bank. See the [GoCardless Direct - // Debit guide](https://gocardless.com/direct-debit/receiving-messages) for - // information on the meanings of different reason codes. _Note:_ - // `reason_code` is payment scheme-specific and can be inconsistent between - // banks. + // received in the report from the customer's bank. See the GoCardless Direct + // Debit guide (https://gocardless.com/direct-debit/receiving-messages) for + // information on the meanings of different reason codes. Note: `reason_code` + // is payment scheme-specific and can be inconsistent between banks. reason_code?: string; // A bank payment scheme. Set when a bank is the origin of the event. @@ -4503,52 +4575,66 @@ export enum EventDetailsScheme { /** Type for a eventlinks resource. */ export type EventLinks = { - // ID of a [bank authorisation](#billing-requests-bank-authorisations). + // ID of a bank authorisation + // (https://developer.gocardless.com/api-reference/#billing-requests-bank-authorisations). bank_authorisation?: string; - // ID of a [billing request](#billing-requests-billing-requests). + // ID of a billing request + // (https://developer.gocardless.com/api-reference/#billing-requests-billing-requests). billing_request?: string; - // ID of a [billing request flow](#billing-requests-billing-request-flows). + // ID of a billing request flow + // (https://developer.gocardless.com/api-reference/#billing-requests-billing-request-flows). billing_request_flow?: string; - // If `resource_type` is `creditor`, this is the ID of the - // [creditor](#core-endpoints-creditors) which has been updated. + // If `resource_type` is `creditor`, this is the ID of the creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors) + // which has been updated. creditor?: string; - // ID of a [customer](#core-endpoints-customers). + // ID of a customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers). customer?: string; - // ID of a [customer bank account](#core-endpoints-customer-bank-accounts). + // ID of a customer bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts). customer_bank_account?: string; // If `resource_type` is `instalment_schedule`, this is the ID of the - // [instalment schedule](#core-endpoints-instalment-schedules) which has been - // updated. + // instalment schedule + // (https://developer.gocardless.com/api-reference/#core-endpoints-instalment-schedules) + // which has been updated. instalment_schedule?: string; - // If `resource_type` is `mandates`, this is the ID of the - // [mandate](#core-endpoints-mandates) which has been updated. + // If `resource_type` is `mandates`, this is the ID of the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // which has been updated. mandate?: string; // This is the id of the mandate request associated to this event mandate_request?: string; - // If `resource_type` is `billing_requests`, this is the ID of the - // [mandate](#core-endpoints-mandates) which has been created. + // If `resource_type` is `billing_requests`, this is the ID of the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // which has been created. mandate_request_mandate?: string; // This is only included for mandate transfer events, when it is the ID of the - // [customer bank account](#core-endpoints-customer-bank-accounts) which the - // mandate is being transferred to. + // customer bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts) + // which the mandate is being transferred to. new_customer_bank_account?: string; // This is only included for mandate replaced events, when it is the ID of the - // new [mandate](#core-endpoints-mandates) that replaces the existing mandate. + // new mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // that replaces the existing mandate. new_mandate?: string; - // If the event is included in a [webhook](#webhooks-overview) to an [OAuth - // app](#appendix-oauth), this is the ID of the account to which it belongs. + // If the event is included in a webhook + // (https://developer.gocardless.com/api-reference/#webhooks-overview) to an + // OAuth app (https://developer.gocardless.com/api-reference/#appendix-oauth), + // this is the ID of the account to which it belongs. organisation?: string; // If `resource_type` is `outbound_payments`, this is the ID of the @@ -4561,41 +4647,49 @@ export type EventLinks = { // would have the ID of the mandate cancellation event in this field. parent_event?: string; - // ID of a [payer authorisation](#core-endpoints-payer-authorisations). + // ID of a payer authorisation + // (https://developer.gocardless.com/api-reference/#core-endpoints-payer-authorisations). payer_authorisation?: string; - // If `resource_type` is `payments`, this is the ID of the - // [payment](#core-endpoints-payments) which has been updated. + // If `resource_type` is `payments`, this is the ID of the payment + // (https://developer.gocardless.com/api-reference/#core-endpoints-payments) + // which has been updated. payment?: string; // If `resource_type` is `payment_account_transaction`, this is the ID of a // transaction which has been recorded on the payment account. payment_account_transaction?: string; - // If `resource_type` is `billing_requests`, this is the ID of the - // [payment](#core-endpoints-payments) which has been created for Pay by Bank. + // If `resource_type` is `billing_requests`, this is the ID of the payment + // (https://developer.gocardless.com/api-reference/#core-endpoints-payments) + // which has been created for Pay by Bank. payment_request_payment?: string; - // If `resource_type` is `payouts`, this is the ID of the - // [payout](#core-endpoints-payouts) which has been updated. + // If `resource_type` is `payouts`, this is the ID of the payout + // (https://developer.gocardless.com/api-reference/#core-endpoints-payouts) + // which has been updated. payout?: string; // This is only included for mandate transfer events, when it is the ID of the - // [customer bank account](#core-endpoints-customer-bank-accounts) which the - // mandate is being transferred from. + // customer bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts) + // which the mandate is being transferred from. previous_customer_bank_account?: string; - // If `resource_type` is `refunds`, this is the ID of the - // [refund](#core-endpoints-refunds) which has been updated. + // If `resource_type` is `refunds`, this is the ID of the refund + // (https://developer.gocardless.com/api-reference/#core-endpoints-refunds) + // which has been updated. refund?: string; // If `resource_type` is `scheme_identifiers`, this is the ID of the - // [scheme_identifier](#core-endpoints-scheme-identifiers) which has been - // updated. + // scheme_identifier + // (https://developer.gocardless.com/api-reference/#core-endpoints-scheme-identifiers) + // which has been updated. scheme_identifier?: string; - // If `resource_type` is `subscription`, this is the ID of the - // [subscription](#core-endpoints-subscriptions) which has been updated. + // If `resource_type` is `subscription`, this is the ID of the subscription + // (https://developer.gocardless.com/api-reference/#core-endpoints-subscriptions) + // which has been updated. subscription?: string; }; @@ -4635,8 +4729,9 @@ export enum EventSourceType { /** Type for a export resource. */ export type Export = { - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // The currency of the export (if applicable) @@ -4690,11 +4785,12 @@ export type FundsAvailability = { /** Type for a instalmentschedule resource. */ export type InstalmentSchedule = { - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: `${InstalmentScheduleCurrency}`; @@ -4719,20 +4815,17 @@ export type InstalmentSchedule = { // failures from the individual payments, arranged by the index of the payment // that // failed. - // payment_errors?: JsonMap; // One of: - // + // + // - `pending`: we're waiting for GC to create the payments + // - `active`: the payments have been created, and the schedule is active + // - `creation_failed`: payment creation failed + // - `completed`: we have passed the date of the final payment and all + // payments have been collected + // - `cancelled`: the schedule has been cancelled + // - `errored`: one or more payments have failed status?: `${InstalmentScheduleStatus}`; // The total amount of the instalment schedule, defined as the sum of all @@ -4768,21 +4861,24 @@ export type InstalmentScheduleInstalment = { // A future date on which the payment should be collected. If the date // is before the next_possible_charge_date on the - // [mandate](#core-endpoints-mandates), it will be automatically rolled + // mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates), + // it will be automatically rolled // forwards to that date. charge_date: string | null; // A human-readable description of the payment. This will be included in the // notification email GoCardless sends to your customer if your organisation - // does not send its own notifications (see [compliance - // requirements](#appendix-compliance-requirements)). + // does not send its own notifications (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). description?: string | null; }; /** Type for a instalmentschedulecreatewithdatesrequestlinks resource. */ export type InstalmentScheduleCreateWithDatesRequestLinks = { - // ID of the associated [mandate](#core-endpoints-mandates) which the - // instalment schedule will create payments against. + // ID of the associated mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // which the instalment schedule will create payments against. mandate: string; }; @@ -4790,12 +4886,10 @@ export type InstalmentScheduleCreateWithDatesRequestLinks = { export type InstalmentScheduleInstalments = { // List of amounts of each instalment, in the lowest denomination for the // currency (e.g. pence in GBP, cents in EUR). - // amounts: string[]; // Number of `interval_units` between charge dates. Must be greater than or // equal to `1`. - // interval: number; // The unit of time between customer charge dates. One of `weekly`, `monthly` @@ -4803,10 +4897,12 @@ export type InstalmentScheduleInstalments = { interval_unit: `${InstalmentScheduleInstalmentsIntervalUnit}`; // The date on which the first payment should be charged. Must be on or after - // the [mandate](#core-endpoints-mandates)'s `next_possible_charge_date`. When - // left blank and `month` or `day_of_month` are provided, this will be set to - // the date of the first payment. If created without `month` or `day_of_month` - // this will be set as the mandate's `next_possible_charge_date` + // the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates)'s + // `next_possible_charge_date`. When left blank and `month` or `day_of_month` + // are provided, this will be set to the date of the first payment. If created + // without `month` or `day_of_month` this will be set as the mandate's + // `next_possible_charge_date` start_date?: string | null; }; @@ -4818,21 +4914,25 @@ export enum InstalmentScheduleInstalmentsIntervalUnit { /** Type for a instalmentschedulecreatewithschedulerequestlinks resource. */ export type InstalmentScheduleCreateWithScheduleRequestLinks = { - // ID of the associated [mandate](#core-endpoints-mandates) which the - // instalment schedule will create payments against. + // ID of the associated mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // which the instalment schedule will create payments against. mandate: string; }; /** Type for a instalmentschedulelinks resource. */ export type InstalmentScheduleLinks = { - // ID of the associated [customer](#core-endpoints-customers). + // ID of the associated customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers). customer: string; - // ID of the associated [mandate](#core-endpoints-mandates) which the - // instalment schedule will create payments against. + // ID of the associated mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // which the instalment schedule will create payments against. mandate: string; - // Array of IDs of the associated [payments](#core-endpoints-payments) + // Array of IDs of the associated payments + // (https://developer.gocardless.com/api-reference/#core-endpoints-payments) payments?: string[]; }; @@ -4852,8 +4952,8 @@ export type Institution = { // payer's bank account details to GoCardless. autocompletes_collect_bank_account?: boolean; - // [ISO - // 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) // alpha-2 code. The country code of the institution. If nothing is provided, // institutions with the country code 'GB' are returned by default. country_code?: string; @@ -4923,17 +5023,16 @@ export type LogoCreateForCreditorRequestLinks = { /** Type for a mandate resource. */ export type Mandate = { - // This field is ACH specific, sometimes referred to as [SEC - // code](https://www.moderntreasury.com/learn/sec-codes). + // This field is ACH specific, sometimes referred to as SEC code + // (https://www.moderntreasury.com/learn/sec-codes). // // This is the way that the payer gives authorisation to the merchant. - // web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC + // web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC // code: WEB) - // telephone: Authorisation is provided orally over telephone (maps to SEC + // telephone: Authorisation is provided orally over telephone (maps to SEC // code: TEL) - // paper: Authorisation is provided in writing and signed, or similarly + // paper: Authorisation is provided in writing and signed, or similarly // authenticated (maps to SEC code: PPD) - // authorisation_source?: `${MandateAuthorisationSource}`; // (Optional) Payto and VRP Scheme specific information @@ -4944,8 +5043,9 @@ export type Mandate = { // single, recurring and sporadic for PAD. consent_type?: `${MandateConsentType}` | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // This field will decide how GoCardless handles settlement of funds from the @@ -4955,8 +5055,7 @@ export type Mandate = { // out. // - `direct` will be a direct transfer from the payer's account to the // merchant where - // invoicing will be handled separately. - // + // invoicing will be handled separately. funds_settlement?: `${MandateFundsSettlement}`; // Unique identifier, beginning with "MD". Note that this prefix may not apply @@ -4988,40 +5087,38 @@ export type Mandate = { // require approval via an automated email before being processed. payments_require_approval?: boolean; - // Unique reference. Different schemes have different length and [character - // set](#appendix-character-sets) requirements. GoCardless will generate a - // unique reference satisfying the different scheme requirements if this field - // is left blank. + // Unique reference. Different schemes have different length and character set + // (https://developer.gocardless.com/api-reference/#appendix-character-sets) + // requirements. GoCardless will generate a unique reference satisfying the + // different scheme requirements if this field is left blank. reference?: string | null; - // Bank payment scheme to which this mandate and - // associated payments are submitted. Can be supplied or automatically - // detected from the customer's bank account. + // Bank payment scheme to which this mandate and associated payments are + // submitted. Can be supplied or automatically detected from the customer's + // bank account. scheme?: string | null; // One of: - // + // + // - `pending_customer_approval`: the mandate has not yet been signed by the + // second customer + // - `pending_submission`: the mandate has not yet been submitted to the + // customer's bank + // - `submitted`: the mandate has been submitted to the customer's bank but + // has not been processed yet + // - `active`: the mandate has been successfully set up by the customer's bank + // - `suspended_by_payer`: the mandate has been suspended by payer + // - `failed`: the mandate could not be created + // - `cancelled`: the mandate has been cancelled + // - `expired`: the mandate has expired due to dormancy + // - `consumed`: the mandate has been consumed and cannot be reused (note that + // this only applies to schemes that are per-payment authorised) + // - `blocked`: the mandate has been blocked and payments cannot be created status?: `${MandateStatus}`; - // [Timestamp](#api-usage-dates-and-times) recording when this mandate was - // verified. + // Timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times) + // recording when this mandate was verified. verified_at?: string | null; }; @@ -5033,13 +5130,14 @@ export enum MandateAuthorisationSource { /** Type for a mandatecreaterequestlinks resource. */ export type MandateCreateRequestLinks = { - // ID of the associated [creditor](#core-endpoints-creditors). Only required - // if your account manages multiple creditors. + // ID of the associated creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). + // Only required if your account manages multiple creditors. creditor?: string; - // ID of the associated [customer bank - // account](#core-endpoints-customer-bank-accounts) which the mandate is - // created and submits payments against. + // ID of the associated customer bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts) + // which the mandate is created and submits payments against. customer_bank_account: string; }; @@ -5097,15 +5195,17 @@ export enum MandateFundsSettlement { /** Type for a mandatelinks resource. */ export type MandateLinks = { - // ID of the associated [creditor](#core-endpoints-creditors). + // ID of the associated creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). creditor?: string; - // ID of the associated [customer](#core-endpoints-customers) + // ID of the associated customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers) customer?: string; - // ID of the associated [customer bank - // account](#core-endpoints-customer-bank-accounts) which the mandate is - // created and submits payments against. + // ID of the associated customer bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts) + // which the mandate is created and submits payments against. customer_bank_account?: string; // ID of the new mandate if this mandate has been replaced. @@ -5127,8 +5227,9 @@ export enum MandateStatus { /** Type for a mandateimport resource. */ export type MandateImport = { - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // Unique identifier, beginning with "IM". @@ -5137,24 +5238,24 @@ export type MandateImport = { // Resources linked to this MandateImport. links?: MandateImportLinks; - // The scheme of the mandates to be imported.
All mandates in a single - // mandate + // The scheme of the mandates to be imported. + // All mandates in a single mandate // import must be for the same scheme. scheme?: `${MandateImportScheme}`; // The status of the mandate import. - // + // + // - `created`: A new mandate import. + // - `submitted`: After the integrator has finished adding mandates and + // submitted + // (https://developer.gocardless.com/api-reference/#mandate-imports-submit-a-mandate-import) + // the import. + // - `cancelled`: If the integrator cancelled + // (https://developer.gocardless.com/api-reference/#mandate-imports-cancel-a-mandate-import) + // the mandate import. + // - `processing`: Once a mandate import has been approved by a GoCardless + // team member it will be in this state while mandates are imported. + // - `processed`: When all mandates have been imported successfully. status?: `${MandateImportStatus}`; }; @@ -5194,8 +5295,9 @@ export enum MandateImportStatus { /** Type for a mandateimportentry resource. */ export type MandateImportEntry = { - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // Resources linked to this MandateImportEntry. @@ -5209,7 +5311,6 @@ export type MandateImportEntry = { // processed by GoCardless) to identify the records that have been created. // Limited // to 255 characters. - // record_identifier?: string | null; }; @@ -5217,17 +5318,14 @@ export type MandateImportEntry = { export type MandateImportEntryAmendment = { // The creditor identifier of the direct debit originator. Required if mandate // import scheme is `sepa`. - // original_creditor_id: string; // Data about the original mandate to be moved or modified. - // original_creditor_name: string; // The unique SEPA reference for the mandate being amended. Required if // mandate // import scheme is `sepa`. - // original_mandate_reference: string; }; @@ -5236,37 +5334,44 @@ export type MandateImportEntryBankAccount = { // Name of the account holder, as known by the bank. The full name provided // when the customer is created is stored and is available via the API, but is // transliterated, upcased, and truncated to 18 characters in bank - // submissions. This field is required unless the request includes a [customer - // bank account token](#javascript-flow-customer-bank-account-tokens). + // submissions. This field is required unless the request includes a customer + // bank account token + // (https://developer.gocardless.com/api-reference/#javascript-flow-customer-bank-account-tokens). account_holder_name: string; - // Bank account number - see [local details](#appendix-local-bank-details) for - // more information. Alternatively you can provide an `iban`. + // Bank account number - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. account_number?: string | null; // Bank account type. Required for USD-denominated bank accounts. Must not be - // provided for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // provided for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${MandateImportEntryBankAccountAccountType}`; - // Bank code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Bank code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. bank_code?: string | null; - // Branch code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Branch code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. branch_code?: string | null; - // [ISO 3166-1 alpha-2 - // code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). + // ISO 3166-1 alpha-2 code + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). // Defaults to the country code of the `iban` if supplied, otherwise is // required. country_code?: string | null; - // International Bank Account Number. Alternatively you can provide [local - // details](#appendix-local-bank-details). IBANs are not accepted for Swedish - // bank accounts denominated in SEK - you must supply [local - // details](#local-bank-details-sweden). + // International Bank Account Number. Alternatively you can provide local + // details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details). + // IBANs are not accepted for Swedish bank accounts denominated in SEK - you + // must supply local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-sweden). iban?: string | null; // Key-value store of custom data. Up to 3 keys are permitted, with key names @@ -5283,7 +5388,6 @@ export enum MandateImportEntryBankAccountAccountType { export type MandateImportEntryCustomer = { // The first line of the customer's address. Required if mandate import scheme // is either `bacs` or `sepa`. - // address_line1?: string; // The second line of the customer's address. @@ -5302,8 +5406,8 @@ export type MandateImportEntryCustomer = { // "Personal PAD"). company_name?: string | null; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string | null; // For Danish customers only. The civic/company number (CPR or CVR) of the @@ -5321,30 +5425,29 @@ export type MandateImportEntryCustomer = { // Customer's first name. Required unless a `company_name` is provided. given_name?: string | null; - // [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. + // ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. // Used as the language for notification emails sent by GoCardless if your - // organisation does not send its own (see [compliance - // requirements](#appendix-compliance-requirements)). Currently only "en", - // "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are supported. - // If this is not provided, the language will be chosen based on the - // `country_code` (if supplied) or default to "en". + // organisation does not send its own (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). + // Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", + // "sv" are supported. If this is not provided, the language will be chosen + // based on the `country_code` (if supplied) or default to "en". language?: string | null; // Key-value store of custom data. Up to 3 keys are permitted, with key names // up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string }; - // [ITU E.123](https://en.wikipedia.org/wiki/E.123) formatted phone number, + // ITU E.123 (https://en.wikipedia.org/wiki/E.123) formatted phone number, // including country code. phone_number?: string | null; // The customer's postal code. Required if mandate import scheme is either // `bacs` or `sepa`. - // postal_code?: string; // The customer's address region, county or department. For US customers a 2 - // letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state + // letter ISO3166-2:US (https://en.wikipedia.org/wiki/ISO_3166-2:US) state // code is required (e.g. `CA` for California). region?: string | null; @@ -5363,27 +5466,26 @@ export type MandateImportEntryCreateRequestLinks = { /** Type for a mandateimportentrymandate resource. */ export type MandateImportEntryMandate = { - // This field is ACH specific, sometimes referred to as [SEC - // code](https://www.moderntreasury.com/learn/sec-codes). + // This field is ACH specific, sometimes referred to as SEC code + // (https://www.moderntreasury.com/learn/sec-codes). // // This is the way that the payer gives authorisation to the merchant. - // web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC + // web: Authorisation is Internet Initiated or via Mobile Entry (maps to SEC // code: WEB) - // telephone: Authorisation is provided orally over telephone (maps to SEC + // telephone: Authorisation is provided orally over telephone (maps to SEC // code: TEL) - // paper: Authorisation is provided in writing and signed, or similarly + // paper: Authorisation is provided in writing and signed, or similarly // authenticated (maps to SEC code: PPD) - // authorisation_source?: `${MandateImportEntryMandateAuthorisationSource}`; // Key-value store of custom data. Up to 3 keys are permitted, with key names // up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string }; - // Unique reference. Different schemes have different length and [character - // set](#appendix-character-sets) requirements. GoCardless will generate a - // unique reference satisfying the different scheme requirements if this field - // is left blank. + // Unique reference. Different schemes have different length and character set + // (https://developer.gocardless.com/api-reference/#appendix-character-sets) + // requirements. GoCardless will generate a unique reference satisfying the + // different scheme requirements if this field is left blank. reference?: string | null; }; @@ -5414,8 +5516,8 @@ export type MandateImportEntryLinks = { mandate?: string; // The ID of the mandate import. This is returned when you - // [create a Mandate Import](#mandate-imports-create-a-new-mandate-import). - // + // create a Mandate Import + // (https://developer.gocardless.com/api-reference/#mandate-imports-create-a-new-mandate-import). mandate_import: string; }; @@ -5438,13 +5540,15 @@ export enum MandatePdfAccountType { /** Type for a mandatepdfcreaterequestlinks resource. */ export type MandatePdfCreateRequestLinks = { - // ID of an existing [creditor](#core-endpoints-creditors). Only required if - // your account manages multiple creditors. + // ID of an existing creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). + // Only required if your account manages multiple creditors. creditor?: string; - // ID of an existing [mandate](#core-endpoints-mandates) to build the PDF - // from. The customer's bank details will be censored in the generated PDF. No - // other parameters may be provided alongside this. + // ID of an existing mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // to build the PDF from. The customer's bank details will be censored in the + // generated PDF. No other parameters may be provided alongside this. mandate?: string; }; @@ -5459,11 +5563,12 @@ export type NegativeBalanceLimit = { // The limit amount in pence (e.g. 10000 for a -100 GBP limit). balance_limit?: string; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this limit - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this limit was created. created_at?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: `${NegativeBalanceLimitCurrency}`; @@ -5491,7 +5596,9 @@ export type NegativeBalanceLimitLinks = { // ID of the creator_user who created this limit creator_user?: string; - // ID of [creditor](#core-endpoints-creditors) which this limit relates to + // ID of creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors) + // which this limit relates to creditor?: string; }; @@ -5501,11 +5608,12 @@ export type OutboundPayment = { // cents in EUR). amount?: number; - // Fixed [timestamp](#api-usage-dates-and-times), recording when the outbound - // payment was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when the outbound payment was created. created_at?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency. + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency. // Currently only "GBP" is supported. currency?: `${OutboundPaymentCurrency}`; @@ -5531,9 +5639,12 @@ export type OutboundPayment = { metadata?: { [key: string]: string }; // An optional reference that will appear on your customer's bank statement. - // The character limit for this reference is dependent on the scheme.
- // Faster Payments - 18 characters, including: - // "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789 &-./"
+ // The character limit for this reference is dependent on the scheme. + // + // Faster Payments reference?: string; // Bank payment scheme to process the outbound payment. Currently only @@ -5541,25 +5652,26 @@ export type OutboundPayment = { scheme?: `${OutboundPaymentScheme}`; // One of: - // + // + // - `verifying`: The payment has been created + // (https://developer.gocardless.com/api-reference/#outbound-payments-create-an-outbound-payment) + // and the verification process has begun. + // - `pending_approval`: The payment is awaiting approval + // (https://developer.gocardless.com/api-reference/#outbound-payments-approve-an-outbound-payment). + // - `scheduled`: The payment has passed verification & approval + // (https://developer.gocardless.com/api-reference/#outbound-payments-approve-an-outbound-payment), + // but processing has not yet begun. + // - `executing`: The execution date has arrived and the payment has been + // placed in queue for processing. + // - `executed`: The payment has been accepted by the scheme and is now on its + // way to the recipient. + // - `cancelled`: The payment has been cancelled + // (https://developer.gocardless.com/api-reference/#outbound-payments-cancel-an-outbound-payment) + // or was not approved + // (https://developer.gocardless.com/api-reference/#outbound-payments-approve-an-outbound-payment) + // on time. + // - `failed`: The payment was not sent, usually due to an error while or + // after executing. status?: `${OutboundPaymentStatus}`; // Contains details of the verifications performed for the outbound payment @@ -5607,8 +5719,9 @@ export type OutboundPaymentLinks = { // ID of the creditor who sends the outbound payment. creditor?: string; - // ID of the [customer](#core-endpoints-customers) that receives this outbound - // payment + // ID of the customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers) + // that receives this outbound payment customer?: string; // ID of the outbound payment import that created this outbound payment. @@ -5631,21 +5744,20 @@ export type OutboundPaymentVerificationsRecipientBankAccountHolderVerification = actual_account_name?: string | null; // Result of the verification, could be one of - // + // + // - `full_match`: The verification has confirmed that the account name + // exactly matches the details provided. + // - `partial_match`: The verification has confirmed that the account name is + // similar but does not match to the details provided. + // - `no_match`: The verification concludes the provided name does not match + // the account details. + // - `unable_to_match`: The verification could not be performed due to + // recipient bank issues or technical issues result?: `${OutboundPaymentVerificationsRecipientBankAccountHolderVerificationResult}`; // Type of the verification that has been performed - // eg. [Confirmation of - // Payee](https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/) + // eg. Confirmation of Payee + // (https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/) type?: `${OutboundPaymentVerificationsRecipientBankAccountHolderVerificationType}`; }; @@ -5669,11 +5781,12 @@ export type OutboundPaymentImport = { // The link to the GoCardless dashboard to review and authorise the import authorisation_url?: string; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency. + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency. // Currently only "GBP" is supported. currency?: `${OutboundPaymentImportCurrency}`; @@ -5687,18 +5800,16 @@ export type OutboundPaymentImport = { links?: OutboundPaymentImportLinks; // The status of the outbound payment import. - // + // + // - `created`: The initial state of a new import. + // - `validating`: Import validation in progress. + // - `invalid`: Import validation failed. + // - `valid`: Import validation succeeded. + // - `processing`: Authorisation received; payments are being generated. + // - `processed`: All entries have been successfully converted into outbound + // payments. + // - `cancelled`: The import was cancelled by a user or automatically expired + // by the system. status?: `${OutboundPaymentImportStatus}`; }; @@ -5716,9 +5827,12 @@ export type OutboundPaymentImportEntryItem = { recipient_bank_account_id: string; // An optional reference that will appear on your customer's bank statement. - // The character limit for this reference is dependent on the scheme.
- // Faster Payments - 18 characters, including: - // "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789 &-./"
+ // The character limit for this reference is dependent on the scheme. + // + // Faster Payments reference?: string; // Bank payment scheme to process the outbound payment. Currently only @@ -5799,8 +5913,9 @@ export type OutboundPaymentImportEntry = { // cents in EUR). amount?: number | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // Unique identifier, beginning with "IE". @@ -5813,8 +5928,9 @@ export type OutboundPaymentImportEntry = { // key names up to 50 characters and values up to 500 characters. metadata?: { [key: string]: string } | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this entry - // was processed. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this entry was processed. processed_at?: string | null; // An optional reference for the outbound payment. @@ -5884,15 +6000,17 @@ export enum OutboundPaymentImportEntryVerificationResult { /** Type for a payerauthorisation resource. */ export type PayerAuthorisation = { // All details required for the creation of a - // [Customer Bank Account](#core-endpoints-customer-bank-accounts). + // Customer Bank Account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts). bank_account?: PayerAuthorisationBankAccount; - // [Timestamp](#api-usage-dates-and-times), recording when this Payer - // Authorisation was created. + // Timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this Payer Authorisation was created. created_at?: string | null; - // All details required for the creation of a - // [Customer](#core-endpoints-customers). + // All details required for the creation of a Customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers). customer?: PayerAuthorisationCustomer; // Unique identifier, beginning with "PA". @@ -5904,22 +6022,21 @@ export type PayerAuthorisation = { // Resources linked to this PayerAuthorisation. links?: PayerAuthorisationLinks; - // All details required for the creation of a - // [Mandate](#core-endpoints-mandates). + // All details required for the creation of a Mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates). mandate?: PayerAuthorisationMandate; // One of: - // + // + // - `created`: The PayerAuthorisation has been created, and not been + // confirmed yet + // - `submitted`: The payer information has been submitted + // - `confirmed`: PayerAuthorisation is confirmed and resources are ready to + // be created + // - `completed`: The PayerAuthorisation has been completed and customer, + // bank_account and mandate has been created + // - `failed`: The PayerAuthorisation has failed and customer, bank_account + // and mandate is not created status?: `${PayerAuthorisationStatus}`; }; @@ -5928,12 +6045,14 @@ export type PayerAuthorisationBankAccount = { // Name of the account holder, as known by the bank. The full name provided // when the customer is created is stored and is available via the API, but is // transliterated, upcased, and truncated to 18 characters in bank - // submissions. This field is required unless the request includes a [customer - // bank account token](#javascript-flow-customer-bank-account-tokens). + // submissions. This field is required unless the request includes a customer + // bank account token + // (https://developer.gocardless.com/api-reference/#javascript-flow-customer-bank-account-tokens). account_holder_name?: string; - // Bank account number - see [local details](#appendix-local-bank-details) for - // more information. Alternatively you can provide an `iban`. + // Bank account number - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. account_number?: string | null; // The last few digits of the account number. Currently 4 digits for NZD bank @@ -5941,37 +6060,44 @@ export type PayerAuthorisationBankAccount = { account_number_ending?: string; // Account number suffix (only for bank accounts denominated in NZD) - see - // [local details](#local-bank-details-new-zealand) for more information. + // local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-new-zealand) + // for more information. account_number_suffix?: string | null; // Bank account type. Required for USD-denominated bank accounts. Must not be - // provided for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // provided for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${PayerAuthorisationBankAccountAccountType}`; - // Bank code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Bank code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. bank_code?: string | null; - // Branch code - see [local details](#appendix-local-bank-details) for more - // information. Alternatively you can provide an `iban`. + // Branch code - see local details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details) + // for more information. Alternatively you can provide an `iban`. branch_code?: string | null; - // [ISO 3166-1 alpha-2 - // code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). + // ISO 3166-1 alpha-2 code + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). // Defaults to the country code of the `iban` if supplied, otherwise is // required. country_code?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: string | null; - // International Bank Account Number. Alternatively you can provide [local - // details](#appendix-local-bank-details). IBANs are not accepted for Swedish - // bank accounts denominated in SEK - you must supply [local - // details](#local-bank-details-sweden). + // International Bank Account Number. Alternatively you can provide local + // details + // (https://developer.gocardless.com/api-reference/#appendix-local-bank-details). + // IBANs are not accepted for Swedish bank accounts denominated in SEK - you + // must supply local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-sweden). iban?: string | null; // Key-value store of custom data. Up to 3 keys are permitted, with key names @@ -6005,8 +6131,8 @@ export type PayerAuthorisationCustomer = { // "Personal PAD"). company_name?: string | null; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string | null; // For Danish customers only. The civic/company number (CPR or CVR) of the @@ -6024,10 +6150,9 @@ export type PayerAuthorisationCustomer = { // Customer's first name. Required unless a `company_name` is provided. given_name?: string | null; - // An [IETF Language Tag](https://tools.ietf.org/html/rfc5646), used for both + // An IETF Language Tag (https://tools.ietf.org/html/rfc5646), used for both // language // and regional variations of our product. - // locale?: string | null; // Key-value store of custom data. Up to 3 keys are permitted, with key names @@ -6038,7 +6163,7 @@ export type PayerAuthorisationCustomer = { postal_code?: string | null; // The customer's address region, county or department. For US customers a 2 - // letter [ISO3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state + // letter ISO3166-2:US (https://en.wikipedia.org/wiki/ISO_3166-2:US) state // code is required (e.g. `CA` for California). region?: string | null; @@ -6086,13 +6211,12 @@ export type PayerAuthorisationMandate = { // // Not required for creating offline mandates where `authorisation_source` is // set to telephone or paper. - // payer_ip_address?: string | null; - // Unique reference. Different schemes have different length and [character - // set](#appendix-character-sets) requirements. GoCardless will generate a - // unique reference satisfying the different scheme requirements if this field - // is left blank. + // Unique reference. Different schemes have different length and character set + // (https://developer.gocardless.com/api-reference/#appendix-character-sets) + // requirements. GoCardless will generate a unique reference satisfying the + // different scheme requirements if this field is left blank. reference?: string | null; // A bank payment scheme. Currently "ach", "autogiro", "bacs", "becs", @@ -6144,30 +6268,34 @@ export type Payment = { // constraint. amount?: string; - // Amount [refunded](#core-endpoints-refunds), in the lowest denomination for - // the currency (e.g. pence in GBP, cents in EUR). + // Amount refunded + // (https://developer.gocardless.com/api-reference/#core-endpoints-refunds), + // in the lowest denomination for the currency (e.g. pence in GBP, cents in + // EUR). amount_refunded?: string; // A future date on which the payment should be collected. If not specified, // the payment will be collected as soon as possible. If the value is before - // the [mandate](#core-endpoints-mandates)'s `next_possible_charge_date` - // creation will fail. If the value is not a working day it will be rolled - // forwards to the next available one. + // the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates)'s + // `next_possible_charge_date` creation will fail. If the value is not a + // working day it will be rolled forwards to the next available one. charge_date?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: `${PaymentCurrency}`; // A human-readable description of the payment. This will be included in the // notification email GoCardless sends to your customer if your organisation - // does not send its own notifications (see [compliance - // requirements](#appendix-compliance-requirements)). + // does not send its own notifications (see compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)). description?: string | null; // This field indicates whether the ACH payment is processed through Faster @@ -6190,29 +6318,50 @@ export type Payment = { metadata?: { [key: string]: string }; // An optional reference that will appear on your customer's bank statement. - // The character limit for this reference is dependent on the scheme.
- // ACH - 10 characters
Autogiro - 11 - // characters
Bacs - 10 characters
- // BECS - 30 characters
BECS NZ - 12 - // characters
Betalingsservice - 30 characters
- // Faster Payments - 18 characters
PAD - // - scheme doesn't offer references
PayTo - 18 - // characters
SEPA - 140 characters
Note that - // this reference must be unique (for each merchant) for the BECS scheme as it - // is a scheme requirement.

Restricted: You can only specify - // a payment reference for Bacs payments (that is, when collecting from the - // UK) if you're on the GoCardless - // Plus, Pro or Enterprise packages.

Restricted: You can not specify - // a payment reference for Faster Payments.

+ // The character limit for this reference is dependent on the scheme. + // ACH + // Autogiro + // Bacs + // BECS + // BECS NZ + // Betalingsservice + // Faster Payments + // PAD + // PayTo + // SEPA + // Note that this reference must be unique (for each merchant) for the BECS + // scheme as it is a scheme requirement. Restricted: You can only specify a + // payment reference for Bacs payments (that is, when collecting from the UK) + // if you're on the GoCardless Plus, Pro or Enterprise packages + // (https://gocardless.com/pricing). + // Restricted: You can not specify a payment reference for Faster Payments. reference?: string | null; - // On failure, automatically retry the payment using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

+ // On failure, automatically retry the payment using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is + // `false`. Important: To be able to use intelligent retries, Success+ needs + // to be enabled in GoCardless dashboard + // (https://manage.gocardless.com/success-plus). retry_if_possible?: boolean; // A bank payment scheme. Currently "ach", "autogiro", "bacs", "becs", @@ -6222,23 +6371,21 @@ export type Payment = { scheme?: string | null; // One of: - // + // + // - `pending_customer_approval`: we're waiting for the customer to approve + // this payment + // - `pending_submission`: the payment has been created, but not yet submitted + // to the banks + // - `submitted`: the payment has been submitted to the banks + // - `confirmed`: the payment has been confirmed as collected + // - `paid_out`: the payment has been included in a payout + // (https://developer.gocardless.com/api-reference/#core-endpoints-payouts) + // - `cancelled`: the payment has been cancelled + // - `customer_approval_denied`: the customer has denied approval for the + // payment. You should contact the customer directly + // - `failed`: the payment failed to be processed. Note that payments can fail + // after being confirmed if the failure message is sent late by the banks. + // - `charged_back`: the payment has been charged back status?: `${PaymentStatus}`; }; @@ -6255,8 +6402,9 @@ export enum PaymentCurrency { /** Type for a paymentcreaterequestlinks resource. */ export type PaymentCreateRequestLinks = { - // ID of the [mandate](#core-endpoints-mandates) against which this payment - // should be collected. + // ID of the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // against which this payment should be collected. mandate: string; }; @@ -6323,8 +6471,8 @@ export type PaymentFx = { // Present only after the resource has been paid out. fx_amount?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for - // the currency in which amounts will be paid out (after foreign exchange). + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the + // currency in which amounts will be paid out (after foreign exchange). // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. Present only if payouts will be (or were) made via foreign // exchange. @@ -6344,27 +6492,35 @@ export enum PaymentFxFxCurrency { /** Type for a paymentlinks resource. */ export type PaymentLinks = { - // ID of [creditor](#core-endpoints-creditors) to which the collected payment - // will be sent. + // ID of creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors) + // to which the collected payment will be sent. creditor?: string; - // ID of [instalment_schedule](#core-endpoints-instalment-schedules) from - // which this payment was created.
**Note**: this property will only be - // present if this payment is part of an instalment schedule. + // ID of instalment_schedule + // (https://developer.gocardless.com/api-reference/#core-endpoints-instalment-schedules) + // from which this payment was created. + // Note: this property will only be present if this payment is part of an + // instalment schedule. instalment_schedule?: string; - // ID of the [mandate](#core-endpoints-mandates) against which this payment - // should be collected. + // ID of the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // against which this payment should be collected. mandate?: string; - // ID of [payout](#core-endpoints-payouts) which contains the funds from this - // payment.
_Note_: this property will not be present until the payment - // has been successfully collected. + // ID of payout + // (https://developer.gocardless.com/api-reference/#core-endpoints-payouts) + // which contains the funds from this payment. + // Note: this property will not be present until the payment has been + // successfully collected. payout?: string; - // ID of [subscription](#core-endpoints-subscriptions) from which this payment - // was created.
_Note_: this property will only be present if this payment - // is part of a subscription. + // ID of subscription + // (https://developer.gocardless.com/api-reference/#core-endpoints-subscriptions) + // from which this payment was created. + // Note: this property will only be present if this payment is part of a + // subscription. subscription?: string; }; @@ -6376,7 +6532,8 @@ export type PaymentAccount = { account_balance?: number; // Name of the account holder, as known by the bank. Usually this is the same - // as the name stored with the linked [creditor](#core-endpoints-creditors). + // as the name stored with the linked creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). // This field will be transliterated, upcased and truncated to 18 characters. account_holder_name?: string; @@ -6387,7 +6544,7 @@ export type PaymentAccount = { // Name of bank, taken from the bank details. bank_name?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: string | null; @@ -6401,8 +6558,9 @@ export type PaymentAccount = { /** Type for a paymentaccountlinks resource. */ export type PaymentAccountLinks = { - // ID of the [creditor](#core-endpoints-creditors) that owns this bank - // account. + // ID of the creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors) + // that owns this bank account. creditor?: string; }; @@ -6455,14 +6613,17 @@ export enum PaymentAccountTransactionCurrency { /** Type for a paymentaccounttransactionlinks resource. */ export type PaymentAccountTransactionLinks = { - // ID of the [outbound_payment](#core-endpoints-outbound-payments) linked to - // the transaction + // ID of the outbound_payment + // (https://developer.gocardless.com/api-reference/#core-endpoints-outbound-payments) + // linked to the transaction outbound_payment?: string; // ID of the payment bank account. payment_bank_account?: string; - // ID of the [payout](#core-endpoints-payouts) linked to the transaction. + // ID of the payout + // (https://developer.gocardless.com/api-reference/#core-endpoints-payouts) + // linked to the transaction. payout?: string; }; @@ -6473,34 +6634,33 @@ export type Payout = { // Date the payout is due to arrive in the creditor's bank account. // One of: - // // + // - `yyyy-mm-dd`: the payout has been paid and is due to arrive in the + // creditor's bank + // account on this day + // - `null`: the payout hasn't been paid yet arrival_date?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: `${PayoutCurrency}`; // Fees that have already been deducted from the payout amount in minor unit // (e.g. pence in GBP, cents in EUR), inclusive of tax if applicable. - //
+ // // For each `late_failure_settled` or `chargeback_settled` action, we refund // the transaction fees in a payout. This means that a payout can have a // negative `deducted_fees` value. - //
+ // // This field is calculated as `(GoCardless fees + app fees + surcharge fees) // - (refunded fees)` - //
+ // // If the merchant is invoiced for fees separately from the payout, then // `deducted_fees` will be 0. deducted_fees?: string; @@ -6515,8 +6675,8 @@ export type Payout = { links?: PayoutLinks; // Key-value store of custom data. Up to 3 keys are permitted, with key names - // up to 50 characters and values up to 500 characters. _Note:_ This should - // not be used for storing PII data. + // up to 50 characters and values up to 500 characters. Note: This should not + // be used for storing PII data. metadata?: { [key: string]: string }; // Whether a payout contains merchant revenue or partner fees. @@ -6526,20 +6686,18 @@ export type Payout = { reference?: string; // One of: - // + // + // - `pending`: the payout has been created, but not yet sent to your bank or + // it is in the process of being exchanged through our FX provider. + // - `paid`: the payout has been sent to the your bank. FX payouts will become + // `paid` after we emit the `fx_rate_confirmed` webhook. + // - `bounced`: the payout bounced when sent, the payout can be retried. status?: `${PayoutStatus}`; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for - // the currency in which tax is paid out to the tax authorities of your tax + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the + // currency in which tax is paid out to the tax authorities of your tax // jurisdiction. Currently “EUR”, “GBP”, for French or British merchants, this - // will be `null` if tax is not applicable beta + // will be `null` if tax is not applicable beta tax_currency?: string | null; }; @@ -6582,8 +6740,8 @@ export type PayoutFx = { // Present only after the resource has been paid out. fx_amount?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for - // the currency in which amounts will be paid out (after foreign exchange). + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the + // currency in which amounts will be paid out (after foreign exchange). // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. Present only if payouts will be (or were) made via foreign // exchange. @@ -6603,12 +6761,15 @@ export enum PayoutFxFxCurrency { /** Type for a payoutlinks resource. */ export type PayoutLinks = { - // ID of [creditor](#core-endpoints-creditors) who will receive this payout, - // i.e. the owner of the `creditor_bank_account`. + // ID of creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors) + // who will receive this payout, i.e. the owner of the + // `creditor_bank_account`. creditor?: string; - // ID of [bank account](#core-endpoints-creditor-bank-accounts) which this - // will be sent to. + // ID of bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts) + // which this will be sent to. creditor_bank_account?: string; }; @@ -6618,51 +6779,50 @@ export type PayoutItem = { // currency; // the lowest denomination for the currency (e.g. pence in GBP, cents in EUR), // to one decimal place. - //

For accuracy, we store some of our fees to greater - // precision than we can actually pay out (for example, a GoCardless fee we - // record might come to 0.5 pence, but it is not possible to send a payout via - // bank transfer including a half penny).

To calculate the final amount - // of the payout, we sum all of the items and then round to the nearest - // currency unit.

+ // + // For accuracy, we store some of our fees to greater precision than we can + // actually pay out (for example, a GoCardless fee we record might come to 0.5 + // pence, but it is not possible to send a payout via bank transfer including + // a half penny). + // + // To calculate the final amount of the payout, we sum all of the items and + // then round to the nearest currency unit. amount?: string; // Resources linked to this PayoutItem. links?: PayoutItemLinks; - // An array of tax items beta + // An array of tax items beta // - // _Note_: VAT applies to transaction and surcharge fees for merchants - // operating in the UK and France. + // Note: VAT applies to transaction and surcharge fees for merchants operating + // in the UK and France. taxes?: PayoutItemTaxis[]; // The type of the credit (positive) or debit (negative) item in the payout // (inclusive of VAT if applicable). One of: - // - // + // for merchants. type?: `${PayoutItemType}`; }; @@ -6693,7 +6853,7 @@ export type PayoutItemTaxis = { // decimal place. amount?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: `${PayoutItemTaxisCurrency}`; @@ -6706,8 +6866,8 @@ export type PayoutItemTaxis = { // until the `exchange_rate` has been finalised. destination_amount?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for - // the currency in which tax is paid out to the tax authorities of your tax + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the + // currency in which tax is paid out to the tax authorities of your tax // jurisdiction. Currently “EUR” for French merchants and “GBP” for British // merchants. destination_currency?: string; @@ -6718,10 +6878,9 @@ export type PayoutItemTaxis = { // Present only if the currency and the destination currency don't match and // the exchange rate has been finalised. // - // You can listen for the payout's [`tax_exchange_rates_confirmed` - // webhook](https://developer.gocardless.com/api-reference/#event-types-payout) - // to know when the exchange rate has been finalised for all fees in the - // payout. + // You can listen for the payout's `tax_exchange_rates_confirmed` webhook + // (https://developer.gocardless.com/api-reference/#event-types-payout) to + // know when the exchange rate has been finalised for all fees in the payout. exchange_rate?: string | null; // The unique identifier created by the jurisdiction, tax type and version @@ -6758,15 +6917,16 @@ export type RedirectFlow = { // customer to rather than use your own page, that confirms in their chosen // language that their Direct Debit has been set up successfully. Only // returned once the customer has set up their mandate via the payment pages - // and the redirect flow has been - // [completed](#redirect-flows-complete-a-redirect-flow), and only available - // for 15 minutes from when you complete the redirect flow. The structure of - // this URL may change at any time, so you should read it directly from the - // API response. + // and the redirect flow has been completed + // (https://developer.gocardless.com/api-reference/#redirect-flows-complete-a-redirect-flow), + // and only available for 15 minutes from when you complete the redirect flow. + // The structure of this URL may change at any time, so you should read it + // directly from the API response. confirmation_url?: string; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // A description of the item the customer is paying for. This will be shown on @@ -6783,8 +6943,8 @@ export type RedirectFlow = { mandate_reference?: string; // Key-value store of custom data. Up to 3 keys are permitted, with key names - // up to 50 characters and values up to 500 characters. _Note:_ This should - // not be used for storing PII data. + // up to 50 characters and values up to 500 characters. Note: This should not + // be used for storing PII data. metadata?: { [key: string]: string }; // The URL of the hosted payment pages for this redirect flow. This is the URL @@ -6810,17 +6970,20 @@ export type RedirectFlow = { /** Type for a redirectflowcreaterequestlinks resource. */ export type RedirectFlowCreateRequestLinks = { - // The [creditor](#core-endpoints-creditors) for whom the mandate will be - // created. The `name` of the creditor will be displayed on the payment page. - // Required if your account manages multiple creditors. + // The creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors) + // for whom the mandate will be created. The `name` of the creditor will be + // displayed on the payment page. Required if your account manages multiple + // creditors. creditor?: string; }; /** Type for a redirectflowprefilledbankaccount resource. */ export type RedirectFlowPrefilledBankAccount = { // Bank account type for USD-denominated bank accounts. Must not be provided - // for bank accounts in other currencies. See [local - // details](#local-bank-details-united-states) for more information. + // for bank accounts in other currencies. See local details + // (https://developer.gocardless.com/api-reference/#local-bank-details-united-states) + // for more information. account_type?: `${RedirectFlowPrefilledBankAccountAccountType}`; }; @@ -6847,8 +7010,8 @@ export type RedirectFlowPrefilledCustomer = { // `given_name` and `family_name` are null. company_name?: string | null; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string | null; // For Danish customers only. The civic/company number (CPR or CVR) of the @@ -6864,7 +7027,7 @@ export type RedirectFlowPrefilledCustomer = { // Customer's first name. given_name?: string | null; - // [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. + // ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. language?: string | null; // For New Zealand customers only. @@ -6894,29 +7057,38 @@ export enum RedirectFlowScheme { /** Type for a redirectflowlinks resource. */ export type RedirectFlowLinks = { - // ID of [billing request](#billing-requests-billing-requests) that a redirect - // flow can create.
**Note**: The redirect flow will only create a - // billing request in the event the redirect flow is eligible to send the - // payer down this new and improved flow + // ID of billing request + // (https://developer.gocardless.com/api-reference/#billing-requests-billing-requests) + // that a redirect flow can create. + // Note: The redirect flow will only create a billing request in the event the + // redirect flow is eligible to send the payer down this new and improved flow billing_request?: string; - // The [creditor](#core-endpoints-creditors) for whom the mandate will be - // created. The `name` of the creditor will be displayed on the payment page. + // The creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors) + // for whom the mandate will be created. The `name` of the creditor will be + // displayed on the payment page. creditor?: string; - // ID of [customer](#core-endpoints-customers) created by this redirect - // flow.
**Note**: this property will not be present until the redirect - // flow has been successfully completed. + // ID of customer + // (https://developer.gocardless.com/api-reference/#core-endpoints-customers) + // created by this redirect flow. + // Note: this property will not be present until the redirect flow has been + // successfully completed. customer?: string; - // ID of [customer bank account](#core-endpoints-customer-bank-accounts) - // created by this redirect flow.
**Note**: this property will not be - // present until the redirect flow has been successfully completed. + // ID of customer bank account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts) + // created by this redirect flow. + // Note: this property will not be present until the redirect flow has been + // successfully completed. customer_bank_account?: string; - // ID of [mandate](#core-endpoints-mandates) created by this redirect - // flow.
**Note**: this property will not be present until the redirect - // flow has been successfully completed. + // ID of mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // created by this redirect flow. + // Note: this property will not be present until the redirect flow has been + // successfully completed. mandate?: string; }; @@ -6925,13 +7097,14 @@ export type Refund = { // Amount in minor unit (e.g. pence in GBP, cents in EUR). amount?: string; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency - // code. This is set to the currency of the refund's - // [payment](#core-endpoints-payments). + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // code. This is set to the currency of the refund's payment + // (https://developer.gocardless.com/api-reference/#core-endpoints-payments). currency?: string; // @@ -6948,50 +7121,71 @@ export type Refund = { metadata?: { [key: string]: string }; // An optional reference that will appear on your customer's bank statement. - // The character limit for this reference is dependent on the scheme.
- // ACH - 10 characters
Autogiro - 11 - // characters
Bacs - 10 characters
- // BECS - 30 characters
BECS NZ - 12 - // characters
Betalingsservice - 30 characters
- // Faster Payments - 18 characters
PAD - // - scheme doesn't offer references
PayTo - 18 - // characters
SEPA - 140 characters
Note that - // this reference must be unique (for each merchant) for the BECS scheme as it - // is a scheme requirement.

Restricted: You can only specify - // a payment reference for Bacs payments (that is, when collecting from the - // UK) if you're on the GoCardless - // Plus, Pro or Enterprise packages.

Restricted: You can not specify - // a payment reference for Faster Payments.

+ // The character limit for this reference is dependent on the scheme. + // ACH + // Autogiro + // Bacs + // BECS + // BECS NZ + // Betalingsservice + // Faster Payments + // PAD + // PayTo + // SEPA + // Note that this reference must be unique (for each merchant) for the BECS + // scheme as it is a scheme requirement. Restricted: You can only specify a + // payment reference for Bacs payments (that is, when collecting from the UK) + // if you're on the GoCardless Plus, Pro or Enterprise packages + // (https://gocardless.com/pricing). + // Restricted: You can not specify a payment reference for Faster Payments. reference?: string | null; // One of: - // + // + // - `created`: the refund has been created + // - `pending_submission`: the refund has been created, but not yet submitted + // to the banks + // - `submitted`: the refund has been submitted to the banks + // - `paid`: the refund has been included in a payout + // (https://developer.gocardless.com/api-reference/#core-endpoints-payouts) + // - `cancelled`: the refund has been cancelled + // - `bounced`: the refund has failed to be paid + // - `funds_returned`: the refund has had its funds returned status?: `${RefundStatus}`; }; /** Type for a refundcreaterequestlinks resource. */ export type RefundCreateRequestLinks = { - // ID of the [mandate](#core-endpoints-mandates) against which the refund is - // being made.

Restricted: You must request - // access to Mandate Refunds by contacting our support team.

+ // ID of the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // against which the refund is being made. + // Restricted: You must request access to Mandate Refunds by contacting our + // support team (mailto:support@gocardless.com). mandate?: string; - // ID of the [payment](#core-endpoints-payments) against which the refund is - // being made. + // ID of the payment + // (https://developer.gocardless.com/api-reference/#core-endpoints-payments) + // against which the refund is being made. payment?: string; }; @@ -7017,8 +7211,8 @@ export type RefundFx = { // Present only after the resource has been paid out. fx_amount?: string | null; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for - // the currency in which amounts will be paid out (after foreign exchange). + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the + // currency in which amounts will be paid out (after foreign exchange). // Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are // supported. Present only if payouts will be (or were) made via foreign // exchange. @@ -7038,12 +7232,14 @@ export enum RefundFxFxCurrency { /** Type for a refundlinks resource. */ export type RefundLinks = { - // ID of the [mandate](#core-endpoints-mandates) against which the refund is - // being made. + // ID of the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // against which the refund is being made. mandate?: string; - // ID of the [payment](#core-endpoints-payments) against which the refund is - // being made. + // ID of the payment + // (https://developer.gocardless.com/api-reference/#core-endpoints-payments) + // against which the refund is being made. payment?: string; }; @@ -7061,132 +7257,129 @@ export enum RefundStatus { export type ScenarioSimulator = { // The unique identifier of the simulator, used to initiate simulations. One // of: - // + // supported. + // - `billing_request_fulfilled_and_payment_paid_out`: Authorises the billing + // request, fulfils it, and moves the associated payment to `paid_out`. The + // billing request must be in the `pending` state, with all actions completed + // except for `bank_authorisation`. Only billing requests with a + // `payment_request` are supported. id?: string; }; @@ -7216,12 +7409,13 @@ export type SchemeIdentifier = { // The city of the scheme identifier's support address. city?: string; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code?: string; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // The currency of the scheme identifier. @@ -7238,8 +7432,9 @@ export type SchemeIdentifier = { // this scheme identifier. // // By default, GoCardless sends these notifications automatically. Please see - // our [compliance requirements](#appendix-compliance-requirements) for more - // details. + // our compliance requirements + // (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements) + // for more details. minimum_advance_notice?: number; // The name which appears on customers' bank statements. This should usually @@ -7268,9 +7463,8 @@ export type SchemeIdentifier = { /** Type for a schemeidentifiercreaterequestlinks resource. */ export type SchemeIdentifierCreateRequestLinks = { - // required ID of the associated - // [creditor](#core-endpoints-creditors). - // + // required ID of the associated creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). creditor?: string; }; @@ -7384,11 +7578,12 @@ export type Subscription = { // The total number of payments that should be taken by this subscription. count?: string | null; - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; - // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency + // ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency // code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" // are supported. currency?: string; @@ -7404,13 +7599,12 @@ export type Subscription = { earliest_charge_date_after_resume?: string | null; // Date on or after which no further payments should be created. - //
+ // // If this field is blank and `count` is not specified, the subscription will // continue forever. - //
- //

Deprecated: This field will - // be removed in a future API version. Use `count` to specify a number of - // payments instead.

+ // + // Deprecated: This field will be removed in a future API version. Use `count` + // to specify a number of payments instead. end_date?: string | null; // Unique identifier, beginning with "SB". @@ -7435,7 +7629,6 @@ export type Subscription = { // Name of the month on which to charge a customer. Must be lowercase. Only // applies // when the interval_unit is `yearly`. - // month?: `${SubscriptionMonth}`; // Optional name for the subscription. This will be set as the description on @@ -7449,41 +7642,42 @@ export type Subscription = { // payment // created and will appear on your customer's bank statement. See the // documentation for - // the [create payment endpoint](#payments-create-a-payment) for more details. - //
- //

Restricted: You need your own - // Service User Number to specify a payment reference for Bacs payments.

+ // the create payment endpoint + // (https://developer.gocardless.com/api-reference/#payments-create-a-payment) + // for more details. + // + // Restricted: You need your own Service User Number to specify a payment + // reference for Bacs payments. payment_reference?: string | null; - // On failure, automatically retry payments using [intelligent - // retries](/success-plus/overview). Default is `false`.

Important: To be able to use intelligent - // retries, Success+ needs to be enabled in [GoCardless - // dashboard](https://manage.gocardless.com/success-plus).

+ // On failure, automatically retry payments using intelligent retries + // (https://developer.gocardless.com/success-plus/overview). Default is + // `false`. Important: To be able to use intelligent retries, Success+ needs + // to be enabled in GoCardless dashboard + // (https://manage.gocardless.com/success-plus). retry_if_possible?: boolean; // The date on which the first payment should be charged. Must be on or after - // the [mandate](#core-endpoints-mandates)'s `next_possible_charge_date`. When - // left blank and `month` or `day_of_month` are provided, this will be set to - // the date of the first payment. If created without `month` or `day_of_month` - // this will be set as the mandate's `next_possible_charge_date` + // the mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates)'s + // `next_possible_charge_date`. When left blank and `month` or `day_of_month` + // are provided, this will be set to the date of the first payment. If created + // without `month` or `day_of_month` this will be set as the mandate's + // `next_possible_charge_date` start_date?: string | null; // One of: - // + // + // - `pending_customer_approval`: the subscription is waiting for customer + // approval before becoming active + // - `customer_approval_denied`: the customer did not approve the subscription + // - `active`: the subscription is currently active and will continue to + // create payments + // - `finished`: all of the payments scheduled for creation under this + // subscription have been created + // - `cancelled`: the subscription has been cancelled and will no longer + // create payments + // - `paused`: the subscription has been paused and will not create payments status?: `${SubscriptionStatus}`; // Up to 10 upcoming payments with their amounts and charge dates. @@ -7498,8 +7692,9 @@ export enum SubscriptionIntervalUnit { /** Type for a subscriptioncreaterequestlinks resource. */ export type SubscriptionCreateRequestLinks = { - // ID of the associated [mandate](#core-endpoints-mandates) which the - // subscription will create payments against. + // ID of the associated mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // which the subscription will create payments against. mandate: string; }; @@ -7520,8 +7715,9 @@ export enum SubscriptionMonth { /** Type for a subscriptionlinks resource. */ export type SubscriptionLinks = { - // ID of the associated [mandate](#core-endpoints-mandates) which the - // subscription will create payments against. + // ID of the associated mandate + // (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) + // which the subscription will create payments against. mandate?: string; }; @@ -7587,8 +7783,8 @@ export type TransferredMandate = { /** Type for a transferredmandatelinks resource. */ export type TransferredMandateLinks = { - // The ID of the updated - // [customer_bank_account](#core-endpoints-customer-bank-accounts) + // The ID of the updated customer_bank_account + // (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts) customer_bank_account?: string; // The ID of the transferred mandate @@ -7636,7 +7832,8 @@ export type VerificationDetail = { /** Type for a verificationdetailcreaterequestlinks resource. */ export type VerificationDetailCreateRequestLinks = { - // ID of the associated [creditor](#core-endpoints-creditors). + // ID of the associated creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors). creditor: string; }; @@ -7645,8 +7842,8 @@ export type VerificationDetailDirector = { // The city of the person's address. city: string; - // [ISO 3166-1 alpha-2 - // code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) + // ISO 3166-1 alpha-2 code. + // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country_code: string; // The person's date of birth. @@ -7667,14 +7864,16 @@ export type VerificationDetailDirector = { /** Type for a verificationdetaillinks resource. */ export type VerificationDetailLinks = { - // ID of the [creditor](#core-endpoints-creditors) + // ID of the creditor + // (https://developer.gocardless.com/api-reference/#core-endpoints-creditors) creditor?: string; }; /** Type for a webhook resource. */ export type Webhook = { - // Fixed [timestamp](#api-usage-dates-and-times), recording when this resource - // was created. + // Fixed timestamp + // (https://developer.gocardless.com/api-reference/#api-usage-dates-and-times), + // recording when this resource was created. created_at?: string; // Unique identifier, beginning with "WB". From 115004b2190aac1fbc788129429142441022cc0d Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Tue, 21 Jul 2026 09:49:53 +0000 Subject: [PATCH 18/35] Changes generated by 0447966dbc7deb4a368eb115ca363fe1cfcfbd16 This commit was automatically created from gocardless/client-library-templates@0447966dbc7deb4a368eb115ca363fe1cfcfbd16 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/29819672656 --- package-lock.json | 12 ++++++------ src/types/Types.ts | 4 ++++ 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index ebadd206..aa011ca9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2486,9 +2486,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.10.43", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.43.tgz", - "integrity": "sha512-AjYpR78kDWAY3Efj+cDTFH9t9SCoL7OoTp1BOb0mQV7S+6CiLwnWM3FyxhJtdPufDFKzmCSFoUncKjWgJEZTCQ==", + "version": "2.10.44", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.44.tgz", + "integrity": "sha512-T3ghW+sl/ZJ8w1v/yQx3qvJ9040DWoLBz8JT/CILbAKcFyG9b2MRe75v6W5uXjv6uH1lumK2Kv46y2zSkcej0Q==", "dev": true, "license": "Apache-2.0", "bin": { @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.393", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.393.tgz", - "integrity": "sha512-kiDJdIUawuEIcp9XoICKp1iTYDEbgguIPq526N1Q7jIQDeQ3CqoMx71025PI/7E48Ddtw2HuWsVjY7afEgNxmg==", + "version": "1.5.394", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.394.tgz", + "integrity": "sha512-Wmt2Gm0o8JWBuGgmc4XZ0u9s1RaCRqhxP47phplmfg04+qypTUurpeJGP45A7Fhv7jdrrVH44PLlR9qXo37cVQ==", "dev": true, "license": "ISC" }, diff --git a/src/types/Types.ts b/src/types/Types.ts index 7c1388b4..2e001f20 100644 --- a/src/types/Types.ts +++ b/src/types/Types.ts @@ -4973,6 +4973,10 @@ export type Institution = { // A human readable name for this institution name?: string; + // The roles assigned to this institution, representing the open banking + // features it supports. + roles?: string[]; + // The status of the institution status?: `${InstitutionStatus}`; }; From 15c82b195c759f82e0b3b70c22be34cf2aa0a6db Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Tue, 21 Jul 2026 09:58:37 +0000 Subject: [PATCH 19/35] Changes generated by d044d660596f0b07477534a07153e6117105c550 This commit was automatically created from gocardless/client-library-templates@d044d660596f0b07477534a07153e6117105c550 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/29820258838 --- src/services/paymentService.ts | 4 ++++ src/types/Types.ts | 16 ++++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/src/services/paymentService.ts b/src/services/paymentService.ts index a583a179..9de9e97d 100644 --- a/src/services/paymentService.ts +++ b/src/services/paymentService.ts @@ -12,6 +12,10 @@ interface PaymentCreateRequest { // Amount, in the lowest denomination for the currency (e.g. pence in GBP, cents // in EUR). // + // Minimum and maximum amounts vary by payment scheme. For more information, see + // Transaction limits + // (https://support.gocardless.com/hc/en-gb/articles/115000309245-Transaction-limits) + // // For Variable Recurring Payments (VRP), this must not exceed the mandate's // `max_amount_per_payment` // constraint. diff --git a/src/types/Types.ts b/src/types/Types.ts index 2e001f20..af927c8d 100644 --- a/src/types/Types.ts +++ b/src/types/Types.ts @@ -704,6 +704,10 @@ export type BillingRequestInstalmentScheduleRequestInstalmentsWithDate = { // Amount, in the lowest denomination for the currency (e.g. pence in GBP, // cents in EUR). // + // Minimum and maximum amounts vary by payment scheme. For more information, + // see Transaction limits + // (https://support.gocardless.com/hc/en-gb/articles/115000309245-Transaction-limits) + // // For Variable Recurring Payments (VRP), this must not exceed the mandate's // `max_amount_per_payment` // constraint. @@ -2899,6 +2903,10 @@ export type BillingRequestWithActionBillingRequestsInstalmentScheduleRequestInst // Amount, in the lowest denomination for the currency (e.g. pence in GBP, // cents in EUR). // + // Minimum and maximum amounts vary by payment scheme. For more information, + // see Transaction limits + // (https://support.gocardless.com/hc/en-gb/articles/115000309245-Transaction-limits) + // // For Variable Recurring Payments (VRP), this must not exceed the mandate's // `max_amount_per_payment` // constraint. @@ -4854,6 +4862,10 @@ export type InstalmentScheduleInstalment = { // Amount, in the lowest denomination for the currency (e.g. pence in GBP, // cents in EUR). // + // Minimum and maximum amounts vary by payment scheme. For more information, + // see Transaction limits + // (https://support.gocardless.com/hc/en-gb/articles/115000309245-Transaction-limits) + // // For Variable Recurring Payments (VRP), this must not exceed the mandate's // `max_amount_per_payment` // constraint. @@ -6267,6 +6279,10 @@ export type Payment = { // Amount, in the lowest denomination for the currency (e.g. pence in GBP, // cents in EUR). // + // Minimum and maximum amounts vary by payment scheme. For more information, + // see Transaction limits + // (https://support.gocardless.com/hc/en-gb/articles/115000309245-Transaction-limits) + // // For Variable Recurring Payments (VRP), this must not exceed the mandate's // `max_amount_per_payment` // constraint. From 154fe85ec827f716aa693fc3cc7457268b34109d Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Tue, 21 Jul 2026 10:27:17 +0000 Subject: [PATCH 20/35] Changes generated by 9d9ff143689ee009c9124b148c0c3d597e5060c2 This commit was automatically created from gocardless/client-library-templates@9d9ff143689ee009c9124b148c0c3d597e5060c2 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/29822141974 --- src/codeSamples/customer_notificationsCodeSamples.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/codeSamples/customer_notificationsCodeSamples.test.ts b/src/codeSamples/customer_notificationsCodeSamples.test.ts index 43f1b87a..75a9c1d3 100644 --- a/src/codeSamples/customer_notificationsCodeSamples.test.ts +++ b/src/codeSamples/customer_notificationsCodeSamples.test.ts @@ -50,7 +50,7 @@ describe('CustomerNotifications Code Samples', () => { try { /* eslint-disable @typescript-eslint/no-unused-vars */ - const customerNotification = await client.customerNotifications.handle('PCN123'); + const customerNotification = await client.customerNotifications.handle('EV1D18JEXAMPLE'); /* eslint-enable @typescript-eslint/no-unused-vars */ } finally { console.log = originalLog; From 7b3264c9486408c87d9d8506f752a4831300c4dc Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Tue, 21 Jul 2026 15:48:45 +0000 Subject: [PATCH 21/35] Changes generated by d04d13533e73443cc9fbdd517d1bb1af7ef7dca0 This commit was automatically created from gocardless/client-library-templates@d04d13533e73443cc9fbdd517d1bb1af7ef7dca0 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/29845565439 --- package-lock.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index aa011ca9..be47cb1f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2486,9 +2486,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.10.44", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.44.tgz", - "integrity": "sha512-T3ghW+sl/ZJ8w1v/yQx3qvJ9040DWoLBz8JT/CILbAKcFyG9b2MRe75v6W5uXjv6uH1lumK2Kv46y2zSkcej0Q==", + "version": "2.11.0", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.11.0.tgz", + "integrity": "sha512-oCu2wfipvX3AePSgmOuKkIywOu+8n9psz7hXYmk56ghpu3+7KzNIBopaOs4c9BrtdnTtW30unG9GTfHo7EwERQ==", "dev": true, "license": "Apache-2.0", "bin": { @@ -6317,9 +6317,9 @@ }, "node_modules/react-is-19": { "name": "react-is", - "version": "19.2.7", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-19.2.7.tgz", - "integrity": "sha512-kZFnouyVv7eP/Phmrlo9FK+zcAdriZJvzxXHF1Sl1P377WSGe2G/JxVolhTrB/jeV47lKImhNUsijjHAAbcl/A==", + "version": "19.2.8", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-19.2.8.tgz", + "integrity": "sha512-s5un28nYxKJw5gvUHyW5PCC28CvBqLu9r3cWgzHT4Vo/5fqqkFcdRYsGcKf50WMPpjjFZS5d76fn3YCo2njKwQ==", "dev": true, "license": "MIT" }, From a0958bdbd072775644b6057d3484e68197993d38 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Wed, 22 Jul 2026 09:47:36 +0000 Subject: [PATCH 22/35] Changes generated by cbdb1176040df91bbf75b91b2ce6017da8735321 This commit was automatically created from gocardless/client-library-templates@cbdb1176040df91bbf75b91b2ce6017da8735321 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/29909223763 --- package-lock.json | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index be47cb1f..171e6fce 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2530,9 +2530,9 @@ } }, "node_modules/browserslist": { - "version": "4.28.6", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.6.tgz", - "integrity": "sha512-FQBYNK15VMslhLHpA7+n+n1GOlF1kId2xcCg7/j95f24AOF6VDYMNH4mFxF7KuaTdv627faazpOAjFzMrfJOUw==", + "version": "4.28.7", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.7.tgz", + "integrity": "sha512-JxV13hNrFxqjOc8alRbq9dK1MM79NEXYpma2B2J4wAtpWS5zIEIKqWPGCl7N4o7Uc7B7itylh7SuDujATRyyTw==", "dev": true, "funding": [ { @@ -2550,9 +2550,9 @@ ], "license": "MIT", "dependencies": { - "baseline-browser-mapping": "^2.10.42", - "caniuse-lite": "^1.0.30001803", - "electron-to-chromium": "^1.5.389", + "baseline-browser-mapping": "^2.10.44", + "caniuse-lite": "^1.0.30001806", + "electron-to-chromium": "^1.5.393", "node-releases": "^2.0.51", "update-browserslist-db": "^1.2.3" }, @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.394", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.394.tgz", - "integrity": "sha512-Wmt2Gm0o8JWBuGgmc4XZ0u9s1RaCRqhxP47phplmfg04+qypTUurpeJGP45A7Fhv7jdrrVH44PLlR9qXo37cVQ==", + "version": "1.5.395", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.395.tgz", + "integrity": "sha512-7zt9Aw+SrmxLWLN0zhaTWZQiCdryLVrYTq5R7iZakLvi2UQPYMMsROYV/2qVCzMeCiSXHwKOU+sZ4zOVVlrtKA==", "dev": true, "license": "ISC" }, From 7165392142755ef9eefc7aba64d827e4449a4969 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Wed, 22 Jul 2026 12:35:03 +0000 Subject: [PATCH 23/35] Changes generated by 4efc71f5d8725e38b85138803842d0987be6b2b9 This commit was automatically created from gocardless/client-library-templates@4efc71f5d8725e38b85138803842d0987be6b2b9 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/29920062240 --- package-lock.json | 70 +++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 61 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index 171e6fce..b63e1c71 100644 --- a/package-lock.json +++ b/package-lock.json @@ -584,16 +584,16 @@ } }, "node_modules/@eslint-community/eslint-utils": { - "version": "4.9.1", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.9.1.tgz", - "integrity": "sha512-phrYmNiYppR7znFEdqgfWHXR6NCkZEK7hwWDHZUjit/2/U0r6XvkDl0SYnoM51Hq7FhCGdLDT6zxCCOY1hexsQ==", + "version": "4.10.0", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.10.0.tgz", + "integrity": "sha512-rd6n9Sefya1R1Vd594TRwzeHq2VnmICbvh3jebyt1Hs/6OoCSYNVpjGRRsKSTwAq3SKl09w0AfRCU57hoDLmxg==", "dev": true, "license": "MIT", "dependencies": { - "eslint-visitor-keys": "^3.4.3" + "eslint-visitor-keys": "^5.0.1" }, "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + "node": "^20.19.0 || ^22.13.0 || >=24" }, "funding": { "url": "https://opencollective.com/eslint" @@ -1910,6 +1910,19 @@ "url": "https://opencollective.com/typescript-eslint" } }, + "node_modules/@typescript-eslint/visitor-keys/node_modules/eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, "node_modules/@ungap/structured-clone": { "version": "1.3.3", "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.3.tgz", @@ -3307,13 +3320,13 @@ } }, "node_modules/eslint-visitor-keys": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", - "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-5.0.1.tgz", + "integrity": "sha512-tD40eHxA35h0PEIZNeIjkHoDR4YjjJp34biM0mDvplBe//mB+IHCqHDGV7pxF+7MklTvighcCPPZC7ynWyjdTA==", "dev": true, "license": "Apache-2.0", "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + "node": "^20.19.0 || ^22.13.0 || >=24" }, "funding": { "url": "https://opencollective.com/eslint" @@ -3336,6 +3349,19 @@ "url": "https://opencollective.com/eslint" } }, + "node_modules/eslint/node_modules/eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, "node_modules/eslint/node_modules/estraverse": { "version": "5.3.0", "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", @@ -3364,6 +3390,19 @@ "url": "https://opencollective.com/eslint" } }, + "node_modules/espree/node_modules/eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, "node_modules/esprima": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", @@ -7230,6 +7269,19 @@ "url": "https://opencollective.com/eslint" } }, + "node_modules/vue-eslint-parser/node_modules/eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, "node_modules/vue-eslint-parser/node_modules/estraverse": { "version": "5.3.0", "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", From 4c72d582db65a5a8aad1c035bb5c7efbb68c7c6b Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Thu, 23 Jul 2026 11:52:08 +0000 Subject: [PATCH 24/35] Changes generated by cab4c6d4f4714865da64e55cc2cfce31ce27171a This commit was automatically created from gocardless/client-library-templates@cab4c6d4f4714865da64e55cc2cfce31ce27171a by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/30004607834 --- package-lock.json | 82 ++++++----------------------- src/services/paymentService.ts | 2 +- src/services/refundService.ts | 2 +- src/services/subscriptionService.ts | 4 +- src/types/Types.ts | 27 +++++----- 5 files changed, 32 insertions(+), 85 deletions(-) diff --git a/package-lock.json b/package-lock.json index b63e1c71..71d29fb8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -584,16 +584,16 @@ } }, "node_modules/@eslint-community/eslint-utils": { - "version": "4.10.0", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.10.0.tgz", - "integrity": "sha512-rd6n9Sefya1R1Vd594TRwzeHq2VnmICbvh3jebyt1Hs/6OoCSYNVpjGRRsKSTwAq3SKl09w0AfRCU57hoDLmxg==", + "version": "4.10.1", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.10.1.tgz", + "integrity": "sha512-cuadcxVFE8sDK6iWJbs8Sn0av2Nrh2QSGQhVlBW9AaAHqHwjWsZHT8LJ4hFGPh7ASBV2deFdM7H/DPjulmh8rg==", "dev": true, "license": "MIT", "dependencies": { - "eslint-visitor-keys": "^5.0.1" + "eslint-visitor-keys": "^3.4.3" }, "engines": { - "node": "^20.19.0 || ^22.13.0 || >=24" + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" }, "funding": { "url": "https://opencollective.com/eslint" @@ -1910,19 +1910,6 @@ "url": "https://opencollective.com/typescript-eslint" } }, - "node_modules/@typescript-eslint/visitor-keys/node_modules/eslint-visitor-keys": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", - "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, "node_modules/@ungap/structured-clone": { "version": "1.3.3", "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.3.tgz", @@ -2499,9 +2486,9 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.11.0", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.11.0.tgz", - "integrity": "sha512-oCu2wfipvX3AePSgmOuKkIywOu+8n9psz7hXYmk56ghpu3+7KzNIBopaOs4c9BrtdnTtW30unG9GTfHo7EwERQ==", + "version": "2.11.1", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.11.1.tgz", + "integrity": "sha512-HYXq73DDpCtNzOmrFsm9eSwCvWCql0RzqjpDzXN9EadiLJ4DNat0nsZ/Bzmy+Ud12mb4/zKDY0cQ805ZzN+i0A==", "dev": true, "license": "Apache-2.0", "bin": { @@ -3320,13 +3307,13 @@ } }, "node_modules/eslint-visitor-keys": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-5.0.1.tgz", - "integrity": "sha512-tD40eHxA35h0PEIZNeIjkHoDR4YjjJp34biM0mDvplBe//mB+IHCqHDGV7pxF+7MklTvighcCPPZC7ynWyjdTA==", + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", "dev": true, "license": "Apache-2.0", "engines": { - "node": "^20.19.0 || ^22.13.0 || >=24" + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" }, "funding": { "url": "https://opencollective.com/eslint" @@ -3349,19 +3336,6 @@ "url": "https://opencollective.com/eslint" } }, - "node_modules/eslint/node_modules/eslint-visitor-keys": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", - "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, "node_modules/eslint/node_modules/estraverse": { "version": "5.3.0", "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", @@ -3390,19 +3364,6 @@ "url": "https://opencollective.com/eslint" } }, - "node_modules/espree/node_modules/eslint-visitor-keys": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", - "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, "node_modules/esprima": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", @@ -3692,9 +3653,9 @@ } }, "node_modules/flatted": { - "version": "3.4.2", - "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.4.2.tgz", - "integrity": "sha512-PjDse7RzhcPkIJwy5t7KPWQSZ9cAbzQXcafsetQoD7sOJRQlGikNbx7yZp2OotDnJyrDcbyRq3Ttb18iYOqkxA==", + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.4.3.tgz", + "integrity": "sha512-/zipXxyO6rGvuNGDiULY9MvEGSkb2gaG4GGH4ygMi0ZZzyMHdUZBmntJmx5x1G2VuPytCwGN4xsJP6cw+sK+vQ==", "dev": true, "license": "ISC" }, @@ -7269,19 +7230,6 @@ "url": "https://opencollective.com/eslint" } }, - "node_modules/vue-eslint-parser/node_modules/eslint-visitor-keys": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", - "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, "node_modules/vue-eslint-parser/node_modules/estraverse": { "version": "5.3.0", "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", diff --git a/src/services/paymentService.ts b/src/services/paymentService.ts index 9de9e97d..b37fc733 100644 --- a/src/services/paymentService.ts +++ b/src/services/paymentService.ts @@ -196,7 +196,7 @@ interface PaymentListRequest { // to the banks // - `submitted`: the payment has been submitted to the banks // - `confirmed`: the payment has been confirmed as collected - // - `paid_out`: the payment has been included in a payout + // - `paid_out`: the payment has been included in a payout // (https://developer.gocardless.com/api-reference/#core-endpoints-payouts) // - `cancelled`: the payment has been cancelled // - `customer_approval_denied`: the customer has denied approval for the diff --git a/src/services/refundService.ts b/src/services/refundService.ts index dba49710..cb1d7498 100644 --- a/src/services/refundService.ts +++ b/src/services/refundService.ts @@ -70,7 +70,7 @@ interface RefundCreateRequest { // // Must be supplied if `links[payment]` is present. // - // It is possible to opt out of requiring `total_amount_confirmation`, please + // It is possible to opt out of requiring total_amount_confirmation, please // contact our support team (mailto:support@gocardless.com) for more // information. diff --git a/src/services/subscriptionService.ts b/src/services/subscriptionService.ts index 9206fa8e..7f37edaa 100644 --- a/src/services/subscriptionService.ts +++ b/src/services/subscriptionService.ts @@ -40,8 +40,8 @@ interface SubscriptionCreateRequest { // If this field is blank and `count` is not specified, the subscription will // continue forever. // - // Deprecated: This field will be removed in a future API version. Use `count` - // to specify a number of payments instead. + // Deprecated: This field will be removed in a future API version. Use count to + // specify a number of payments instead. end_date?: string; diff --git a/src/types/Types.ts b/src/types/Types.ts index af927c8d..608b1547 100644 --- a/src/types/Types.ts +++ b/src/types/Types.ts @@ -8,17 +8,17 @@ export type Balance = { // Type of the balance. Could be one of // - // - pending_payments_submitted: Payments we have submitted to the scheme but - // not yet confirmed. This does not exactly correspond to Pending payments in - // the dashboard, because this balance does not include payments that are + // - `pending_payments_submitted`: Payments we have submitted to the scheme + // but not yet confirmed. This does not exactly correspond to Pending payments + // in the dashboard, because this balance does not include payments that are // pending submission. - // - confirmed_funds: Payments that have been confirmed minus fees and + // - `confirmed_funds`: Payments that have been confirmed minus fees and // unclaimed debits for refunds, failures and chargebacks. These funds have // not yet been moved into a payout. - // - pending_payouts: Confirmed payments that have been moved into a payout. + // - `pending_payouts`: Confirmed payments that have been moved into a payout. // This is the total due to be paid into your bank account in the next payout // run (payouts happen once every business day). - // pending_payouts will only be non-zero while we are generating and + // `pending_payouts` will only be non-zero while we are generating and // submitting the payouts to our partner bank. balance_type?: `${BalanceBalanceType}`; @@ -100,7 +100,7 @@ export type BankAccountHolderVerification = { // // - `full_match`: The verification has confirmed that the account name // exactly matches the details provided. - // - `partial_match`: The verification has confirmed that the account name is + // - `partial_match`: The verification has confirmed that the account name is // similar but does not match to the details provided. // - `no_match`: The verification concludes the provided name does not match // the account details. @@ -247,8 +247,8 @@ export type BankDetailsLookup = { // ISO 9362 SWIFT BIC of the bank with which the account is held. // // Even if no BIC is returned for an account, GoCardless may still be able to - // collect payments from it - you should refer to the - // `available_debit_schemes` attribute to determine reachability. + // collect payments from it - you should refer to the available_debit_schemes + // attribute to determine reachability. bic?: string | null; }; @@ -5763,7 +5763,7 @@ export type OutboundPaymentVerificationsRecipientBankAccountHolderVerification = // // - `full_match`: The verification has confirmed that the account name // exactly matches the details provided. - // - `partial_match`: The verification has confirmed that the account name is + // - `partial_match`: The verification has confirmed that the account name is // similar but does not match to the details provided. // - `no_match`: The verification concludes the provided name does not match // the account details. @@ -6398,7 +6398,7 @@ export type Payment = { // to the banks // - `submitted`: the payment has been submitted to the banks // - `confirmed`: the payment has been confirmed as collected - // - `paid_out`: the payment has been included in a payout + // - `paid_out`: the payment has been included in a payout // (https://developer.gocardless.com/api-reference/#core-endpoints-payouts) // - `cancelled`: the payment has been cancelled // - `customer_approval_denied`: the customer has denied approval for the @@ -6656,8 +6656,7 @@ export type Payout = { // One of: // // - `yyyy-mm-dd`: the payout has been paid and is due to arrive in the - // creditor's bank - // account on this day + // creditor's bank account on this day // - `null`: the payout hasn't been paid yet arrival_date?: string | null; @@ -7623,7 +7622,7 @@ export type Subscription = { // If this field is blank and `count` is not specified, the subscription will // continue forever. // - // Deprecated: This field will be removed in a future API version. Use `count` + // Deprecated: This field will be removed in a future API version. Use count // to specify a number of payments instead. end_date?: string | null; From d794209fbb3b3efd5ebf28942479c9e55487d2e9 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Thu, 23 Jul 2026 12:45:11 +0000 Subject: [PATCH 25/35] Changes generated by 1899be18c1848fbb0a1893d952c7c9c310a36863 This commit was automatically created from gocardless/client-library-templates@1899be18c1848fbb0a1893d952c7c9c310a36863 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/30008088311 --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 71d29fb8..174d8631 100644 --- a/package-lock.json +++ b/package-lock.json @@ -20,7 +20,7 @@ "@typescript-eslint/parser": "^5.57.0", "eslint": "^8.37.0", "eslint-config-prettier": "^8.8.0", - "eslint-plugin-prettier": "^4.2.1", + "eslint-plugin-prettier": "^4.2.5", "jest": "^30.1.3", "nock": "^13.3.0", "prettier": "^2.8.7", diff --git a/package.json b/package.json index 245dbf25..7f1583a7 100644 --- a/package.json +++ b/package.json @@ -116,7 +116,7 @@ "@typescript-eslint/parser": "^5.57.0", "eslint": "^8.37.0", "eslint-config-prettier": "^8.8.0", - "eslint-plugin-prettier": "^4.2.1", + "eslint-plugin-prettier": "^4.2.5", "jest": "^30.1.3", "nock": "^13.3.0", "prettier": "^2.8.7", From 8326838340be640760e609c4d01d704507178162 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Thu, 23 Jul 2026 13:21:52 +0000 Subject: [PATCH 26/35] Changes generated by 5a2c05b58435dcab60bfeb60fa968abd21f238ea This commit was automatically created from gocardless/client-library-templates@5a2c05b58435dcab60bfeb60fa968abd21f238ea by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/30010716403 --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 174d8631..f5d19ac2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11,7 +11,7 @@ "dependencies": { "got": "^11.8.6", "qs": "^6.14.0", - "uuid": "^14.0.0" + "uuid": "^14.0.1" }, "devDependencies": { "@types/jest": "^30.0.0", diff --git a/package.json b/package.json index 7f1583a7..8b68702e 100644 --- a/package.json +++ b/package.json @@ -106,7 +106,7 @@ }, "dependencies": { "got": "^11.8.6", - "uuid": "^14.0.0", + "uuid": "^14.0.1", "qs": "^6.14.0" }, "devDependencies": { From c0fa7a4fab649a4703a941c770882fb3bb998de3 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Thu, 23 Jul 2026 13:23:25 +0000 Subject: [PATCH 27/35] Changes generated by c3b47f8fc53f52bc440af0710b9a37d85fda8e2c This commit was automatically created from gocardless/client-library-templates@c3b47f8fc53f52bc440af0710b9a37d85fda8e2c by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/30010809064 --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index f5d19ac2..2d80d00e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -23,7 +23,7 @@ "eslint-plugin-prettier": "^4.2.5", "jest": "^30.1.3", "nock": "^13.3.0", - "prettier": "^2.8.7", + "prettier": "^2.8.8", "prettier-eslint": "^15.0.1", "prettier-eslint-cli": "^7.1.0", "ts-jest": "29.4.1", diff --git a/package.json b/package.json index 8b68702e..0638abc7 100644 --- a/package.json +++ b/package.json @@ -119,7 +119,7 @@ "eslint-plugin-prettier": "^4.2.5", "jest": "^30.1.3", "nock": "^13.3.0", - "prettier": "^2.8.7", + "prettier": "^2.8.8", "prettier-eslint": "^15.0.1", "prettier-eslint-cli": "^7.1.0", "ts-jest": "29.4.1", From 7bd95a218dd001b7dc81da113f1ccbf7810eb6a5 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Thu, 23 Jul 2026 13:31:13 +0000 Subject: [PATCH 28/35] Changes generated by d0706728ca36e9450aee3ad33da6f1ee52d118bb This commit was automatically created from gocardless/client-library-templates@d0706728ca36e9450aee3ad33da6f1ee52d118bb by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/30011386856 --- package-lock.json | 14 +++++++------- package.json | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/package-lock.json b/package-lock.json index 2d80d00e..82e5d408 100644 --- a/package-lock.json +++ b/package-lock.json @@ -26,7 +26,7 @@ "prettier": "^2.8.8", "prettier-eslint": "^15.0.1", "prettier-eslint-cli": "^7.1.0", - "ts-jest": "29.4.1", + "ts-jest": "29.4.12", "typescript": "^5.0.2" }, "engines": { @@ -6916,19 +6916,19 @@ } }, "node_modules/ts-jest": { - "version": "29.4.1", - "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-29.4.1.tgz", - "integrity": "sha512-SaeUtjfpg9Uqu8IbeDKtdaS0g8lS6FT6OzM3ezrDfErPJPHNDo/Ey+VFGP1bQIDfagYDLyRpd7O15XpG1Es2Uw==", + "version": "29.4.12", + "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-29.4.12.tgz", + "integrity": "sha512-Ov6ClY53Fflh6BGAnY2DlTq1hYDrTycz2PVTXBWFW2CU+9zrEqAp9fWdGXl42EXO5RLSFAcAZ2JFKbP+zBTFfw==", "dev": true, "license": "MIT", "dependencies": { "bs-logger": "^0.2.6", "fast-json-stable-stringify": "^2.1.0", - "handlebars": "^4.7.8", + "handlebars": "^4.7.9", "json5": "^2.2.3", "lodash.memoize": "^4.1.2", "make-error": "^1.3.6", - "semver": "^7.7.2", + "semver": "^7.8.5", "type-fest": "^4.41.0", "yargs-parser": "^21.1.1" }, @@ -6945,7 +6945,7 @@ "babel-jest": "^29.0.0 || ^30.0.0", "jest": "^29.0.0 || ^30.0.0", "jest-util": "^29.0.0 || ^30.0.0", - "typescript": ">=4.3 <6" + "typescript": ">=4.3 <7" }, "peerDependenciesMeta": { "@babel/core": { diff --git a/package.json b/package.json index 0638abc7..7f2163a6 100644 --- a/package.json +++ b/package.json @@ -122,7 +122,7 @@ "prettier": "^2.8.8", "prettier-eslint": "^15.0.1", "prettier-eslint-cli": "^7.1.0", - "ts-jest": "29.4.1", + "ts-jest": "29.4.12", "typescript": "^5.0.2" }, "files": [ From 5b36dbe35c7c1f627e4a8fb9e5efe2696b021686 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Thu, 23 Jul 2026 14:53:58 +0000 Subject: [PATCH 29/35] Changes generated by fd283046d9270578572fb7d19e5863f682a14138 This commit was automatically created from gocardless/client-library-templates@fd283046d9270578572fb7d19e5863f682a14138 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/30017791196 --- package-lock.json | 16 ++++++++-------- package.json | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index 82e5d408..3783a117 100644 --- a/package-lock.json +++ b/package-lock.json @@ -15,7 +15,7 @@ }, "devDependencies": { "@types/jest": "^30.0.0", - "@types/node": "^18.15.10", + "@types/node": "^22.14.1", "@typescript-eslint/eslint-plugin": "^5.57.0", "@typescript-eslint/parser": "^5.57.0", "eslint": "^8.37.0", @@ -1659,12 +1659,12 @@ } }, "node_modules/@types/node": { - "version": "18.19.130", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.130.tgz", - "integrity": "sha512-GRaXQx6jGfL8sKfaIDD6OupbIHBr9jv7Jnaml9tB7l4v068PAOXqfcujMMo5PhbIs6ggR1XODELqahT2R8v0fg==", + "version": "22.20.1", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.20.1.tgz", + "integrity": "sha512-EANqOCF9QFyra+4pfxUcX9STKJpCLjMbObVzljIJomAWSnuSIEAvyzEU53GaajbXJEgdh0iEcPL+DGvpUd4k1Q==", "license": "MIT", "dependencies": { - "undici-types": "~5.26.4" + "undici-types": "~6.21.0" } }, "node_modules/@types/prettier": { @@ -7076,9 +7076,9 @@ } }, "node_modules/undici-types": { - "version": "5.26.5", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz", - "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==", + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz", + "integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==", "license": "MIT" }, "node_modules/unrs-resolver": { diff --git a/package.json b/package.json index 7f2163a6..aecb950e 100644 --- a/package.json +++ b/package.json @@ -111,7 +111,7 @@ }, "devDependencies": { "@types/jest": "^30.0.0", - "@types/node": "^18.15.10", + "@types/node": "^22.14.1", "@typescript-eslint/eslint-plugin": "^5.57.0", "@typescript-eslint/parser": "^5.57.0", "eslint": "^8.37.0", From 91b8c3cd49bf700bf085bc5dabf6638cdce5958e Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Thu, 23 Jul 2026 17:27:12 +0000 Subject: [PATCH 30/35] Changes generated by ec8db205e44def5843c145af7fe132edd66f9bcc This commit was automatically created from gocardless/client-library-templates@ec8db205e44def5843c145af7fe132edd66f9bcc by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/30029307352 --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 3783a117..92ab501d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "license": "MIT", "dependencies": { "got": "^11.8.6", - "qs": "^6.14.0", + "qs": "^6.15.3", "uuid": "^14.0.1" }, "devDependencies": { diff --git a/package.json b/package.json index aecb950e..bba10201 100644 --- a/package.json +++ b/package.json @@ -107,7 +107,7 @@ "dependencies": { "got": "^11.8.6", "uuid": "^14.0.1", - "qs": "^6.14.0" + "qs": "^6.15.3" }, "devDependencies": { "@types/jest": "^30.0.0", From 15d8317385bb7bb70d4d7a07932af798b2c107e6 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Thu, 23 Jul 2026 17:38:11 +0000 Subject: [PATCH 31/35] Changes generated by d85c316b72a38bb46906b88b7574824f2195bafe This commit was automatically created from gocardless/client-library-templates@d85c316b72a38bb46906b88b7574824f2195bafe by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/30030102903 --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 92ab501d..1851cc4b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -18,7 +18,7 @@ "@types/node": "^22.14.1", "@typescript-eslint/eslint-plugin": "^5.57.0", "@typescript-eslint/parser": "^5.57.0", - "eslint": "^8.37.0", + "eslint": "^8.57.1", "eslint-config-prettier": "^8.8.0", "eslint-plugin-prettier": "^4.2.5", "jest": "^30.1.3", diff --git a/package.json b/package.json index bba10201..ddda4d0b 100644 --- a/package.json +++ b/package.json @@ -114,7 +114,7 @@ "@types/node": "^22.14.1", "@typescript-eslint/eslint-plugin": "^5.57.0", "@typescript-eslint/parser": "^5.57.0", - "eslint": "^8.37.0", + "eslint": "^8.57.1", "eslint-config-prettier": "^8.8.0", "eslint-plugin-prettier": "^4.2.5", "jest": "^30.1.3", From 05d0572922505406ebaea78b3ae541753dfd5e11 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Fri, 24 Jul 2026 08:48:35 +0000 Subject: [PATCH 32/35] Changes generated by dedbbc7f88bf7026f0f91bcfa80de14367f1246b This commit was automatically created from gocardless/client-library-templates@dedbbc7f88bf7026f0f91bcfa80de14367f1246b by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/30080095606 --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 1851cc4b..7f55b60b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3102,9 +3102,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.395", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.395.tgz", - "integrity": "sha512-7zt9Aw+SrmxLWLN0zhaTWZQiCdryLVrYTq5R7iZakLvi2UQPYMMsROYV/2qVCzMeCiSXHwKOU+sZ4zOVVlrtKA==", + "version": "1.5.396", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.396.tgz", + "integrity": "sha512-yHiw2Y3C3H9U6TMbOfoWK/BPreiOPXRfTWPBwQBoZG6/8TB6eOPnsy5oaRYuatR7Fw2SJ4kKforgufeo7fq0EQ==", "dev": true, "license": "ISC" }, From c9a961b64fbf95fe99a0747e2e73e99a148ecfbe Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Fri, 24 Jul 2026 11:23:03 +0000 Subject: [PATCH 33/35] Changes generated by f3b869ed6a61a3305c2e172de8fcc754ee5ed69b This commit was automatically created from gocardless/client-library-templates@f3b869ed6a61a3305c2e172de8fcc754ee5ed69b by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/30089227446 --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7f55b60b..b8121643 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22,7 +22,7 @@ "eslint-config-prettier": "^8.8.0", "eslint-plugin-prettier": "^4.2.5", "jest": "^30.1.3", - "nock": "^13.3.0", + "nock": "^13.5.6", "prettier": "^2.8.8", "prettier-eslint": "^15.0.1", "prettier-eslint-cli": "^7.1.0", diff --git a/package.json b/package.json index ddda4d0b..266900e8 100644 --- a/package.json +++ b/package.json @@ -118,7 +118,7 @@ "eslint-config-prettier": "^8.8.0", "eslint-plugin-prettier": "^4.2.5", "jest": "^30.1.3", - "nock": "^13.3.0", + "nock": "^13.5.6", "prettier": "^2.8.8", "prettier-eslint": "^15.0.1", "prettier-eslint-cli": "^7.1.0", From c0b5550c83ece2e6f334913bc6c0e5572ef565a2 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Fri, 24 Jul 2026 11:34:42 +0000 Subject: [PATCH 34/35] Changes generated by 900b4196505df0c745b66f73625357edbd72b3ba This commit was automatically created from gocardless/client-library-templates@900b4196505df0c745b66f73625357edbd72b3ba by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/30089908001 --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index b8121643..c0a0968f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -21,7 +21,7 @@ "eslint": "^8.57.1", "eslint-config-prettier": "^8.8.0", "eslint-plugin-prettier": "^4.2.5", - "jest": "^30.1.3", + "jest": "^30.4.2", "nock": "^13.5.6", "prettier": "^2.8.8", "prettier-eslint": "^15.0.1", diff --git a/package.json b/package.json index 266900e8..1ef21e63 100644 --- a/package.json +++ b/package.json @@ -117,7 +117,7 @@ "eslint": "^8.57.1", "eslint-config-prettier": "^8.8.0", "eslint-plugin-prettier": "^4.2.5", - "jest": "^30.1.3", + "jest": "^30.4.2", "nock": "^13.5.6", "prettier": "^2.8.8", "prettier-eslint": "^15.0.1", From fa807927990aa3c1df49f565671f389bac93b9f0 Mon Sep 17 00:00:00 2001 From: "gocardless-ci-robot[bot]" <123969075+gocardless-ci-robot[bot]@users.noreply.github.com> Date: Fri, 24 Jul 2026 12:18:55 +0000 Subject: [PATCH 35/35] Changes generated by a99ddd10e09fa210b1e27f28893d4bd2406dce57 This commit was automatically created from gocardless/client-library-templates@a99ddd10e09fa210b1e27f28893d4bd2406dce57 by the `push-files` action. Workflow run: https://github.com/gocardless/client-library-templates/actions/runs/30092488617 --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index c0a0968f..25c69c07 100644 --- a/package-lock.json +++ b/package-lock.json @@ -27,7 +27,7 @@ "prettier-eslint": "^15.0.1", "prettier-eslint-cli": "^7.1.0", "ts-jest": "29.4.12", - "typescript": "^5.0.2" + "typescript": "^5.9.3" }, "engines": { "node": ">=18.0" diff --git a/package.json b/package.json index 1ef21e63..e946371a 100644 --- a/package.json +++ b/package.json @@ -123,7 +123,7 @@ "prettier-eslint": "^15.0.1", "prettier-eslint-cli": "^7.1.0", "ts-jest": "29.4.12", - "typescript": "^5.0.2" + "typescript": "^5.9.3" }, "files": [ "esm/",