Retrieve Payment

Overview

This endpoint retrieves detailed information about a specific Bre-B payment by its unique identifier. It includes metadata such as status, direction, amount, recipient, and timestamps.

Endpoint Details

DefinitionDescription
Endpointhttps://api.paas.sandbox.co.passportfintech.com/v1/payments/:payment_id
MethodGET
HeadersContent-Type: application/json, Authorization
AuthenticationAccess Token (Bearer Token)

Request Body

This endpoint does not require a request body.

Example Request

JSON
Copy

Response

  • HTTP Status Code: 200 OK.

Example of Response

JSON
Copy

Common Errors and Handling

HTTP Status CodeMeaningDescription
400Bad RequestMalformed id or invalid request
401UnauthorizedMissing/expired bearer token, or token lacks paas.core.breb_payments.get scope
403ForbiddenCaller not permitted to retrieve this payment
404Not FoundPayment with the given id does not exist
500Server ErrorUnexpected error; retry or contact support

Best Practices

  • Always log the id, status, and reference when retrieving a payment for reconciliation.
  • Pair with List Payments to monitor batch operations or multiple customer transactions.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard