Creates a new
pay_link which allows customers to directly interact with Stronghold-hosted onboarding and payment services.
The customer id the pay link is for.
The charge associated with the pay link.
Order information related to a checkout process.
The callbacks configuration for a PayLink.
Returned query parameters
PayLink flow has been completed successfully or is exited. The callback URL will be called with a few query parameters.
Those parameters give information on the
PayLink and on the customer actions as well.
There are the query parameters which can be passed to the callback URL.
||ID of the PayLink||All||All|
||Type of the PayLink||All||All|
||Result of the flow,
||Payment source ID used or created.||
||Charge ID created.||
||Tip ID created.||
It is possible to pass custom parameters to a callback URL.
The parameter will be prefixed by
custom_ before redirection.
If the callback URL contains the query parameter
Then the callback will be called with all the Stronghold parameters plus the parameter
custom_order_id with the value
The newly created pay link.
The response ID.
The response time.
The HTTP status code.
A PayLink are used to take the customer through a payment related flow.