Actualizar un payment intent

PUT

https://app.recurrente.com/api/payment_intents/:id

PUT

/api/payment_intents/:id

curl -X PUT https://app.recurrente.com/api/payment_intents/id \
     -H "X-SECRET-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "payment_intent": {}
}'

{
  "id": "pa_123",
  "receipt_number": 1,
  "api_version": "2024-04-24",
  "live_mode": true,
  "created_at": "2024-01-15T09:30:00Z",
  "checkout": {
    "id": "ch_lmgbvesmihkqzma3",
    "status": "paid",
    "items": [
      {
        "id": "it_eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBQT09IiwiZXhwIjpudWxsLCJwdXIiOiJjaGVja291dF9pdGVtIn19",
        "price_id": "price_rky4dog7",
        "quantity": 2,
        "metadata": {},
        "variant": {
          "id": "var_9lstwgbr",
          "product_id": "prod_9lstwgbr",
          "status": "active",
          "title": "M / Rojo",
          "option_values": [
            "M",
            "Rojo"
          ],
          "sku": "string",
          "price_id": "price_3kd9sla2",
          "amount_in_cents": 12500,
          "currency": "GTQ",
          "inventory_quantity": 1,
          "low_stock_threshold": 3
        }
      }
    ],
    "bank_transfer_memo": "SCHOOLAIDORDEN1001",
    "total_in_cents": 3000,
    "subtotal_in_cents": 3500,
    "discount": {
      "amount_in_cents": 500,
      "coupon": {
        "id": "coup_ugwoxcp4",
        "name": "VERANO25",
        "discount_mode": "code",
        "display_name": "string",
        "amount_off_in_cents": 1500,
        "percent_off": 1.1,
        "automatically_applies": false,
        "max_redemptions": 1,
        "times_redeemed": 0,
        "currency": "GTQ",
        "duration": "once",
        "duration_in_payments": null,
        "minimum_amount_in_cents": null,
        "once_per_customer": false,
        "product_ids": [],
        "starts_at": "2024-01-15T09:30:00Z",
        "expires_at": "2024-01-15T09:30:00Z",
        "status": "active"
      }
    },
    "currency": "GTQ",
    "payment_method_types": [
      "card",
      "bank_transfer"
    ],
    "available_installments": [
      3,
      6
    ],
    "live_mode": true,
    "amount_set_in_browser": false,
    "clave_enabled": true,
    "success_url": "string",
    "cancel_url": "string",
    "expires_at": "2024-01-15T09:30:00Z",
    "created_at": "2024-01-15T09:30:00Z",
    "metadata": {},
    "custom_fields": [
      {
        "field_id": "ccf_xxxxxxxxxxxx",
        "key": "engraving",
        "type": "text",
        "value": "string"
      }
    ],
    "transfer_setups": [
      {
        "id": "tr_4a7b9c8d",
        "status": "pending",
        "amount_in_cents": 1,
        "amount_percent": 1.1,
        "currency": "string",
        "recipient_id": "ac_123456",
        "purpose": "fund_split"
      }
    ],
    "application_fee_amount": 3250,
    "application_fee_percent": 10,
    "latest_intent": {
      "id": "string",
      "type": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "data": {
        "auth_code": "string"
      }
    },
    "payment": {
      "id": "string",
      "paymentable": {
        "type": "Subscription",
        "id": "string",
        "tax_name": "string",
        "tax_id": "string",
        "address": {
          "address_line_1": "string",
          "address_line_2": "string",
          "city": "string",
          "region": "string",
          "country": "string",
          "zip_code": "string"
        },
        "phone_number": "string"
      }
    },
    "payment_method": {
      "id": "string",
      "type": "card",
      "card": {
        "last4": "4242",
        "expiration_month": 12,
        "expiration_year": 2028,
        "network": "visa",
        "issuer_name": "string",
        "wallet": "apple_pay"
      },
      "address": {
        "address_line_1": "string",
        "address_line_2": "string",
        "city": "string",
        "region": "string",
        "country": "string",
        "zip_code": "string"
      },
      "phone_number": "string"
    }
  },
  "payment": {
    "id": "string",
    "paymentable": {
      "type": "string",
      "id": "string",
      "tax_name": "string",
      "tax_id": "string",
      "address": {
        "address_line_1": "string",
        "address_line_2": "string",
        "city": "string",
        "region": "string",
        "country": "string",
        "zip_code": "string"
      },
      "phone_number": "string"
    }
  },
  "customer_id": "string",
  "user_id": "string",
  "customer": {
    "id": "string",
    "email": "string",
    "full_name": "string"
  },
  "failure_reason": "string",
  "amount_in_cents": 500,
  "currency": "GTQ",
  "fee": 1,
  "vat_withheld": 1,
  "vat_withheld_currency": "string",
  "used_presaved_payment_method": true,
  "amount_set_in_browser": true,
  "product": {
    "id": "string"
  },
  "products": [
    {
      "id": "prod_9lstwgbr",
      "status": "active",
      "tax_category": "good",
      "name": "El nombre de tu producto",
      "description": "string",
      "success_url": "string",
      "cancel_url": "string",
      "custom_terms_and_conditions": "string",
      "phone_requirement": "optional",
      "address_requirement": "none",
      "billing_info_requirement": "optional",
      "has_dynamic_pricing": false,
      "payment_method_types": [
        "card",
        "bank_transfer"
      ],
      "available_installments": [
        3,
        6
      ],
      "inventory_quantity": 12,
      "low_stock_threshold": 3,
      "prices": [
        {
          "id": "price_rky4dog7",
          "status": "active",
          "amount_in_cents": 500,
          "currency": "GTQ",
          "charge_type": "one_time",
          "billing_interval": "month",
          "billing_interval_count": 1,
          "periods_before_automatic_cancellation": 1,
          "free_trial_interval": "string",
          "free_trial_interval_count": 1,
          "proration_behavior": "none",
          "billing_cycle_anchor_day": 1,
          "defer_to_billing_day": true
        }
      ],
      "storefront_link": "https://app.recurrente.com/s/surf-office/el-nombre-de-tu-producto",
      "metadata": {},
      "custom_fields": [
        {
          "id": "ccf_xxxxxxxxxxxx",
          "key": "engraving",
          "type": "text",
          "label": {
            "_original": "Mensaje de grabado",
            "en": "Engraving message",
            "es": "Mensaje de grabado"
          },
          "optional": false,
          "minimum_length": 1,
          "maximum_length": 1,
          "default_value": "string",
          "options": [
            {
              "label": "string",
              "value": "string"
            }
          ]
        }
      ],
      "options": [
        {
          "name": "Talla",
          "values": [
            "S",
            "M",
            "L"
          ]
        }
      ],
      "variants": [
        {
          "id": "var_9lstwgbr",
          "product_id": "prod_9lstwgbr",
          "status": "active",
          "title": "M / Rojo",
          "option_values": [
            "M",
            "Rojo"
          ],
          "sku": "string",
          "price_id": "price_3kd9sla2",
          "amount_in_cents": 12500,
          "currency": "GTQ",
          "inventory_quantity": 1,
          "low_stock_threshold": 3
        }
      ],
      "quantity": 1
    }
  ],
  "tax_invoice_url": "https://app.recurrente.com/f/340B4ACC-0435-4BE5-8EBD-9F4D92AED618",
  "channel": "POS"
}

Adjunta una URL de factura fiscal a un payment intent exitoso. Solo los intents con status succeeded pueden ser actualizados.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Path parameters

idstringRequired

ID del payment intent

Request

This endpoint expects an object.

payment_intentobjectRequired

Response

Payment intent actualizado

idstringOptional

ID del payment intent

receipt_numberintegerOptional

Número de recibo

api_versionstringOptional

Versión de la API

live_modebooleanOptional

true en pagos reales; false en eventos simulados de checkouts de prueba.

created_atdatetimeOptional

Fecha de creación

checkoutobjectOptional

paymentobject or nullOptional

Información del pago

customer_idstringOptional

ID del cliente

user_idstringOptional

ID del usuario

customerobjectOptional

failure_reasonstring or nullOptional

Razón de fallo (si aplica)

amount_in_centsintegerOptional

Monto en centavos

currencystringOptional

Moneda

feeintegerOptional

Comisión cobrada

vat_withheldintegerOptional

IVA retenido

vat_withheld_currencystring or nullOptional

Moneda del IVA retenido

used_presaved_payment_methodbooleanOptional

Si se usó un método de pago guardado

amount_set_in_browserbooleanOptional

El monto lo fijó el navegador del comprador (botón de Clave en el sitio del comercio, con ítems con monto inline y sin firma). Compáralo con tu pedido antes de entregar.

productobjectOptional

productslist of objectsOptional

Productos incluidos en el pago

tax_invoice_urlstring or nullOptional

Public page for the payment’s final certified tax document (invoice, receipt, or donation receipt). Exempt accounts default to receipts; NGOs default to donation receipts and can choose receipts in invoicing settings. The page links to the certifier’s copy; tax_invoice_uuid remains the authorization number.

channelenumOptional

Origen exacto del cobro con tarjeta. Usa POS para una terminal física, Celular como POS para cobros desde un teléfono y Link de pago para cobros con tarjeta en línea.

Allowed values:

Errors

400

Bad Request Error