See our API documentation for Moov PayGate admin endpoints.
Get the current version of paygate:
$ curl localhost:9092/version
v0.6.0
Liveness checks are included in paygate to aggregate downstream dependency status. If they’re available good is returned and otherwise an error string is returned. When calling this endpoint checking for the HTTP status of 200 OK is enough to verify no errors were returned. A 4xx status will be returned if errors are encountered.
$ curl -s localhost:9092/live | jq .
{
"accounts": "good",
"ach": "good",
"customers": "good",
"fed": "FED ping failed: Get http://localhost:8086/ping: dial tcp [::1]:8086: connect: connection refused"
}
Note: Paygate currently supports /ready, but has no checks on this so 200 OK is always returned.
PayGate offers an endpoint for retrieving the config object from a running instance. This allows inspection of the features or credentials (rendered in a masked form).
Refer to the documentation for this config for full details.
$ curl -s http://localhost:9092/config | jq .
{
"logging": {
"format": "plain",
"level": ""
},
"http": {
// ...
},
"admin": {
// ...
},
"database": {
// ...
},
"odfi": {
// ..
},
"pipeline": {
// ...
},
"validation": {
// ...
},
"customers": {
// ...
}
}
There is an endpoint to initiate cutoff processing as if a window has approached. This involves merging transfers into files, upload attempts, along with inbound file download processing.
$ curl -XPUT http://localhost:9092/trigger-cutoff
// check for errors, or '200 OK'