Create Billing Request Flow

Creates a new billing request flow in GoCardless.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Arguments

string

URL to redirect the payer to after completing the request flow.

string

URL the payer can be taken to if the flow cannot progress.

object

Prefilled customer details for the billing request flow.

string

Prefilled customer first name.

string

Prefilled customer surname.

string

Prefilled customer email address.

object

Related resource identifiers for this billing request flow.

stringrequired

ID of the billing request against which this flow was created.

Uncommon arguments

string

Default language of the billing request flow and the customer.

boolean

If true, the payer will not be redirected to the success screen after completing the flow.

boolean

If true, the payer will see a redirect action button on the Success page.

Try this request

Request

curl --request POST \
  --url "https://connect.mindcloud.co/v1/universal/goCardless/0.0.6/actions/create-billing-request-flow" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "links.billingRequest": ""
}'

{
  "success": true,
  "data": [
    {
      "billingRequestFlows": {
        "authorisationUrl": "https://example.com",
        "autoFulfil": true,
        "config": {
          "merchantContactDetails": {
            "email": "[email protected]",
            "name": "Ava Chen",
            "phoneNumber": {},
            "url": {}
          },
          "schemeIdentifiers[]": {
            "address": "string",
            "advanceNotice": 1,
            "bankStatementName": "string",
            "name": "Ava Chen",
            "reference": "string",
            "registeredName": "string",
            "scheme": "string"
          }
        },
        "createdAt": "string",
        "customerDetailsCaptured": true,
        "exitUri": "string",
        "expiresAt": "string",
        "id": "string",
        "language": {},
        "links": {
          "billingRequest": "string"
        },
        "lockBankAccount": true,
        "lockCurrency": true,
        "lockCustomerDetails": true,
        "prefilledBankAccount": {},
        "prefilledCustomer": {
          "email": "[email protected]",
          "familyName": "string",
          "givenName": "string"
        },
        "redirectFlowId": {},
        "redirectOrigin": {},
        "redirectUri": "string",
        "sessionToken": {},
        "showRedirectButtons": true,
        "showSuccessRedirectButton": true,
        "skipSuccessScreen": true
      }
    }
  ],
  "meta": {}
}

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is

One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.

Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.

Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.