I currently process transactions through Spreedly via the /gateways endpoint. How do I get access and migrate over to Composer so that I can manage my payment flow through a workflow?
- Create a workflow: To create your first workflow, navigate to app.spreedly.com/composer or select Composer from the left navigation menu. Follow the workflow user guide to get started.
-
Update your endpoint: Update your Auth, Purchase, and/or Verify API calls to use the /transactions endpoint as opposed to the /gateways endpoint. See more API details here. The same request body can be used with the following optional exceptions:
- Add the workflow_key to your request body.
Note: If only one workflow is required, you do not need to specify a workflow_key in your request body. Transactions will use the default workflow. - If using GSFs, you can combine all the GSFs for all gateways that are used in your workflow in the request body.
- Spreedly has normalized many GSF’s. Add these to your request body by following the API guide above. View the list of normalized fields here.
- When using the /transactions endpoint, you will automatically receive our normalized response fields and values, in addition to the gateway-specific ones you have been receiving on the /gateways endpoint. Optionally consume this data in your downstream systems.
- Add the workflow_key to your request body.
API Request Examples
API request using the /gateways endpoint prior to a migration to Composer:
API request using the /transactions endpoint post-migration to Composer:
API request using the /transactions endpoint to demonstrate the implementation of normalized request fields: