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.
Interact with this resource
To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.
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.