Add/Update Payment

Usa esto para registrar un pago recibido fuera de Hyfin, como un cheque o efectivo, para que orden de compra lo refleje.


The following endpoint can be used to add or update a payment within the Hyfin application that were already processed.


Punto Final

The following endpoint can be used to add or update a payment. You must replace the {base_url} and {site_id} variable with the site id that was provided when the site was created.

POST
{base_url}/api/v3.1/site/{site_id}/payment/addUpdate

Solicitud
Campo
Tipo
Descripción
external_id
String
Tu propio id para este pago, desde tu software. Envía de nuevo el mismo external_id para actualizar este pago en lugar de agregar uno nuevo. Usamos este valor para hacer la coincidencia, pero no evitamos duplicados, así que manténgalo único dentro del sitio.
display_name
String
El nombre de visualización seguro y amigable del método de pago. Ejemplo: VISA **** 3421.
amount
Number
El monto que se pagó. Format = 0.00
paid_on
Timestamp
La fecha y hora en que se realizó el pago. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ssZ
gateway_transaction_id
String
El identificador único que se asignó al registro de pago desde la pasarela cuando se procesó el pago.
tip
Number
La cantidad de propina que se agregó. Format = 0.00
tax
Number
El monto de impuestos que se agregó. Format = 0.00
fee
Number
La cantidad de la tarifa que se agregó. Format = 0.00
invoice
Una referencia al registro de orden de compra. En una escritura, así es como el pago se aplica a orden de compra; se devuelve en una lectura, junto con la lista más completa allocations.
allow_missing_invoice
Boolean
Cuando invoice.external_id nombre una orden de compra que aún no se ha enviado, guarda el pago sin aplicarlo en lugar de rechazarlo. Una llamada a Add/Update Invoice con ese external_id dentro de 30 días le aplica el pago. Sin esto, el pago se rechaza con Invoice was not found y no se guarda nada.
Default = false
payment_type
String
El tipo de método de pago utilizado para realizar el pago.
One of payment_card, ach, eft, apple_pay, google_pay, oxxo, spei, bnpl, dlocal, cash, check, other
payment_sub_type
String
El subtipo del método de pago utilizado para realizar el pago.
One of visa, mastercard, amex, discover, diners, jcb, checking, savings, oxxo, spei, bnpl, google_pay, dlocal, cash, check, other
status
String
El estado actual del pago. created: registrado, pero aún no enviado al procesador. failed: el intento falló antes de que el procesador respondiera. declined: el procesador lo rechazó. expired: no se completó a tiempo. cancelled: se canceló antes de ser procesado. authorized: la tarjeta fue aprobada y los fondos están retenidos, pero aún no se han cobrado. captured: el pago se cobró y aún no se ha liquidado. settled: el procesador liquidó los fondos. voided: cancelado antes de liquidarse, por lo que no se movió dinero. refundRequested: un reembolso está esperando a que el pago se liquide. returned: el banco devolvió el pago. chargebacked: el titular de la tarjeta disputó el pago. Un reembolso es un pago independiente, con refunded, refundSettled o refundFailed.
Default = captured | One of failed, declined, created, expired, cancelled, authorized, captured, voided, settled, returned, refundFailed, refunded, refundSettled, chargebacked, refundRequested
transaction_type
String
El tipo de transacción. Se registra en el pago, pero no lo devuelve ningún endpoint de lectura.
One of sale, capture, refund, void
active
Boolean
Esta bandera representa si el registro de pago está activo.
Default = true
Sample Request
			
{
  "external_id": "65432325",
  "gateway_transaction_id": "53912387124235234",
  "payment_type": "payment_card",
  "payment_sub_type": "visa",
  "display_name": "VISA **** 5123",
  "amount": 35.15,
  "paid_on": "2021-01-01T14:32:18Z",
  "status": "captured",
  "invoice": {
    "external_id": "65432661"
  }
}


		
Respuesta
Campo
Tipo
Descripción
success
Boolean
Whether the record was added or updated successfully.
action
String
Informs whether the record was added or updated. Will only be returned if success is true.
One of added, updated
_id
String
The id we assign to the record.
id
String
The same id as _id, kept for backwards compatibility. Not returned on 4.0 and later.
errors
String [ ]
A list of errors. Will only be returned if success is false.
			
{
  "success": true,
  "action": "added",
  "_id": "60f720d248f143332af022e0",
  "id": "60f720d248f143332af022e0"
}


		

Ver también