latestOpenAPI 3.0.12026-08-108798310.5 KB

fa1a72b9ecec

Settle Up

Fetch Settle Up profile for an account holder

get/api/v2/settle-up/profile

Response

Successful operation

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

Status

starlingPayLinkstring
settleUpLinkstring required

Settle Up link

Example response

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