Get Transfer List

You can retrieve a list of transfers using the startDate, endDate, sort, direction, and limit parameters.

Endpoints

GET https://api.spherepay.co/v1/transfer/

For full API specification, refer to the Sphere API Reference.

Query Parameters

Parameter	Type	Required	Description
`startDate`	string	No	The start date of the transfers to retrieve.
`endDate`	string	No	The end date of the transfers to retrieve.
`sort`	string	No	Sort data by field.
`direction`	enum	No	Sort direction in either `ASC` or `DESC`.
`limit`	integer	No	The number of transfers to retrieve. Default is 25, max is 250.

The response will contain information about the transfer that matches the ID you provided.

Note

If no transfers are found, the response will be an empty array.

Response Example

{
  "ok": true,
  "object": "object",
  "statusCode": 200,
  "error": null,
  "message": "success",
  "data": {
    "paymentLinks": [
      {
        "id": "paymentLink_9918ef0141dc499f9837f799f8a9715e",
        "name": "",
        "description": "",
        "meta": {},
        "url": "https://spherepay.co/pay/paymentLink_9918ef0141dc499f9837f799f8a9715e",
        "successUrl": "",
        "failUrl": "",
        "start": null,
        "end": null,
        "taxRate": null,
        "shippingRate": null,
        "lineItems": [
          {
            "quantity": 1,
            "quantityMutable": true,
            "quantityLabel": "Donation Amount",
            "price": "price_66770beb4c5846be9727eb5168639e22",
            "product": "product_a65d51a2f2134bfc96326f40734d486f",
            "amountTotal": null,
            "paymentCurrency": null,
            "updated": "2024-08-08T16:10:24.441Z",
            "created": "2024-08-08T16:10:24.441Z"
          }
        ],
        "features": {
          "requiresEmail": false,
          "requiresName": false,
          "requiresShippingDetails": false
        },
        "coupon": null,
        "discordConstraints": [],
        "globalConstraint": null,
        "wallets": [],
        "phases": [],
        "updated": "2024-08-08T16:10:24.441Z",
        "created": "2024-08-08T16:10:24.441Z"
      },
      {
        "id": "paymentLink_ce24539cf6ad40a0b329712734718e08",
        // ...
      }
    ]
  },
  "ts": "2024-08-08T23:07:05.086Z",
  "request": "request_8310f2bad8054a99843d74168a3829f3"
}

Get Transfer List

Endpoints

Query Parameters

Response Example

On this page