API Reference

Get relationship credit balance

get
https://api.wingspan.app/v3/payments/payers//credit-balance

Per currency for one relationship. available sums remaining minus pending refunds over started, unexpired PrePayment records; notStarted covers future-start unexpired balances. Excludes Complete and PostPayment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

Permanent relationship ID, including legacy relationship IDs; not required to be a Wingspan Account ID.

Headers
string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 16 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 16 days ago

Did this page help you?