Click or drag to resize

RedirectFlow Properties

The GoCardlessRedirectFlow type exposes the following members.

Properties
  NameDescription
Public propertycreated_at
Fixed timestamp, recording when this resource was created.
Public propertydescription
A description of the item the customer is paying for. This will be shown on the hosted payment pages.
Public propertyid
Unique identifier, beginning with “RE”.
Public propertyIDEMPOTENCYKEY
Not part of actual object sent to GoCardless. Used in HTTP header to prevent duplicating a successful request.
Public propertylinks
IDs of things that could be related: creditor, customer, customer_bank_account, mandate.
Public propertyprefilled_customer
Info about the customer that can be filled by us/from our website. Info be filled in the GC form in the redirect link. Other than in the Create API, this isn't normally used.
Public propertyredirect_url
The URL of the hosted payment pages for this redirect flow. This is the URL you should redirect your customer to.
Public propertyscheme
The Direct Debit scheme of the mandate. If specified, the payment pages will only allow the set-up of a mandate for the specified scheme. It is recommended that you leave this blank so the most appropriate scheme is picked based on the customer’s bank account.
Public propertysession_token
The customer’s session ID must be provided when the redirect flow is set up and again when it is completed. This allows integrators to ensure that the user who was originally sent to the GoCardless payment pages is the one who has completed them.
Public propertysuccess_redirect_url
The URL to redirect to upon successful mandate setup. You must use a URL beginning https in the live environment.
Top
See Also