Get Wire Payment by Payment ID

Loading...

API endpoint path: /db-bb-payments/bbpayments/v1/wire-payments/{paymentId}

Retrieves a single Wire Payment (WIRE_DOMESTIC or WIRE_INTERNATIONAL) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.

Request

Responses

200

The Wire Payment. Examples show sample responses by payment type (WIRE_DOMESTIC or WIRE_INTERNATIONAL).

400

Bad Request (400) - Missing or invalid path parameter. BBP-133. Used by GET payment by ID; paymentId required.

401

Unauthorized (401) - Invalid or expired JWT, or invalid role. BBP-131, BBP-132.

403

Forbidden (403) - Authenticated but not allowed to perform this action (e.g. method not allowed). Representative code PAYMENTS-WEB015.

404

Not Found (404) - No payment exists for the given paymentId. BBP-134.

500

Internal Server Error (500) - Unexpected server error.