GET
/
v1
/
charges
curl --request GET \
  --url https://api.nomod.com/v1/charges \
  --header 'X-API-KEY: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reference_id": 123,
      "created": "2023-11-07T05:31:56Z",
      "items": [
        {
          "amount": "<string>",
          "name": "<string>",
          "total_amount": "<string>",
          "quantity": 2147483647,
          "product": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sku": "<string>"
        }
      ],
      "currency": "<string>",
      "discount": "<string>",
      "service_fee": "<string>",
      "status": "authorised",
      "tip": "<string>",
      "tax": "<string>",
      "total": "<string>",
      "refund_total": "<string>",
      "note": "<string>",
      "payment_method": "cash",
      "discount_percentage": "<string>",
      "service_fee_percentage": "<string>",
      "tip_percentage": "<string>",
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "source": {
        "type": "<string>",
        "token": "<string>",
        "expiry_month": "<string>",
        "expiry_year": "<string>",
        "name": "<string>",
        "scheme": "<string>",
        "scheme_local": "<string>",
        "last4": "<string>",
        "bin": "<string>",
        "card_type": "<string>",
        "card_category": "<string>",
        "issuer": "<string>",
        "issuer_country": "<string>",
        "product_id": "<string>",
        "product_type": "<string>",
        "expires_on": "<string>",
        "card_data": {
          "card_number": "<string>",
          "expiry_month": "<string>",
          "expiry_year": "<string>",
          "security_code": "<string>",
          "card_holder_name": "<string>"
        }
      },
      "custom_fields": [],
      "refunds": [
        {
          "created": "2023-11-07T05:31:56Z",
          "amount": "<string>"
        }
      ],
      "events": {
        "created": "2023-11-07T05:31:56Z",
        "type": "authorised",
        "message": "<string>",
        "user": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "first_name": "<string>",
          "last_name": "<string>"
        }
      },
      "settlement_currency": "<string>",
      "fee": 123,
      "fx_fee": 123,
      "fee_tax": "<string>",
      "net": 123,
      "network_cost": "<string>",
      "success_url": "<string>",
      "failure_url": "<string>"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings

Query Parameters

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
search
string

search

Response

200 - application/json
​
count
integer
Example:

123

​
next
string | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string | null
Example:

"http://api.example.org/accounts/?page=2"

​
results
object[]