Get total payment information

GET /api/PaymentsTotal?idempotencyKeys={idempotencyKey1}&idempotencyKeys={idempotencyKey2}

Use this endpoint to retrieve the sum of all of the payments made in the last hour.


Request URL: https://.../api/PaymentsTotal?idempotencyKeys={idempotencyKey1}&idempotencyKeys={idempotencyKey2}

Sample request

https://.../api/PaymentsTotal?idempotencyKeys=7172dca0-3c2f-46e9-b512-6637e51c7172&idempotencyKeys=8988dca0-3c2f-46e9-b512-6637e51c8988

The query string can contain one or more idempotencyKeys, divided by “&” Path parameter.

Request parameter

Parameter	Description
idempotencyKey1	Total payments unique ID.
idempotencyKey2	(Optional) Second total payments unique ID.

Sample response

[
 {
 "idempotencyKey" : "7172dca0-3c2f-46e9-b512-6637e51c7172",
 "totalAmount" : 543.21,
 "network" : "visa",
 "firstPaymentAt" : "2021-05-20T20:47:21.128Z",
 "lastPaymentAt" : "2021-05-20T21:47:21.128Z"
 }, {
 "idempotencyKey" : "8988dca0-3c2f-46e9-b512-6637e51c8988",
 "totalAmount" : 3500,
 "network" : "pulse",
 "firstPaymentAt" : "2021-05-20T20:47:21.128Z",
 "lastPaymentAt" : "2021-05-20T21:47:21.128Z"
 }
]

Response attributes

Attributes	Description
idempotencyKey string	Unique identifier.
totalAmount integer	The amount of the payment in USD.
network string	The network used to facilitate the payment.
firstPaymentAt string	The time of the first payment (GMT).
lastPaymentAt string	The time of the last payment (GMT).