Skip to main content
Use the Partner Payments API to create, refund, void, and retrieve payments from your backend. You can accept payments within your application without redirecting the payer to a GroGov checkout page. To let GroGov collect the card instead, use hosted checkout.

Quickstart

Create your first sandbox payment.

Authentication

Authenticate requests with an API key or access token.

Payment lifecycle

Payment statuses and when to void or refund.

Sandbox access

Request a sandbox API key, portal IDs, and test cards.

Hosted checkout

Send the payer to a GroGov checkout page.

​
What you can do in v1

  • Quote the service fee before you charge.
  • Create a payment containing one or more line items using card details or a supported card token.
  • Refund all or part of a payment, optionally including the service fee.
  • Void a payment before its batch settles.
  • Retrieve a payment by its id.
  • List payments associated with your API account, filtered by portal, status, and date range, with cursor pagination.
  • Receive webhook events when GroGov staff refund a payment or a cardholder disputes a payment.
Authorizing payments for later capture returns 501 CAPTURE_NOT_SUPPORTED. Storing cards and charging stored cards return 501 VAULT_NOT_SUPPORTED. Line-item refunds, ACH, e-check, Apple Pay, and Google Pay are not supported.The API does not expose settlement, batch, or deposit endpoints. Use the payment retrieval and listing endpoints for reconciliation.

​
Payments and portals

A payment is one charge, identified by its id. Its line items describe what the payer paid for. The payer is the person making the payment, and the agency receives the payment. A portal is an agency’s payment configuration in GroGov. It determines the payment gateway and service fee configuration used for a payment. GroGov provides the portalId values your API account can access. The service fee is added to the payment amount. See Amounts and fees for calculation details.

​
Base URLs

All examples use the sandbox at https://apistagepc.grogov.us. Sandbox payments do not move real money. Request credentials and test data through Sandbox access.

​
Conventions

Response envelope. Responses use a JSON envelope. A successful call returns:
Payment errors include details.code. Authentication failures can omit details. See Errors. A payment error returns:
Amounts are integer minor units (cents). Every money field’s name ends in Cents (amountCents, serviceFeeCents, …) and holds an integer number of cents: 100 = 1.00,‘10000‘=1.00, `10000` = 100.00. There are no decimals anywhere in the API. Currency. currency is always USD in v1. Include it when creating a payment.