- create_client
- client
- create_user
- user
- items
- store
- subscriptions
- subscription_settings
- customer_portal_settings
- item_categories
- taxes
- webhooks
- payment_method_sets
- coupons
- template_sets
- template_configs
- cart_templates
- cart_include_templates
- checkout_templates
- receipt_templates
- email_templates
- error_entries
- downloadables
- payment_gateways
- hosted_payment_gateways
- fraud_protections
- transaction_journal_entries
- gift_cards
connect_gateway
Description
This endpoint generates an onboarding URL, allowing you to do OAuth-style payment gateway connections within your own platform. Use the generated URL in the browser, to direct a user through the process. When the user completes the connection, they will be redirected to the final_redict
with status
parameter.
status
can be 0 or 1 through 5. 0 indicates success, whereas other values indicate an error. If you get a non-zero response, please contact us.
Also, in gateway resource, you'll see a fx:connect_gateway
link. This endpoint will allow a user to reconnect the payment gateway, and needs only the final_redirect
parameter.
Sandbox Example
You can interact with this resource and run actions against the sandbox API via our HAL Brower.
Actions
- POST
- Generate connection payment_gateway URL
- OPTIONS
- Get a response explaining which HTTP methods are supported
Properties
Property | Description | Type | Constraints |
---|---|---|---|
type | Payment_gateway name. For example stripe_connect . |
String | Required. |
final_redirect | Url to redirect the user to, after completion of the process.. | URL | Required. |
Example Representation
{ "connection_url": "https://connect.stripe.com/oauth/authorize?client_id=ca_BWHoVBQvOxyBHRPSTZQzonT2gqeebt65&state=40018%7C1323%7C62ba278d98e64b141b75b20f9f5a9aa246333c1a4b69f712c1ff854098047ce0%7Cmode%3Dtest%7Cfinal_redirect%3Dhttps%3A%2F%2Fgoogle.com%7Cgateway%3Dstripe_connect&response_type=code&scope=read_write&redirect_uri=https%3A%2F%2Fadmin.foxy.test%2Fadmin%2Fonboarding_gw" }
Zoomable Resources
This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.