Create a payment

curl --request POST \
  --url https://apistagepc.grogov.us/api/partner/v1/payments \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "portalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "amountCents": 10000,
  "currency": "USD",
  "capture": "sale",
  "paymentMethod": {
    "type": "card",
    "cardNumber": "4111111111111111",
    "expirationDate": "12/30",
    "cvv": "123"
  },
  "payer": {
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane.doe@example.com"
  },
  "lineItems": [
    {
      "amountCents": 7500,
      "referenceId": "CASE-2024-001",
      "description": "Court filing fee"
    },
    {
      "amountCents": 2500,
      "referenceId": "CASE-2024-002",
      "description": "Processing fee"
    }
  ]
}
'

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "succeeded",
    "captureMode": "sale",
    "currency": "USD",
    "amountCents": 10000,
    "serviceFeeCents": 300,
    "totalChargedCents": 10300,
    "refundedAmountCents": 0,
    "remainingRefundableAmountCents": 10300,
    "authorizedAmountCents": 10300,
    "capturedAmountCents": 0,
    "confirmationNumber": "PP-1710000000000",
    "portalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payer": {
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane.doe@example.com",
      "phone": "+15551234567",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "country": "US"
      }
    },
    "paymentMethod": {
      "type": "card_token",
      "brand": "Visa",
      "last4": "4242"
    },
    "gateway": {
      "transactionId": "4938271649",
      "authCode": "123456"
    },
    "lineItems": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amountCents": 5000,
        "serviceFeeCents": 150,
        "status": "succeeded",
        "refundedAmountCents": 0,
        "remainingRefundableAmountCents": 5000,
        "referenceId": "CASE-2024-00123",
        "description": "Court filing fee",
        "metadata": {}
      }
    ],
    "expiresAt": "2023-11-07T05:31:56Z",
    "capturedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>"
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

POST

api

partner

payments

curl --request POST \
  --url https://apistagepc.grogov.us/api/partner/v1/payments \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "portalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "amountCents": 10000,
  "currency": "USD",
  "capture": "sale",
  "paymentMethod": {
    "type": "card",
    "cardNumber": "4111111111111111",
    "expirationDate": "12/30",
    "cvv": "123"
  },
  "payer": {
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane.doe@example.com"
  },
  "lineItems": [
    {
      "amountCents": 7500,
      "referenceId": "CASE-2024-001",
      "description": "Court filing fee"
    },
    {
      "amountCents": 2500,
      "referenceId": "CASE-2024-002",
      "description": "Processing fee"
    }
  ]
}
'

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "succeeded",
    "captureMode": "sale",
    "currency": "USD",
    "amountCents": 10000,
    "serviceFeeCents": 300,
    "totalChargedCents": 10300,
    "refundedAmountCents": 0,
    "remainingRefundableAmountCents": 10300,
    "authorizedAmountCents": 10300,
    "capturedAmountCents": 0,
    "confirmationNumber": "PP-1710000000000",
    "portalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payer": {
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane.doe@example.com",
      "phone": "+15551234567",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "country": "US"
      }
    },
    "paymentMethod": {
      "type": "card_token",
      "brand": "Visa",
      "last4": "4242"
    },
    "gateway": {
      "transactionId": "4938271649",
      "authCode": "123456"
    },
    "lineItems": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amountCents": 5000,
        "serviceFeeCents": 150,
        "status": "succeeded",
        "refundedAmountCents": 0,
        "remainingRefundableAmountCents": 5000,
        "referenceId": "CASE-2024-00123",
        "description": "Court filing fee",
        "metadata": {}
      }
    ],
    "expiresAt": "2023-11-07T05:31:56Z",
    "capturedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>"
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "Payment was declined.",
  "details": {
    "code": "PAYMENT_DECLINED",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: ApiKey pc_<your-key>. The API also accepts the key without the ApiKey prefix. API keys authenticate requests to /api/partner/v1/*. Contact GroGov support to rotate your key or deactivate your API account. Rotation invalidates the previous key. Account deactivation blocks both API keys and access tokens.

Headers

Idempotency-Key

string

Unique key to prevent duplicate charges on retry.

Maximum string length: 255

Body

application/json

portalId

string<uuid>

required

The ID of an agency's payment configuration in GroGov. The portal determines the payment gateway and service fee configuration. GroGov provides the portal IDs your API account can access.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

amountCents

integer

required

Total amount in cents. Must equal sum of line item amounts.

Example:

10000

currency

enum<string>

default:USD

required

Available options:

USD

paymentMethod

object

required

Option 1
Option 2
Option 3

Show child attributes

lineItems

object[]

required

Required array length: 1 - 50 elements

Show child attributes

referenceId

string

Your identifier for the payment. This is separate from each line item's referenceId. GroGov also uses this payment-level value to check case-specific payment restrictions.

Maximum string length: 255

Example:

"CASE-2024-00123"

capture

enum<string>

default:sale

sale charges immediately. auth (authorize now, capture later) is not supported and returns 501 CAPTURE_NOT_SUPPORTED. The response reports this as captureMode.

Available options:

sale,

auth

captureMode

enum<string>

deprecated

Deprecated alias of capture, accepted for clients built against an earlier version of this spec. If both are sent they must match, or the request is rejected with 400 VALIDATION_ERROR.

Available options:

sale,

auth

payer

object

Show child attributes

Response

Payment created

success

boolean

Example:

true

data

object

Show child attributes

message

string

Auth

Vault

Payments

Hosted checkout

API Reference

Authorizations

Headers

Body

Response