Settle Up

Fetch Settle Up profile for an account holder

get/api/v2/settle-up/profile

Request

Base URL
https://api.starlingbank.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/starlingbank/apis/starling-bank-api/docs/api/v2/settle-up/profile/get.ts
A function with typed inputs. Its response is checked against the schema.

Successful operation

status'ACTIVE' | 'INACTIVE' | 'CLOSED' required

Status

starlingPayLinkstring

settleUpLinkstring required

Settle Up link

{
  "status": "ACTIVE",
  "settleUpLink": "https://settleup.starlingbank.com/amanda.hanks"
}

No recorded changes to this operation across all 14 revisions of this API.