---
updatedAt: 2026-05-14T14:32:15.000Z
agentTools:
  projectIndex: https://docs.oysterhr.com/v0.1/llms.txt
---

# Retrieve a charge group

Returns detailed information about a specific charge group

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Endpoints",
    "version": "v0.1"
  },
  "components": {
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "amount": {
        "type": "object",
        "properties": {
          "decimal": {
            "type": "string",
            "pattern": "^\\d+([.]\\d+)?$"
          },
          "currencyCode": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3
          }
        },
        "required": [
          "decimal",
          "currencyCode"
        ]
      },
      "paymentsGroup": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "referenceCode": {
            "type": "string"
          },
          "itemsCount": {
            "type": "integer"
          },
          "state": {
            "type": "string",
            "enum": [
              "PENDING",
              "WIRE_SENT",
              "PAID",
              "PROCESSING"
            ]
          },
          "amount": {
            "$ref": "#/components/schemas/amount"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "wireSentAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "paidAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        },
        "required": [
          "id",
          "referenceCode",
          "itemsCount",
          "state",
          "amount",
          "createdAt",
          "wireSentAt",
          "paidAt"
        ]
      }
    }
  },
  "paths": {
    "/v0.1/payments/charge_groups/{id}": {
      "get": {
        "summary": "Retrieve a charge group",
        "tags": [
          "Payments"
        ],
        "description": "Returns detailed information about a specific charge group",
        "security": [
          {
            "bearer_auth": [
              "read"
            ]
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "Charge group ID",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful",
            "content": {
              "application/json": {
                "examples": {
                  "Successful": {
                    "value": {
                      "data": {
                        "id": "Acf02f3d",
                        "referenceCode": "OY-COMP-Acf02f3d-Gr-0000001",
                        "itemsCount": 3,
                        "state": "PENDING",
                        "amount": {
                          "decimal": "726.55",
                          "currencyCode": "USD"
                        },
                        "createdAt": "2022-10-15T12:34:56Z",
                        "wireSentAt": null,
                        "paidAt": null
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/paymentsGroup"
                    }
                  },
                  "required": [
                    "data"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oysterhr.com",
      "description": "Production server"
    },
    {
      "url": "https://api-sandbox.oysterhr.com",
      "description": "Sandbox server"
    }
  ]
}
```