Qodex.ai
Qodex.ai
IntroductionAsk Anything
GoCardless
🚀 Getting Started-Step 1 - Taking a first instant payment with mandate set up
Initiate your Billing RequestCreate a Billing Request Flow
🚀 Getting Started-Step 2 - Collecting payments against a mandate
Retrieve a fulfilled Billing RequestCreate a Direct Debit Payment
🚀 Getting Started-Step 3 - Monitor Webhooks
List Events
🚀 Getting Started-Next steps-Explore global payment journeys
🇦🇺 PayTo Mandate
🚀 Getting Started-Next steps-Custom Payment Pages-Direct Debit
Create a Billing Request (Mandate)Collect Customer DetailsCollect Bank Account DetailsConfirm Customer & Bank Account DetailsFulfill a Billing RequestCreate a Payment
🚀 Getting Started-Next steps-Custom Payment Pages-Open Banking - Instant Bank Pay
Create an Instant Payment Billing RequestCollect Customer DetailsList Institutions for Billing RequestSelect Institution for a Billing RequestCreate a Bank AuthorisationGet a Billing Request
Billing Requests-Billing Requests-Billing Request Examples
PayTo Mandate and Payment
Billing Requests-Billing Requests
Create a Billing RequestCollect Customer DetailsCollect Bank Account DetailsConfirm Customer & Bank Account DetailsSelect Institution for a Billing RequestFulfill a Billing RequestCancel a Billing RequestTrigger FallbackChange Currency for a Billing RequestNotify Customer of Billing RequestList Billing RequestsGet a Billing Request
Billing Requests-Billing Request Flows
Create a Billing Request FlowInitialise a Billing Request Flow
Billing Requests-Bank Authorisations
Create a Bank AuthorisationGet Bank Authorisation
Billing Requests-Billing Request Templates
Create a Billing Request TemplateUpdate a Billing Request TemplateGet a Billing Request TemplateList Billing Request Templates
Billing Requests-Institutions
List Institutions for Billing Request
Core Endpoints-Block
Create a BlockCreate Blocks by ReferenceDisable a BlockEnable a BlockGet a BlockList Blocks
Core Endpoints-Creditors
Create a CreditorUpdate a CreditorList CreditorsGet a single Creditor
Core Endpoints-Customer Bank Accounts
Create a Customer Bank AccountUpdate a Customer Bank AccountList Customer Bank AccountsGet a single Customer Bank AccountDisable a Customer Bank Account
Core Endpoints-Currency Exchange Rates
List Currency Exchange
Core Endpoints-Customers
Create a CustomerUpdate a CustomerList CustomersGet a single CustomerRemove a Customer
Core Endpoints-Creditors Bank Accounts
Create a Creditor Bank AccountList Creditor Bank AccountsGet a single Creditor Bank AccountDisable a Creditor Bank Account
Core Endpoints-Customer Notifications
Handle a notification
Core Endpoints-Events
List EventsGet a single Event
Core Endpoints-Instalment Schedules
Create Instalment Schedules (with schedule)List Instalment SchedulesGet a Single Instalment SchedulesUpdate an Instalment ScheduleCancel an Instalment Schedule
Core Endpoints-Mandates
Create a MandateUpdate a MandateList MandatesGet a single MandateCancel a MandateReinstate a Mandate
Core Endpoints-Mandate Imports
Create New Mandate ImportSubmit Mandate ImportCancel Mandate ImportGet a Single Mandate import
Core Endpoints-Mandate Import Entries
Add Mandate import EntryList All Mandate Import Entries
Core Endpoints-Payer Authorisations (deprecated)
Create a Payer AuthorisationUpdate a Payer AuthorisationSubmit a Payer AuthorisationConfirm a Payer AuthorisationGet a Payer Authorisation
Core Endpoints-Payments
Create a PaymentUpdate a PaymentList PaymentsGet a single PaymentRetry PaymentCancel a Payment
Core Endpoints-Payouts
List PayoutsGet a single PayoutUpdate a Payout
Core Endpoints-Payout Items
List All Payout Items
Core Endpoints-Redirect Flows
Create a Redirect FlowComplete a single Redirect FlowGet a single Redirect Flow
Core Endpoints-Refunds
Create a RefundUpdate a RefundList RefundsGet a single Refund
Core Endpoints-Scenario Simulators
Billing Request Fulfilled ScenarioBilling Request Fulfilled & Payment Paid Out ScenarioBilling Request Fulfilled & Payment Failed ScenarioPayment Submitted ScenarioPayment Confirmed ScenarioPayment Paid Out ScenarioPayment Failed ScenarioPayment Charged Back ScenarioPayment Charged Back Settled ScenarioPayment Late Failure ScenarioPayment Late Failure Settled ScenarioMandate Activated ScenarioMandate Failed ScenarioMandate Expired ScenarioMandate Customer Approval Granted ScenarioMandate Customer Approval Skipped ScenarioMandate Transferred ScenarioMandate Transferred with Resubmission ScenarioRefund Paid ScenarioRefund Settled ScenarioRefund Bounced ScenarioRefund Returned ScenarioPayout Bounced ScenarioCreditor Verification Status Action Required ScenarioCreditor Verification Status in Review ScenarioCreditor Verification Status Successful Scenario
Core Endpoints-Scheme Identifiers
Create a Scheme IdentifierList Scheme IdentifiersGet a Scheme Identifier
Core Endpoints-Subscriptions
Create a SubscriptonUpdate a SubscriptionList SubscriptionsGet a single SubscriptionPause a SubscriptionCancel a SubscriptionResume a Subscription
Core Endpoints-Tax Rates
List Tax RatesGet a Single Tax Rate
Core Endpoints-Transferred Mandates
Get updated customer bank details
Core Endpoints-Webhooks
List WebhooksGet a WebhookRetry a Webhook
Helper Endpoints
Create a Mandate PDFBank Details LookupHealthcheck
Embed Flow-1. Creditors
Create a CreditorList CreditorsGet a single CreditorUpdate a Creditor
Embed Flow-2. (Optional) Creditors Bank Accounts
Create a Creditor Bank AccountList Creditor Bank AccountsGet a single Creditor Bank AccountDisable a Creditor Bank Account
Embed Flow-3. (Optional) Scheme Identifiers
Create a Scheme IdentifierList Scheme IdentifiersGet a Scheme Identifier
Embed Flow-4. Create Mandate & Payment
4.1 Create a Billing Request (Mandate)4.2 Collect Customer Details4.3 Collect Bank Account Details4.4 Confirm Customer & Bank Account Details4.5 Fulfill a Billing Request4.6 Create a Payment
Embed Flow-Branding-Logos
Create a logo
Embed Flow-Branding-PayerThemes
Create a Payer theme
Embed Flow-Exports
List ExportsGet Export
IntroductionAsk Anything
GoCardless
🚀 Getting Started-Step 1 - Taking a first instant payment with mandate set up
Initiate your Billing RequestCreate a Billing Request Flow
🚀 Getting Started-Step 2 - Collecting payments against a mandate
Retrieve a fulfilled Billing RequestCreate a Direct Debit Payment
🚀 Getting Started-Step 3 - Monitor Webhooks
List Events
🚀 Getting Started-Next steps-Explore global payment journeys
🇦🇺 PayTo Mandate
🚀 Getting Started-Next steps-Custom Payment Pages-Direct Debit
Create a Billing Request (Mandate)Collect Customer DetailsCollect Bank Account DetailsConfirm Customer & Bank Account DetailsFulfill a Billing RequestCreate a Payment
🚀 Getting Started-Next steps-Custom Payment Pages-Open Banking - Instant Bank Pay
Create an Instant Payment Billing RequestCollect Customer DetailsList Institutions for Billing RequestSelect Institution for a Billing RequestCreate a Bank AuthorisationGet a Billing Request
Billing Requests-Billing Requests-Billing Request Examples
PayTo Mandate and Payment
Billing Requests-Billing Requests
Create a Billing RequestCollect Customer DetailsCollect Bank Account DetailsConfirm Customer & Bank Account DetailsSelect Institution for a Billing RequestFulfill a Billing RequestCancel a Billing RequestTrigger FallbackChange Currency for a Billing RequestNotify Customer of Billing RequestList Billing RequestsGet a Billing Request
Billing Requests-Billing Request Flows
Create a Billing Request FlowInitialise a Billing Request Flow
Billing Requests-Bank Authorisations
Create a Bank AuthorisationGet Bank Authorisation
Billing Requests-Billing Request Templates
Create a Billing Request TemplateUpdate a Billing Request TemplateGet a Billing Request TemplateList Billing Request Templates
Billing Requests-Institutions
List Institutions for Billing Request
Core Endpoints-Block
Create a BlockCreate Blocks by ReferenceDisable a BlockEnable a BlockGet a BlockList Blocks
Core Endpoints-Creditors
Create a CreditorUpdate a CreditorList CreditorsGet a single Creditor
Core Endpoints-Customer Bank Accounts
Create a Customer Bank AccountUpdate a Customer Bank AccountList Customer Bank AccountsGet a single Customer Bank AccountDisable a Customer Bank Account
Core Endpoints-Currency Exchange Rates
List Currency Exchange
Core Endpoints-Customers
Create a CustomerUpdate a CustomerList CustomersGet a single CustomerRemove a Customer
Core Endpoints-Creditors Bank Accounts
Create a Creditor Bank AccountList Creditor Bank AccountsGet a single Creditor Bank AccountDisable a Creditor Bank Account
Core Endpoints-Customer Notifications
Handle a notification
Core Endpoints-Events
List EventsGet a single Event
Core Endpoints-Instalment Schedules
Create Instalment Schedules (with schedule)List Instalment SchedulesGet a Single Instalment SchedulesUpdate an Instalment ScheduleCancel an Instalment Schedule
Core Endpoints-Mandates
Create a MandateUpdate a MandateList MandatesGet a single MandateCancel a MandateReinstate a Mandate
Core Endpoints-Mandate Imports
Create New Mandate ImportSubmit Mandate ImportCancel Mandate ImportGet a Single Mandate import
Core Endpoints-Mandate Import Entries
Add Mandate import EntryList All Mandate Import Entries
Core Endpoints-Payer Authorisations (deprecated)
Create a Payer AuthorisationUpdate a Payer AuthorisationSubmit a Payer AuthorisationConfirm a Payer AuthorisationGet a Payer Authorisation
Core Endpoints-Payments
Create a PaymentUpdate a PaymentList PaymentsGet a single PaymentRetry PaymentCancel a Payment
Core Endpoints-Payouts
List PayoutsGet a single PayoutUpdate a Payout
Core Endpoints-Payout Items
List All Payout Items
Core Endpoints-Redirect Flows
Create a Redirect FlowComplete a single Redirect FlowGet a single Redirect Flow
Core Endpoints-Refunds
Create a RefundUpdate a RefundList RefundsGet a single Refund
Core Endpoints-Scenario Simulators
Billing Request Fulfilled ScenarioBilling Request Fulfilled & Payment Paid Out ScenarioBilling Request Fulfilled & Payment Failed ScenarioPayment Submitted ScenarioPayment Confirmed ScenarioPayment Paid Out ScenarioPayment Failed ScenarioPayment Charged Back ScenarioPayment Charged Back Settled ScenarioPayment Late Failure ScenarioPayment Late Failure Settled ScenarioMandate Activated ScenarioMandate Failed ScenarioMandate Expired ScenarioMandate Customer Approval Granted ScenarioMandate Customer Approval Skipped ScenarioMandate Transferred ScenarioMandate Transferred with Resubmission ScenarioRefund Paid ScenarioRefund Settled ScenarioRefund Bounced ScenarioRefund Returned ScenarioPayout Bounced ScenarioCreditor Verification Status Action Required ScenarioCreditor Verification Status in Review ScenarioCreditor Verification Status Successful Scenario
Core Endpoints-Scheme Identifiers
Create a Scheme IdentifierList Scheme IdentifiersGet a Scheme Identifier
Core Endpoints-Subscriptions
Create a SubscriptonUpdate a SubscriptionList SubscriptionsGet a single SubscriptionPause a SubscriptionCancel a SubscriptionResume a Subscription
Core Endpoints-Tax Rates
List Tax RatesGet a Single Tax Rate
Core Endpoints-Transferred Mandates
Get updated customer bank details
Core Endpoints-Webhooks
List WebhooksGet a WebhookRetry a Webhook
Helper Endpoints
Create a Mandate PDFBank Details LookupHealthcheck
Embed Flow-1. Creditors
Create a CreditorList CreditorsGet a single CreditorUpdate a Creditor
Embed Flow-2. (Optional) Creditors Bank Accounts
Create a Creditor Bank AccountList Creditor Bank AccountsGet a single Creditor Bank AccountDisable a Creditor Bank Account
Embed Flow-3. (Optional) Scheme Identifiers
Create a Scheme IdentifierList Scheme IdentifiersGet a Scheme Identifier
Embed Flow-4. Create Mandate & Payment
4.1 Create a Billing Request (Mandate)4.2 Collect Customer Details4.3 Collect Bank Account Details4.4 Confirm Customer & Bank Account Details4.5 Fulfill a Billing Request4.6 Create a Payment
Embed Flow-Branding-Logos
Create a logo
Embed Flow-Branding-PayerThemes
Create a Payer theme
Embed Flow-Exports
List ExportsGet Export
HomeGoCardlessEmbed Flow-2. (Optional) Creditors Bank Accounts

Embed Flow-2. (Optional) Creditors Bank Accounts

Number of APIs: 4

  1. List Creditor Bank Accounts GET {{url}}/creditor_bank_accounts

  2. Get a single Creditor Bank Account GET {{url}}/creditor_bank_accounts/{{creditor_bank_account}}

  3. Disable a Creditor Bank Account POST {{url}}/creditor_bank_accounts/{{creditor_bank_account}}/actions/disable

  4. Create a Creditor Bank Account POST {{url}}/creditor_bank_accounts

Previous
Update a Creditor
Next
Create a Creditor Bank Account