Get a list of payment information by ID

GET /api/Payments/{requestId}

Use this endpoint to retrieve details of a specific list of payments where {requestId} is the customer-generated
unique ID.

Request URL: https:// .../ api/Payments/{requestId}

Sample request

https:// .../ api/Payments/7172dca0-3c2f-46e9-b512-6637e51c7172

Request parameter

Parameter

Description

requestId
string

Customer-generated unique ID.

Sample response

[
 {
 "id" : "7172dca0-3c2f-46e9-b512-6637e51c7172",
 "amount" : 543.21,
 "rail" : "marqeta",
 "network" : "visa",
 "paymentAt" : "2021-05-20 13:47:21.128",
 "paymentId" : "1234dca0-3c2f-46e9-b512-6637e51c4321",
 "cT_ReceivedAt" : "2021-05-20 13:47:21.128",
 "isDuplicate" : false
 }, {
 "id" : "8988dca0-3c2f-46e9-b512-6637e51c8988",
 "amount" : 3500,
 "rail" : "marqeta",
 "network" : "visa"
 "paymentAt" : "2021-05-20 13:47:21.128",
 "paymentId" : "5678dca0-3c2f-46e9-b512-6637e51c8765",
 "cT_ReceivedAt" : "2021-05-20 13:47:21.128",
 "isDuplicate" : false
 }
]

Response attributes

❗️

Important

All time entries must be UTC format. An example is 2021-05-20T19:19:22Z

Attribute

Description

id
string

A customer-generated unique ID.

amount
integer

The payment amount.

rail
string

The rail that was used.

network
string

The network used to facilitate the payment.

paymentAt
string

The actual time the payment was made which enables you to accurately calculate the money transaction.

paymentId
string

ID of the payment.

receivedAt
string

A timestamp of when payment was received by the Beka API.

isDuplicate
boolean

True or false. True if the payment is a duplicate, otherwise false.


Did this page help you?