Confirm Payment

Overview

This endpoint allows you to Confirm and submit a Bre-B payment to the Bre-B network. A successful request processes the payment and returns the transaction details, including status and recipient information.

Endpoint Details

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

Request Body

ParameterTypeConstraintsRequiredDescription
idStringYesThe unique identifier of the payment to be sent to the Bre-B Network.

Example Request

JSON
Copy

Response Body

  • HTTP Status Code: 200 OK.

Example of Response

JSON
Copy

The payment status will first be PENDING. Once the payment is processed, it will change to SETTLED. You can use the Webhooks to check the payment statuses.

Common Errors and Handling

HTTP Status CodeMeaningDescription
400 Bad RequestInvalid DataRequired fields are missing or contain incorrect values.
401 UnauthorizedExpired TokenThe access token is invalid or has expired.
403 ForbiddenAccess DeniedThe request is not authorized to create a payment.
500 Internal Server ErrorServer ErrorAn unexpected error occurred while processing the payment.

Best Practices

  • Ensure the id of the document is correct before making the request.
  • Monitor the payment status (PENDING, SETTLED, etc.) to track progress, via the Webhooks.
  • Implement error handling to manage failed or delayed payments.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard