Account data

Read your company's transactions, settlements and stores. Every list is { "data": [...], "page", "size", "total" }.

List Transactions

GET/v1/transactions

Lists the transactions of the company the key belongs to, newest first. The period defaults to the last 30 days; from and to are RFC 3339 timestamps. A filter that cannot be read (for example a date that is not RFC 3339) is answered with 400 and says which one.

https://api-stage.st-payup.com Stage, for development and testing
https://api.st-payup.com Production, for live transactions (available once your company is approved)

Parameters

Name	In	Type	Description
`from`	query	string (date-time)	Start of the period (RFC 3339). Default is 30 days ago. Example: `2026-10-01T00:00:00Z`
`to`	query	string (date-time)	End of the period (RFC 3339). Default is now. Example: `2026-10-31T23:59:59Z`
`page`	query	integer	Example: `1`
`size`	query	integer	Rows per page (at most 1000). Example: `20`
`status`	query	string	Comma-separated statuses, for example `paid,declined`.
`currency`	query	string	Comma-separated ISO 4217 codes. Example: `USD`
`paymentMethod`	query	string
`cardScheme`	query	string
`cardMask`	query	string
`merchantReference`	query	string	Your own order reference.
`transactionId`	query	string
`payerEmail`	query	string
`amountFrom`	query	number
`amountTo`	query	number

Responses

200 A page of transactions.

Name	Type	Description
`data`	object[]
`data[].id`	string (uuid)
`data[].createdAt`	string (date-time)
`data[].authedAt`	string (date-time)
`data[].confirmedAt`	string (date-time)
`data[].processedAt`	string (date-time)
`data[].amount`	number (float)	Example: `49.9`
`data[].currency`	string	Example: `USD`
`data[].paymentMethod`	string	Example: `card`
`data[].transactionType`	string	Example: `sale`
`data[].status`	string	Example: `paid`
`data[].description`	string
`data[].cardScheme`	string	Example: `visa`
`data[].cardMask`	string	Example: `424242******4242`
`data[].merchantReference`	string	Your own order reference.
`data[].terminalId`	string (uuid)
`data[].payerName`	string
`data[].payerEmail`	string
`data[].isOnlyFullRefund`	boolean
`page`	integer	Example: `1`
`size`	integer	The page size you asked for, or the number of rows when you did not ask. Example: `20`
`total`	integer	How many rows match in all, across pages. Example: `91`

{
  "data": [
    {
      "id": "string",
      "createdAt": "string",
      "authedAt": "string",
      "confirmedAt": "string",
      "processedAt": "string",
      "amount": 49.9,
      "currency": "USD",
      "paymentMethod": "card",
      "transactionType": "sale",
      "status": "paid",
      "description": "string",
      "cardScheme": "visa",
      "cardMask": "424242******4242",
      "merchantReference": "string",
      "terminalId": "string",
      "payerName": "string",
      "payerEmail": "string",
      "isOnlyFullRefund": true
    }
  ],
  "page": 1,
  "size": 20,
  "total": 91
}

400 A filter could not be read.

Name	Type	Description
`message`	string	Example: `An error occurred while processing your request.`
`code`	integer	Example: `1012`

401 Missing or invalid API key.

Name	Type	Description
`message`	string	Example: `An error occurred while processing your request.`
`code`	integer	Example: `1012`

Retrieve Transaction

GET/v1/transactions/{transactionId}

One transaction with its stages (created, authorized, confirmed, processed).

https://api-stage.st-payup.com Stage, for development and testing
https://api.st-payup.com Production, for live transactions (available once your company is approved)

Parameters

Name	In	Type	Description
`transactionId` required	path	string (uuid)

Responses

200 The transaction.

Name	Type	Description
`id`	string (uuid)
`createdAt`	string (date-time)
`authedAt`	string (date-time)
`confirmedAt`	string (date-time)
`processedAt`	string (date-time)
`amount`	number (float)	Example: `49.9`
`currency`	string	Example: `USD`
`paymentMethod`	string	Example: `card`
`transactionType`	string	Example: `sale`
`status`	string	Example: `paid`
`description`	string
`cardScheme`	string	Example: `visa`
`cardMask`	string	Example: `424242******4242`
`merchantReference`	string	Your own order reference.
`terminalId`	string (uuid)
`payerName`	string
`payerEmail`	string
`isOnlyFullRefund`	boolean

{
  "id": "string",
  "createdAt": "string",
  "authedAt": "string",
  "confirmedAt": "string",
  "processedAt": "string",
  "amount": 49.9,
  "currency": "USD",
  "paymentMethod": "card",
  "transactionType": "sale",
  "status": "paid",
  "description": "string",
  "cardScheme": "visa",
  "cardMask": "424242******4242",
  "merchantReference": "string",
  "terminalId": "string",
  "payerName": "string",
  "payerEmail": "string",
  "isOnlyFullRefund": true
}

401 Missing or invalid API key.

Name	Type	Description
`message`	string	Example: `An error occurred while processing your request.`
`code`	integer	Example: `1012`

404 No such transaction for your company.

Name	Type	Description
`message`	string	Example: `An error occurred while processing your request.`
`code`	integer	Example: `1012`

List Settlements

GET/v1/settlements

The payouts calculated for your company: gross amount, fee and net amount per period. A settlement moves pending, processing, completed (or cancelled).

https://api-stage.st-payup.com Stage, for development and testing
https://api.st-payup.com Production, for live transactions (available once your company is approved)

Parameters

Name	In	Type	Description
`page`	query	integer	Example: `1`
`size`	query	integer	Example: `20`
`status`	query	string	One of: `pending`, `processing`, `completed`, `cancelled`.
`currency`	query	string	Example: `USD`

Responses

200 A page of settlements.

Name	Type	Description
`data`	object[]
`data[].id`	string (uuid)
`data[].merchant_id`	string (uuid)
`data[].store_id`	string (uuid)
`data[].currency`	string	Example: `USD`
`data[].gross_amount`	number (float)
`data[].fee_amount`	number (float)
`data[].net_amount`	number (float)
`data[].tx_count`	integer
`data[].status`	string	One of: `pending`, `processing`, `completed`, `cancelled`.
`data[].type`	string	One of: `daily`, `weekly`, `monthly`, `manual`.
`data[].period_start`	string (date-time)
`data[].period_end`	string (date-time)
`data[].processed_at`	string (date-time)
`data[].notes`	string
`data[].created_at`	string (date-time)
`data[].updated_at`	string (date-time)
`page`	integer	Example: `1`
`size`	integer	The page size you asked for, or the number of rows when you did not ask. Example: `20`
`total`	integer	How many rows match in all, across pages. Example: `91`

{
  "data": [
    {
      "id": "string",
      "merchant_id": "string",
      "store_id": "string",
      "currency": "USD",
      "gross_amount": 0,
      "fee_amount": 0,
      "net_amount": 0,
      "tx_count": 0,
      "status": "string",
      "type": "string",
      "period_start": "string",
      "period_end": "string",
      "processed_at": "string",
      "notes": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "page": 1,
  "size": 20,
  "total": 91
}

401 Missing or invalid API key.

Name	Type	Description
`message`	string	Example: `An error occurred while processing your request.`
`code`	integer	Example: `1012`

Retrieve Settlement

GET/v1/settlements/{settlementId}

One settlement.

https://api-stage.st-payup.com Stage, for development and testing
https://api.st-payup.com Production, for live transactions (available once your company is approved)

Parameters

Name	In	Type	Description
`settlementId` required	path	string (uuid)

Responses

200 The settlement.

Name	Type	Description
`id`	string (uuid)
`merchant_id`	string (uuid)
`store_id`	string (uuid)
`currency`	string	Example: `USD`
`gross_amount`	number (float)
`fee_amount`	number (float)
`net_amount`	number (float)
`tx_count`	integer
`status`	string	One of: `pending`, `processing`, `completed`, `cancelled`.
`type`	string	One of: `daily`, `weekly`, `monthly`, `manual`.
`period_start`	string (date-time)
`period_end`	string (date-time)
`processed_at`	string (date-time)
`notes`	string
`created_at`	string (date-time)
`updated_at`	string (date-time)

{
  "id": "string",
  "merchant_id": "string",
  "store_id": "string",
  "currency": "USD",
  "gross_amount": 0,
  "fee_amount": 0,
  "net_amount": 0,
  "tx_count": 0,
  "status": "string",
  "type": "string",
  "period_start": "string",
  "period_end": "string",
  "processed_at": "string",
  "notes": "string",
  "created_at": "string",
  "updated_at": "string"
}

401 Missing or invalid API key.

Name	Type	Description
`message`	string	Example: `An error occurred while processing your request.`
`code`	integer	Example: `1012`

404 No such settlement for your company.

Name	Type	Description
`message`	string	Example: `An error occurred while processing your request.`
`code`	integer	Example: `1012`

List Stores

GET/v1/stores

The store the key belongs to, with its terminals. A payment link is issued on a terminal, so the terminalIds are what you pass as terminalId when you create one.

https://api-stage.st-payup.com Stage, for development and testing
https://api.st-payup.com Production, for live transactions (available once your company is approved)

Responses

200 The stores (the key's own store).

Name	Type	Description
`data`	object[]
`data[].id`	string (uuid)
`data[].name`	string
`data[].isActive`	boolean
`data[].terminalIds`	string[]
`page`	integer	Example: `1`
`size`	integer	The page size you asked for, or the number of rows when you did not ask. Example: `20`
`total`	integer	How many rows match in all, across pages. Example: `91`

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "isActive": true,
      "terminalIds": [
        "string"
      ]
    }
  ],
  "page": 1,
  "size": 20,
  "total": 91
}

401 Missing or invalid API key.

Name	Type	Description
`message`	string	Example: `An error occurred while processing your request.`
`code`	integer	Example: `1012`