Get Payment Details and Status by ID

GET /v1/payments/ — Retrieve full payment details and lifecycle status by Diameter payment UUID. Requires com.diameterpay.api/payments.read scope.

Retrieve the full details and current status of a payment using its Diameter-issued UUID. Use this endpoint to poll the status of a payment after initiation, or to retrieve wire-specific details such as the IMAD (Input Message Accountability Data) once the payment has been processed by the bank. For status-change notifications without polling, consider setting up webhooks.

​

Endpoint

GET /v1/payments/{id}

Required scope: com.diameterpay.api/payments.read

​

Path Parameters

id · string · required

The Diameter-issued UUID of the payment to retrieve. This is the id returned when the payment was created.

​

Response Fields

id · string

The Diameter-issued UUID for the payment.

e2eId · string

The endToEndId you supplied when initiating the payment — your own reference for this transaction.

status · string

The current lifecycle status of the payment. One of:

Value	Description
SCREENING_REQUESTED	The payment has been submitted and is pending compliance screening.
SCREENING_PASSED	Compliance screening completed successfully; the payment is queued for routing.
ROUTED	The payment instruction has been sent to the bank partner.
RECEIVED_BY_PARTNER	The bank partner has acknowledged receipt of the payment.
COMPLETED	The payment has settled successfully.
FAILED	The payment could not be completed. Check wire details or contact support.

wire · object

Wire-specific tracking details. Present only for wire payments once the bank has assigned tracking identifiers.

Show wire fields

wire.initialImad · string

The Input Message Accountability Data (IMAD) assigned when the wire was first submitted to the Fedwire network. Format: MMDDYYYYBANK8DIGITCODE.

wire.finalImad · string

The final IMAD assigned upon settlement confirmation. Present once the payment reaches COMPLETED status.

idAssignedByBank · string

The transaction reference number assigned by the bank partner. Present after the payment reaches RECEIVED_BY_PARTNER status.

​

Example Request

curl --request GET \
  --url "https://api.diameterpay.com/v1/payments/d4e5f6a7-b8c9-0123-defa-bc1234567890" \
  --header "Authorization: Bearer {access_token}"

​

Example Response

{
  "id": "d4e5f6a7-b8c9-0123-defa-bc1234567890",
  "e2eId": "PAY-2024-001",
  "status": "COMPLETED",
  "wire": {
    "initialImad": "0601BANKUS33XXXX0000001",
    "finalImad": "0601BANKUS33XXXX0000002"
  },
  "idAssignedByBank": "FED20240601000001"
}