Actualizar pago

PATCH /payments/{id}

Actualiza un pago existente a través del ID

Parámetros

idstringrequired

ID del pago previamente enviado o generado en la creación.

Cuerpo de la solicitud

paymentobjectrequired
payment object
statusstring enumrequired

Estado final del pago. Consulte la documentación para más detalles sobre los estados posibles.

Allowed: succeeded declined failed blocked
methodobject

Método de pago. Utilizar este parámetro solo cuando sea necesario complementar datos que no pudieron ser transmitidos en la creación.

method object
typestring enum

Tipo del método de pago.

Allowed: credit_card debit_card
cardobject
card object
networkstring enumrequired

Red de tarjeta

Allowed: visa mastercard american_express diners_club elo hipercard jcb discover other
presencestring enumrequired

Indica si la transacción fue realizada con tarjeta presente (CP) o tarjeta no presente (CNP). Consulte la documentación sobre presencia de tarjetas para más información.

Allowed: card_present card_not_present
binstring \| null

Primeros 8 números del PAN que identifican al emisor de la tarjeta (conocido también como IIN)

last_fourstring \| null

Últimos 4 números del PAN

transactionsarray

Lista de intentos de transacción para este pago. Obligatorio si el `status` del pago es `succeeded` o `declined`. Recomendable para `failed` y `blocked` si hay intentos de transacción.

transactions[] item
idstring

Código identificador único de la transacción. Consulte la documentación para más detalles sobre el código de la transacción.

statusstring enumrequired

Estado de retorno del intento de transacción. Consulte la documentación para más detalles sobre los estados posibles.

Allowed: succeeded declined failed
durationinteger

Tiempo de ejecución de la transacción en milisegundos (1 segundo = 1000 milisegundos).

timestampdate-time \| null

Fecha y hora en que se inició la transacción en formato ISO 8601. Si no se envía, se usará la hora actual. El plazo máximo para envío retroactivo (backfill) es de 24 horas. No se permiten horarios futuros.

connectorobjectrequired

Información sobre el conector de pago utilizado en la transacción. El conector puede ser un adquirente, un subadquirente o un gateway.

connector object
idstringrequired

Código de la integración con el conector. Informe un código que represente un contrato de afiliación o una conexión de integración específica. Recomendamos prefijar el código con el tipo del conector para facilitar consultas en reportes.

typestringrequired

Tipo del conector. Consulte la documentación para obtener la lista completa.

response_codestring \| null

Código de respuesta alfanumérico del intento. Para tarjeta de crédito en Brasil, utilizar preferentemente el estándar determinado por la normativa 21 de ABECS. Obligatorio si `transaction.status` es `succeeded` o `declined`. Recomendable para `failed` cuando está presente.

Respuestas

200Pago actualizado con éxito
401Credenciales de acceso inválidas
Response body
errorsarray
errors[] item
fieldstring

Campo de la solicitud donde ocurrió el error

typestring

Código del tipo del error

messagestring

Mensaje del error

422Parámetros inválidos
Response body
errorsarray
errors[] item
fieldstring

Campo de la solicitud donde ocurrió el error

typestring

Código del tipo del error

messagestring

Mensaje del error

404Objeto no encontrado
Response body
errorsarray
errors[] item
fieldstring

Campo de la solicitud donde ocurrió el error

typestring

Código del tipo del error

messagestring

Mensaje del error

{
  "payment": {
    "status": "succeeded",
    "method": {
      "type": "credit_card",
      "card": {
        "network": null,
        "presence": null,
        "bin": null,
        "last_four": null
      }
    },
    "transactions": [
      {
        "id": null,
        "status": null,
        "duration": null,
        "timestamp": null,
        "connector": null
      }
    ]
  }
}