Consulta del estado de un pago

Para consultar el estado de un pago, se deberá hacer una petición con el id del pago, recibido al momento de la creación.

Get Payment Request

GET/payment_requests/{payment_request_id}

Authorization

OAuth2PasswordBearerExtended

Path parameters

payment_request_id*Payment Request Id

Response

200422

Successful Response

Body

application/json

id*Id

order_id*Order Id

ars_amount*Ars Amount

ars_paid*Ars Paid

amount*Amount

amount_paid*Amount Paid

currency*Fiat

ARSUSD

itemsItems

array of ItemModelnull

usd_amount*Usd Amount

reference*Reference

memoMemo

stringnull

notification_urlNotification Url

stringnull

status*PaymentRequestStatus

pendingapprovedcanceledexpiredrefunded

status_detail*TransactionStatus

not_paidcorrectunderpaidoverpaid

expiration_time*Expiration Time

delivered*Delivered

transactions*Transactions

card_paymentany of

CardPaymentModelnull

payments*Payments

merchant_id*Merchant Id

date_created*Date Created

last_modified*Last Modified

checkout_url*Checkout Url

conflict*Conflict

Request

JavaScriptCurlPython

const response = await fetch('/payment_requests/{payment_request_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "id": "text",
  "order_id": 0,
  "ars_amount": 0,
  "ars_paid": 0,
  "amount": 0,
  "amount_paid": 0,
  "currency": "ARS",
  "items": [
    {
      "id": "text",
      "quantity": 0,
      "name": "text",
      "price": 0,
      "currency": "ARS"
    }
  ],
  "usd_amount": 0,
  "memo": "text",
  "notification_url": "text",
  "status": "pending",
  "status_detail": "not_paid",
  "expiration_time": "2024-12-26T17:20:17.571Z",
  "delivered": false,
  "transactions": [
    {
      "id": "text",
      "price_details": {
        "currency": "ARS",
        "currency_amount": 0,
        "currency_final_amount": 0,
        "base_amount": 0,
        "final_amount": 0,
        "paid_amount": 0,
        "discount_rate": 0,
        "rate": 0
      },
      "coin": "BCH",
      "chain_id": 0,
      "address": "text",
      "status": "not_paid",
      "payment_request_id": "text",
      "memo": "text",
      "payments": [
        {
          "hash": "text",
          "block": 0,
          "amount": 0,
          "paid_by": "text",
          "paid_at": "2024-12-26T17:20:17.571Z",
          "linked_at": "2024-12-26T17:20:17.571Z"
        }
      ],
      "date_created": "2024-12-26T17:20:17.571Z",
      "last_modified": "2024-12-26T17:20:17.571Z"
    }
  ],
  "card_payment": {
    "provider": "stripe",
    "session_url": "text",
    "price_details": {
      "currency": "ARS",
      "amount": 0,
      "final_amount": 0,
      "usd_final_amount": 0,
      "paid_amount": 0,
      "discount_rate": 0,
      "rate": 0
    },
    "status": "not_paid",
    "date_created": "2024-12-26T17:20:17.571Z",
    "last_modified": "2024-12-26T17:20:17.571Z"
  },
  "payments": [
    {
      "hash": "text",
      "block": 0,
      "amount": 0,
      "paid_by": "text",
      "paid_at": "2024-12-26T17:20:17.571Z",
      "linked_at": "2024-12-26T17:20:17.571Z",
      "coin": "BCH"
    }
  ],
  "merchant_id": "text",
  "date_created": "2024-12-26T17:20:17.571Z",
  "last_modified": "2024-12-26T17:20:17.571Z",
  "checkout_url": "text",
  "conflict": false
}

Estados de un Pago (status):

1. Pendiente (pending): El pago está esperando a ser procesado.

2. Completado (approved): El pago se ha completado exitosamente.

3. Reembolsado (refunded): El pago ha sido reembolsado.

4. Cancelado (canceled): El pago ha sido cancelado.

5. Expirado (expired): El pago ha superado el tiempo límite para ser completado.

Detalles de Estado de un Pago (status_detail):

1. Pago exacto (correct): El pago se recibió por el monto exacto de la transacción.

2. Insuficiente (underpaid): El pago recibido es menor al monto esperado.

3. Excedido (overpaid): El pago recibido es mayor al monto esperado.

4. Sin Pagos (not_paid): No se ha recibido ningún pago para esta transacción.