Skip to main content
GET
/
api
/
payments
Export payments
curl --request GET \
  --url https://api.stage.rocka.live/api/payments \
  --header 'x-api-key: <api-key>'
{
  "payments": [
    {
      "id": "<string>",
      "merchantPaymentId": "<string>",
      "amount": 123,
      "currency": "<string>",
      "status": "<string>",
      "description": "<string>",
      "reference": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "finalisedDate": "2023-11-07T05:31:56Z"
    }
  ],
  "continuationToken": "<string>"
}

Authorizations

​
x-api-key
string
header
required

To get your own API keys, go to the Integration tab in your Rocka Hub. Use your test (not live) credentials to make API requests from this form.

Query Parameters

​
merchantPaymentId
string

Your Rocka payment ID.

​
status
any

Possible values: New, Awaiting Confirmation, Processing, Failed or Done.

​
dateFrom
string<date-time>

Only include payments that were made after a certain date. YYYY-MM-DD.

​
dateTo
string<date-time>

Only include payments that were made before a certain date. YYYY-MM-DD.

​
limit
string

Limit the number of payments retrieved.

Response

200 - application/json
​
payments
object[]
​
continuationToken
string | null

Pagination token used to help you access the next result page.