GOgocardless
Redirect Flow

Create a redirect flow

Creates a redirect flow object which can then be used to redirect your customer to the GoCardless hosted payment pages.

Deprecated: Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow API should be used for your payment flows.

post/redirect_flows

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "redirect_flows": {
    "description": "Standard subscription",
    "session_token": "SESS_wSs0uGYMISxzqOBq",
    "scheme": "bacs",
    "success_redirect_url": "https://example.com/pay/confirm",
    "prefilled_customer": {
      "email": "user@example.com",
      "given_name": "Frank",
      "family_name": "Osborne",
      "company_name": "Hamilton Trading Ltd.",
      "address_line1": "221B Baker Street",
      "address_line2": "Marylebone",
      "address_line3": "City of Westminster",
      "city": "London",
      "region": "Greater London",
      "postal_code": "NW1 6XE",
      "country_code": "GB",
      "language": "en",
      "phone_number": "+64 4 817 9999",
      "swedish_identity_number": "556564-5404",
      "danish_identity_number": "220550-6218"
    },
    "prefilled_bank_account": {
      "account_type": "savings"
    },
    "links": {
      "creditor": "CR123"
    },
    "metadata": {
      "salesforce_id": "ABCD1234"
    }
  }
}

Response

Resource created successfully

Example response

{
  "redirect_flows": {
    "id": "RE123456",
    "description": "Standard subscription",
    "session_token": "SESS_wSs0uGYMISxzqOBq",
    "scheme": "bacs",
    "success_redirect_url": "https://example.com/pay/confirm",
    "confirmation_url": "https://pay.gocardless.com/flow/RE123/success",
    "redirect_url": "http://pay.gocardless.com/flow/RE123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "links": {
      "creditor": "CR123",
      "mandate": "MD123",
      "customer": "CU123",
      "customer_bank_account": "BA123",
      "billing_request": "BR123"
    },
    "metadata": {
      "salesforce_id": "ABCD1234"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.