# Obtener los detalles de una solicitud de pago

Obtén los detalles sobre una solicitud de pago específica.

Endpoint: GET /payment_requests/{paymentRequestId}
Version: 1.0.0
Security: ApiKeyAuth, ApiKeySecret

## Path parameters:

  - `paymentRequestId` (string, required)
    El identificador único creado por Belvo utilizado para referenciar la solicitud de pago.
    Example: "2e66d035-c78f-435c-a21d-b86d3e7b351d"

## Response 200 fields (application/json):

  - `id` (string)
    El identificador único creado por Belvo utilizado para referenciar la solicitud de pago.
    Example: "0d1a377b-b4c5-4a94-9e2e-83e59d1f6a9c"

  - `createdDate` (string,null)
    La marca de tiempo ISO-8601 cuando se creó la solicitud de pago en la base de datos de Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `lastUpdatedDate` (string,null)
    La marca de tiempo ISO-8601 cuando se actualizó por última vez la información sobre la solicitud de pago.
    Example: "2022-02-09T08:45:50.406032Z"

  - `chargebackDate` (string,null)
    La marca de tiempo ISO-8601 cuando Belvo marcó la solicitud de pago como chargeback. Solo está presente cuando el status es chargeback. Los contracargos registrados antes de que se introdujera bankChargebackDate contienen la fecha reportada por la institución financiera aquí en su lugar.
    Example: "2022-02-11T17:42:11.123Z"

  - `bankChargebackDate` (string,null)
    La fecha que la institución financiera reportó para el contracargo, en formato YYYY-MM-DD. Úsela para conciliar con los estados de cuenta de la institución financiera. null cuando la solicitud de pago no es un contracargo o fue contracargada antes de que se introdujera este campo.
    Example: "2022-02-10"

  - `status` (string)
    El estado de la solicitud de pago. Puede ser uno de los siguientes:
  - initial
    La solicitud de pago ha sido creada.
  - processing
    Los archivos de cobro han sido generados para la solicitud de pago. Esperando respuesta de la institución financiera.
  - successful
    La institución financiera ha confirmado la solicitud de pago y los fondos han sido transferidos.
  - failed
    La institución financiera ha reportado un error en la solicitud de pago y no se han transferido fondos.
  - canceled
    La solicitud fue cancelada. Esto solo es posible si la solicitud de pago no ha pasado al estado processing.
  - chargeback
    La institución financiera revirtió una solicitud de pago que fue successful.
    Enum: "initial", "processing", "successful", "failed", "canceled", "chargeback"

  - `failedReason` (string,null)
    El código de falla de la institución financiera.

  - `failedReasonMessage` (string,null)
    El mensaje de falla de la institución financiera, que describe la razón de la falla.

  - `amount` (string)
    El monto a debitar del cliente.
    Example: "100000.00"

  - `currency` (string)
    El código de moneda de tres letras ISO 4217 de la transacción. Por el momento, solo admitimos mxn.
    Enum: "mxn"

  - `customer` (string)
    El identificador único creado por Belvo utilizado para referenciar al cliente.
    Example: "3118128a-6792-4b06-bd61-4acf6f6ad6b5"

  - `customerName` (string)
    El nombre del cliente.
    Example: "Carlos Vives"

  - `reference` (string)
    Una referencia para la solicitud de pago.
    Example: "Monthly gym subscription"

  - `paymentMethod` (object)

  - `paymentMethod.type` (string)
    El tipo de cuenta. Para México, este valor se establece en bank_account.
    Enum: "bank_account"

  - `paymentMethod.details` (object)
    Detalles relacionados con la cuenta bancaria asociada con el método de pago.

  - `paymentMethod.details.accountNumber` (string)
    El número de cuenta bancaria.
    Example: "445566790"

  - `paymentMethod.details.accountType` (string)
    El tipo de cuenta bancaria. Puede ser:
  - savings
  - checking
  - debit_card
    Enum: "savings", "checking", "debit_card"

  - `paymentMethod.details.bank` (string)
    El nombre del banco mexicano donde se mantiene la cuenta.

Para ver una lista completa de instituciones, por favor visita nuestra página dedicada de Instituciones de Pago.

  - `loanInformation` (object)
    (Metadata opcional) Información sobre el préstamo asociado con la solicitud de pago.

  - `loanInformation.reference` (string)
    Su referencia para el préstamo asociado con la solicitud de pago.
    Example: "Camera Purchase 1432"

  - `loanInformation.disbursementDate` (string)
    La fecha en que se desembolsó el préstamo, en formato YYYY-MM-DD.
    Example: "2025-01-01"

  - `loanInformation.installmentNumber` (integer)
    El número de la cuota que se está pagando.
    Example: 1

  - `loanInformation.installmentAmount` (number)
    El monto de la cuota que se está pagando.
    Example: 100.02

  - `loanInformation.installmentDueDate` (string)
    La fecha de vencimiento de la cuota que se está pagando, en formato YYYY-MM-DD.
    Example: "2025-03-01"

  - `loanInformation.totalAmount` (number)
    El monto total del préstamo.
    Example: 12000.24

  - `loanInformation.totalInstallments` (integer)
    El número total de cuotas para el préstamo.
    Example: 12

## Response 400 fields (application/json):

  - `statusCode` (integer)
    El código de estado HTTP para este error.
    Example: 400

  - `error` (string)
    La descripción del código de estado HTTP para este error.
    Example: "Bad Request"

  - `message` (any)
    Una breve descripción del error, indicando qué está mal con la solicitud.
> Nota: Devolvemos una cadena o un arreglo de cadenas, dependiendo del/los error(es) de validación.

La descripción puede ser (entre otras):

  - id must be a UUID
  - Not enough balance
  - amount is not a valid decimal number.
  - currency must be one of the following values: cop, mxn, usd
  - reference must be a string
  - Customer not found for merchant
  - documentType is a required field
    Example: "id must be a UUID"

## Response 401 fields (application/json):

  - `statusCode` (integer)
    El código de estado HTTP para este error.
    Example: 401

  - `error` (string)
    La descripción del código de estado HTTP para este error.
    Example: "Unauthorized"

  - `message` (string)
    Una breve descripción del error, indicando qué está mal con la solicitud. En el caso de un error 401 Unauthorized, el mensaje es:

  - Unauthorized credentials
    Example: "Unauthorized credentials"

## Response 404 fields (application/json):

  - `statusCode` (integer)
    El código de estado HTTP para este error.
    Example: 404

  - `error` (string)
    La descripción del código de estado HTTP para este error.
    Example: "Not Found"

  - `message` (string)
    Una breve descripción del error, indicando qué está mal con la solicitud. La descripción puede ser (entre otras):

  - Payout Target not found
  - Payment method not found
  - Customer not found
    Example: "Payout Target not found"


