Secure Payments API - Get Batch List

NACHA File IDs

Each NACHA batch and associated file has a unique ID called the UUID. To get a list of the UUIDs for the batches in Secure Payments (formerly PCI Wallet), use the following request:

GET https://pciwallet.simnang.com/api/nacha/reports

The example below demonstrates how to do this:

You can also pull transaction data instead of pulling a generated file.

You can pull transaction data from Secure Payments using the API or the user interface. The transaction search is useful because it lets you filter transactions by date, status, batch, and type. If you have a large number of transactions, this could really help you submit a more specific list of transactions. Pulling transactions through the API is the preferred method for most large clients. This can be done using the /search/transaction endpoint. The payload will look something like this:

{  
"search":{
"query":{
"bool":{
"must":[
{
"bool":{
"should":{
"query_string":{
"query":"*", //keyword query
"fields":[
"_id",
"id",
"amount",
"customer_name",
"processor",
"metadata",
"batch"
],
"default_operator":"AND"
}
}
}
},
{
"match":{
"batch.keyword":"59899f74-b3b4-4b67-8376-55fcd70e2708" //Batch ID
}
}
]
}
},
"aggregations":{
"aggs":{
"terms":{
"field":"batch.keyword",
"size":100
}
}
},
"size":10
}
}

The search uses an Elasticsearch query object. Note that the "size" parameter is set to 10. This is for pagination and will result in a default of 10 transactions in the results.

The example below illustrates how to search Secure Payments transactions.


How did we do?


Powered by HelpDocs (opens in a new tab)