Skip to main content
GET
/
v1
/
settlements
/
{id}
Get a settlement
curl --request GET \
  --url https://api.plexospay.com/v1/settlements/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "se_abc123",
  "merchantId": "<string>",
  "amount": "<string>",
  "feeTotal": "<string>",
  "netAmount": "<string>",
  "currency": "CVE",
  "amountFormatted": "<string>",
  "netAmountFormatted": "<string>",
  "status": "PENDING",
  "periodStart": "2023-11-07T05:31:56Z",
  "periodEnd": "2023-11-07T05:31:56Z",
  "payoutRef": "<string>",
  "itemCount": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "processedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key starting with sk_live_ or sk_test_

Path Parameters

​
id
string
required

Response

200 - application/json

Settlement details

​
id
string
Example:

"se_abc123"

​
merchantId
string
​
amount
string
​
feeTotal
string
​
netAmount
string
​
currency
enum<string>

ISO currency code

Available options:
CVE,
AOA
​
amountFormatted
string
​
netAmountFormatted
string
​
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
​
periodStart
string<date-time>
​
periodEnd
string<date-time>
​
payoutRef
string | null
​
itemCount
integer
​
createdAt
string<date-time>
​
processedAt
string<date-time> | null
​
completedAt
string<date-time> | null