Create a pay by bank link for a gift card purchase.
Header Parameters
Media type the client can parse. Always application/json for this API.
application/jsonBody Parameters
The promotion-id of the gift card promotion, from getPromotionsList.
Your identifier for the customer.
The customer's email address. Required.
The customer's name. Optional.
Optional consent flag, as for paymentLink.
Required. Pay by bank is in pounds sterling only, so send GBP.
Amount of the gift card in pounds.
The bank-code the customer chose from getBanksList.
Response
A link to the customer's bank, or a failure message. Check for payment_link; some failures return
HTTP 200 with only a message.
Response Attributes
Redirect the customer here to pay at their bank.
Spendstream's order reference. It comes back on the TRANSACTION_UPDATED webhook.
Request failed validation. Body shape is {"message": "REASON"}.
Response Attributes
Human-readable failure reason. Safe to surface to integrators but not end-users.
Alternative error message field used by a subset of endpoints (notably getToken
and authentication failures). Integrators should check for both message and
error when parsing failure responses.
Numeric status code echoing the HTTP status (e.g. 400, 401). Populated on
most error paths; a few auth-layer failures omit it.
Authentication failed (missing, malformed or expired bearer token).
Response Attributes
Human-readable failure reason. Safe to surface to integrators but not end-users.
Alternative error message field used by a subset of endpoints (notably getToken
and authentication failures). Integrators should check for both message and
error when parsing failure responses.
Numeric status code echoing the HTTP status (e.g. 400, 401). Populated on
most error paths; a few auth-layer failures omit it.
Your publisher account has an IP allow-list and the request came from an address that is not on it. The API checks the caller's IP address on every request once a list exists. Ask Spendstream to add the address, or to clear the list if you do not want the restriction. See IP allow-listing in the guide.
Response Attributes
Response