# Obter os detalhes de uma solicitação de pagamento

Obtenha os detalhes sobre uma solicitação de pagamento específica.

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

## Path parameters:

  - `paymentRequestId` (string, required)
    O identificador único criado pela Belvo usado para referenciar a solicitação de pagamento.
    Example: "2e66d035-c78f-435c-a21d-b86d3e7b351d"

## Response 200 fields (application/json):

  - `id` (string)
    O identificador único criado pela Belvo usado para referenciar a solicitação de pagamento.
    Example: "0d1a377b-b4c5-4a94-9e2e-83e59d1f6a9c"

  - `createdDate` (string,null)
    O carimbo de data e hora ISO-8601 quando a solicitação de pagamento foi criada no banco de dados da Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `lastUpdatedDate` (string,null)
    O carimbo de data e hora ISO-8601 quando as informações sobre a solicitação de pagamento foram atualizadas pela última vez.
    Example: "2022-02-09T08:45:50.406032Z"

  - `chargebackDate` (string,null)
    O timestamp ISO-8601 quando a Belvo marcou a solicitação de pagamento como chargeback. Presente apenas quando o status é chargeback. Chargebacks registrados antes da introdução de bankChargebackDate mantêm a data relatada pela instituição financeira aqui.
    Example: "2022-02-11T17:42:11.123Z"

  - `bankChargebackDate` (string,null)
    A data que a instituição financeira informou para o estorno, no formato YYYY-MM-DD. Use-a para reconciliar com os extratos da instituição financeira. null quando a solicitação de pagamento não é um estorno ou foi estornada antes de este campo ser introduzido.
    Example: "2022-02-10"

  - `status` (string)
    O status da solicitação de pagamento. Pode ser:

  - initial
    A solicitação de pagamento foi criada.
  - processing
    Os arquivos de cobrança foram gerados para a solicitação de pagamento. Aguardando resposta da instituição financeira.
  - successful
    A instituição financeira confirmou a solicitação de pagamento e os fundos foram transferidos.
  - failed
    A instituição financeira relatou um erro na solicitação de pagamento e nenhum fundo foi transferido.
  - canceled
    A solicitação foi cancelada. Isso só é possível se a solicitação de pagamento não tiver passado para o status processing.
  - chargeback
    A instituição financeira reverteu uma solicitação de pagamento que foi successful.
    Enum: "initial", "processing", "successful", "failed", "canceled", "chargeback"

  - `failedReason` (string,null)
    O código de falha da instituição financeira.

  - `failedReasonMessage` (string,null)
    A mensagem de falha da instituição financeira, descrevendo o motivo da falha.

  - `amount` (string)
    O valor a debitar do cliente.
    Example: "100000.00"

  - `currency` (string)
    O código de moeda de três letras ISO 4217 da transação. No momento, só oferecemos suporte a mxn.
    Enum: "mxn"

  - `customer` (string)
    O identificador único criado pela Belvo usado para referenciar o cliente.
    Example: "3118128a-6792-4b06-bd61-4acf6f6ad6b5"

  - `customerName` (string)
    O nome do cliente.
    Example: "Carlos Vives"

  - `reference` (string)
    Uma referência para a solicitação de pagamento.
    Example: "Monthly gym subscription"

  - `paymentMethod` (object)

  - `paymentMethod.type` (string)
    O tipo de conta. Para o México, esse valor é definido como bank_account.
    Enum: "bank_account"

  - `paymentMethod.details` (object)
    Detalhes sobre a conta bancária associada ao método de pagamento.

  - `paymentMethod.details.accountNumber` (string)
    O número da conta bancária.
    Example: "445566790"

  - `paymentMethod.details.accountType` (string)
    O tipo de conta bancária. Pode ser:
  - savings
  - checking
  - debit_card
    Enum: "savings", "checking", "debit_card"

  - `paymentMethod.details.bank` (string)
    O nome do banco mexicano onde a conta está mantida.

Para uma lista completa de instituições, consulte nossa página dedicada de Instituições de Pagamento.

  - `loanInformation` (object)
    (Metadata opcional) Metadados sobre o empréstimo associado à solicitação de pagamento.

  - `loanInformation.reference` (string)
    Sua referência para o empréstimo associado à solicitação de pagamento.
    Example: "Camera Purchase 1432"

  - `loanInformation.disbursementDate` (string)
    A data em que o empréstimo foi desembolsado, no formato YYYY-MM-DD.
    Example: "2025-01-01"

  - `loanInformation.installmentNumber` (integer)
    O número da parcela que está sendo paga.
    Example: 1

  - `loanInformation.installmentAmount` (number)
    O valor da parcela sendo paga.
    Example: 100.02

  - `loanInformation.installmentDueDate` (string)
    A data de vencimento da parcela que está sendo paga, no formato YYYY-MM-DD.
    Example: "2025-03-01"

  - `loanInformation.totalAmount` (number)
    O valor total do empréstimo.
    Example: 12000.24

  - `loanInformation.totalInstallments` (integer)
    O número total de parcelas para o empréstimo.
    Example: 12

## Response 400 fields (application/json):

  - `statusCode` (integer)
    O código de status HTTP para este erro.
    Example: 400

  - `error` (string)
    A descrição do código de status HTTP para este erro.
    Example: "Bad Request"

  - `message` (any)
    Uma breve descrição do erro, indicando o que está errado com a solicitação.
> Nota: Retornamos uma string ou um array de strings, dependendo do(s) erro(s) de validação.

A descrição pode ser (entre outras):

  - 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)
    O código de status HTTP para este erro.
    Example: 401

  - `error` (string)
    A descrição do código de status HTTP para este erro.
    Example: "Unauthorized"

  - `message` (string)
    Uma breve descrição do erro, indicando o que está errado com a solicitação. No caso de um erro 401 Unauthorized, a mensagem é:

  - Unauthorized credentials
    Example: "Unauthorized credentials"

## Response 404 fields (application/json):

  - `statusCode` (integer)
    O código de status HTTP para este erro.
    Example: 404

  - `error` (string)
    A descrição do código de status HTTP para este erro.
    Example: "Not Found"

  - `message` (string)
    Uma breve descrição do erro, indicando o que está errado com a solicitação. A descrição pode ser (entre outras):

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