Get started

Sections

Theme switcher

List the UK banks a customer can pay from (pay by bank).

Header Parameters

Acceptstring

Media type the client can parse. Always application/json for this API.

Default value
application/json
Enum values:
application/json
Authorizationstring

Response

200
Object

The bank list, or a failure message with response set to 400.

Response Attributes

usersobject

Show child attributes

401
Object

Authentication failed (missing, malformed or expired bearer token).

Response Attributes

messagestring

Human-readable failure reason. Safe to surface to integrators but not end-users.

errorstring

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.

responseinteger

Numeric status code echoing the HTTP status (e.g. 400, 401). Populated on most error paths; a few auth-layer failures omit it.

403
Object

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

statusboolean
messagestring
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?