🔍 Consultar solicitud de pago

GET /payment-request/{id}

Retorna el detalle de una solicitud de pago.

REQUEST

Headers

Atributo

Tipo

Requerido

Pattern

Descripcion

Authorization

String

Bearer

Puede consultar la sección (API Key) para más información.

Path Parameters

Atributo

Tipo

Requerido

Descripción

id

integer

ID de solicitud de pago a consultar.

Query Parameters

Atributo

Tipo

Requerido

Descripción

detail_retentions

boolean

No

Determina si la respuesta a esta petición, incluye el detalle de retenciones y percepciones aplicadas a un pago. Por defecto es false. Si la solicitud aún no fue pagada no se mostrará esta información.

GET Obtener Solicitud de Pago

https://api.sandbox.pagos360.com/payment-request/{id}

Headers

Content-Type

application/json


El tipo MIME del contenido del cuerpo enviado. Por defecto JSON es Unicode UTF-8. No se debe configurar otro charset.

Authorization

Bearer •••••••


Puede consultar la sección API Key para más información.

curl -X GET 'https://api.pagos360.com/payment-request/{id}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {api_key}'

📨 Respuesta

Una respuesta exitosa incluirá los mismos atributos presentes en la respuesta de crear solicitud de pago y adicionalmente los siguientes:

Atributo

Tipo

Descripción

id

Integer

ID de solicitud de pago.

type

String

Tipo de solicitud.

state

String

Estado de la solicitud de pago. (Más info).

created_at

DateTime

Fecha y hora de creación. (Formato ISO).

external_reference

String

Este atributo se puede utilizar como referencia para identificar la Solicitud de Pago y sincronizar con tus sistemas de backend el origen de la operación. Algunos valores comunmente utilizados son: ID de Cliente, DNI, CUIT, ID de venta o Nro. de Factura entre otros.

payer_name

String

Nombre del destinatario de la solicitud de pago.

payer_email

String

Email del destinatario de la solicitud de pago.

description

String

Descripción o concepto de la solicitud de pago.

first_due_ date

DateTime

Fecha de vencimiento de la solicitud de pago. (Formato ISO).

first_total

Float

Importe a cobrar. Formato: 00000000.00 (hasta 8 enteros y 2 decimales, utilizando punto “.” como separador decimal).

second_due_ date

DateTime

Fecha de segundo vencimiento de la solicitud de pago. (Formato ISO).

second_total

Float

Importe a cobrar pasada la primera fecha de vencimiento. Formato: 00000000.00 (hasta 8 enteros y 2 decimales, utilizando punto “.” como separador decimal).

checkout_url

String

URL para instanciar el checkout de pago online.

barcode

String

Código numérico del código de barra.

barcode_url

String

URL de la imagen del código de barra utilizado para pagar en las redes de pago en efectivo.

rapipago_barcode

String

Código numérico del código de barra de la entidad rapipago.

rapipago_barcode_ url

String

URL de la imagen del código de barra utilizado para pagar en la entidad rapipago.

pdf_url

String

URL de cupón de pago en formato pdf.

back_url_ success

String

En el caso de estar especificado el pagador será redirigido a esta URL ante un pago exitoso.

back_url_ pending

String

En el caso de estar especificado el pagador será redirigido a esta URL ante un pago pendiente.

back_url_ rejected

String

En el caso de estar especificado el pagador será redirigido a esta URL ante un pago rechazado.

metadata

Object

Objeto JSON que se puede utilizar para guardar atributos adicionales en la solicitud de pago y poder sincronizar con tus sistemas de backend. PAGOS360 no utiliza este objeto.

excluded_channels

Array [String]

Tipos de medios de pago que serán omitidos de las opciones al pagador. Valores posibles: credit_card, credit_card_agro, debit_card, banelco_pmc, link_pagos, DEBIN, wire_transfer, non_banking y QR. [Mas info](Mas info).

excluded_card_ brands

Array [String]

Códigos de las tarjetas que serán omitidas de las opciones al pagador. Valores posibles: campo code del endpoint Obtener Planes y Cuotas (Solo aplica para el medio de pago Tarjeta de Crédito). [Ver más](Ver más)

excluded_installments

Array [Int]

Número de las cuotas que serán omitidas de las opciones al pagador (Solo aplica para el medio de pago Tarjeta de Crédito).

holder_data

Object

Datos del pagador.

request_result

Array [Object]

Datos de los resultados.

items

Array [Object]

Objeto JSON que se puede utilizar para listar todos los productos o servicios asociados a la solicitud de pago, para que sean incluidos como un detalle del comprobante de pago.

risk_insights

Object

Objeto JSON que se puede utilizar para enviar datos adicionales que ayudan a predecir la probabilidad de que un pago sea fraudulento. Todos los campos a continuación, son opcionales, pero cuanto más se completen, más precisos serán

Atributos del objeto holder_data

Atributo

Tipo

Descripción

holder_name

string

Nombre del pagador indicado al crear la solicitud de pago.

holder_email

string

Dirección de correo electrónico indicada al crear la solicitud de pago.

holder_id_number

String

Número de documento ingresado por el pagador en el formulario de checkout.

holder_phone_number

String

Número de teléfono ingresado por el pagador en el formulario de checkout.

Atributos del objeto request_result

Atributo

Tipo

Descripción

id

integer

ID de resultado de intento de pago.

type

string

Tipo de resultado. Valores posibles: collected_payment_request_result, rejected_payment_request_result, refunded_payment_request_result y chargeback_payment_request_result.

channel

string

Medio de pago utilizado.

paid_at

date

Fecha en la que el pagador realizó el pago.

created_at

datetime

Fecha y hora en la que se recibió confirmación y/o autorización del medio de pago utilizado en la transacción.

available_at

date

Fecha en la cual los fondos son acreditados, según los plazos de acreditación vigentes para el medio de pago utilizado.

is_available

boolean

Indica si los fondos se encuentran disponibles.

amount

float

Importe pagado. Este importe es relativo a las fechas de vencimiento de la solicitud de pago.

gross_fee

float

Importe total deducido por el servicio de PAGOS360.

net_fee

float

Importe neto deducido por el servicio de PAGOS360.

fee_iva

float

Importe de IVA deducido por el servicio de PAGOS360.

net_amount

float

Importe total de fondos que se acreditarán en tu cuenta (diferencia entre lo cobrado y lo deducido).

state_comment

string

Información adicional sobre el estado del resultado. Cuando el pago es rechazado aquí se detalla el motivo.

reverted_at

datetime

Cuando un pago es revertido aquí se indica la fecha y hora en que dicha reversión fue informada.

payment_metadata

object

Información adicional sobre un pago con tarjeta. Ver a continuación sus atributos.

retentions

array [object]

Detalle de retenciones y percepciones impositivas aplicadas a un pago. Ver a continuación sus atributos.

Atributos del objeto payment_metadata

Atributo

Tipo

Descripción

holder_name

string

Nombre indicado por el pagador en el Checkout de PAGOS360.

holder_email

string

Dirección de correo electrónico indicada por el pagador en el Checkout de PAGOS360.

authorization_code

string

Código de autorización.

card_brand

string

Marca de la tarjeta utilizada.

card_last_four_digits

string

Últimos 4 dígitos de la tarjeta utilizada.

amount

float

Cargo total realizado en la tarjeta. Si el pago fue en cuotas con interés financiero, diferirá del atributo amount del objeto reques_result.

installments

integer

Cantidad de cuotas o plan de financiación elegido por el pagador.

installment_amount

float

Importe de referencia de cada cuota. Al tratarse de un cálculo redondeado a 2 decimales puede diferir de otros métodos de cálculo.

(_) Nota: En general el atributo _amount* del objeto payment_metadata será igual al atributo amount del objeto request_result. Sin embargo, en aquellos casos donde el pagador haya optado por pagar en cuotas que impliquen interés financiero, los valores podrán diferir.

Atributos del objeto retentions

Atributo

Tipo

Descripción

id

integer

ID de la retención o percepción impositiva aplicada.

type

string

Tipo de impuesto. Valores posibles: IVA, Ganancias, IIBB, Imp. Crédito, Imp. Débito

jurisdiction

string

Determina si la jurisdicción del impuesto es nacional o provincial.

aliquot

string

Descripción de la alícuota aplicada.

tax_base

float

Base imponible sobre la que se realizó el cálculo.

amount

float

Importe aplicado.

regime_code

string

Código de régimen impositivo.

certificate_id

integer

Número de certificado de retención o percepción. Este atributo no se visualiza hasta que el certificado es emitido lo que sucede de manera asíncrona.

Atributos del objeto items

Atributo

Tipo

Descripción

quantity

Integer

Cantidad del producto o servicio.

description

String

Descripción del producto o servicio (hasta 255 caracteres).

amount

Float

Importe del producto o servicio. Formato: 00000000.00 (hasta 8 enteros y 2 decimales, utilizando punto “.” como separador decimal).

Atributos del objeto risk_insights

Atributo

Tipo

Descripción

site

string

Descripción del sitio web, punto de venta o identificador de la app donde se originó la transacción.

ip

string

Dirección IP del usuario que originó la transacción. Puede enviar una dirección IPv4 o IPv6. El campo distingue entre mayúsculas y minúsculas. Ej: 1.1.1.1 o 2001:db8:3333:4444:5555:6666:7777:8888 (nunca debe ser una dirección IP privada o reservada, del tipo 10.x.x.x o 192.168.x.x).

ua_string

string

Campo User-Agent de la cabecera HTTP.

device_id

string

Hash identificador del dispositivo (device fingerprint).

user_nationality

string

Nacionalidad del usuario, utilizando el código de país de 2 letras definidos en la ISO 3166-1 alpha-2. (Argentina = AR)

user_id_ type

string

Tipo de documento de identificación del usuario: NATIONAL_ID = Identificaciones nacionales (ej: DNI), PASSPORT = Pasaporte, OTHER = otro tipo de documentespecificado.

user_id

string

Número de documento de identificación del usuario.

user_full_ name

string

Nombre y apellido completo del usuario.

user_first_ name

string

Nombres del usuario.

user_last_ name

string

Apellidos del usuario.

user_birth

date

Fecha de nacimiento del usuario en formato DD-MM-AAAA (ej: 01-01-1983).

user_gender

string

Género del usuario: M = Masculino, F = Femenino, X = comprende a la autopercepción de género con la que pudiera identificarse una persona quse sienta comprendida en el binomio masculino/femenino.

user_email

string

Dirección de correo electrónico del usuario.

user_phone

string

Número de teléfono del usuario.

user_verif_ level

string

Nivel de validación de los datos identificativos del usuario (si se realizan múltiples validaciones indicar la de mayor confianza): NA se realizó ninguna verificación de los datos proporcionados por el usuario, EMAIL = se verificó que la dirección de correo electrónico es válida y es confiable, PHONE = se verificó que el número de teléfono es válido y es confiable, ADDRESS = se verificó que el domicilio de entrega es válido y es confiable, DOC_ID = se verificó que el documento de identificación es válido y es confiable, GOV_ CHECK = se verificó contra una base de datos gubernamental (ej: institutos electorales, registros de población, migraciones, etc.) que el documento de identificación es válido y es confiable, BIOMETRIC = se verificó que la foto en el documento de identificación coincide con una foto selfie o video del usuario, LIVENESS = el usuario superó un desafío biométrico aleatorio de prueba de vida, OTHER = otro nivel de validación especificado.

user_bank_ account

string

Cuenta bancaria del usuario. Para cuentas de Argentina se debe utilizar CBU/CVU.

user_street

string

Domicilio del usuario: Calle y número.

user_street2

string

Domicilio del usuario: Piso, departamento, unidad, barrio, etc.

user_postcode

string

Domicilio del usuario: Código postal. Para domicilios de Argentina se debe utilizar formato CPA.

user_city

string

Domicilio del usuario: Ciudad o localidad.

user_state

string

Domicilio del usuario: Provincia o estado.

user_country

string

Domicilio del usuario: País utilizando el código de 2 letras definidos en la ISO 3166-1 alpha-2. (Argentina = AR)

profile_uid

string

Identificador único asociado al perfil del usuario registrado en tu sitio.

profile_created

timestamp

Marca de tiempo en que el usuario se registró por primera vez en tu sitio, utilizando el formato de hora UNIX y la zona horaria UTC, sin milisegundos. Ejemplo: 1673302661. Referencia: epoch converter.

profile_auth_ method

string

Método de autenticación del usuario en tu sitio: USR_DATA = si se utilizan datos personales para acceder (ej: email + DNI), SVC_ DATA = si se utilizan datos vinculados a un servicio para acceder (ej: nro. de cliente + nro. de factura, unidad de facturación, etc.), PWD = si se utiliza una contraseña o combinación de usuario y contraseña, OTP = si se envía por email o sms un código de un solo uso para acceder, MFA = si se requiere un segundo factor de autenticación para acceder (ej: uso de token virtual o físico), OTHER = otro método de autenticación especificado.

order_id

string

Identificador de la orden asociada a la transacción.

order_items

Array [Object]

Los ítems describen los bienes o servicios específicos asociados a la transacción.

item_store

string

Cuando el usuario pueden comprar en un mismo sitio a diferentes vendedores, este atributo identifica al vendedor o tienda quofrece el ítem. Ejemplo: Electrodomésticos ACME.

item_category

string

Categoría a la que pertenece el ítem. Ejemplos: electrónica, indumentaria, etc.

item_is_ intangible

boolean

Indica si el ítem es un servicio intangible o digital (ej: softwares, seguros, consultorías, cursos online, membresías, etc.).

item_id

string

Identificador del ítem. Por lo general código SKU si es un producto, o número de contrato si es un servicio. Este valor debe enviarse como texto sin formato (sin markup o valores Unicode).

item_name

string

Descripción generalizada o de alto nivel del ítem. Este valor debe enviarse como texto sin formato (sin markup o valores Unicode).

item_description

string

Detalle o descripción del ítem. Este valor debe enviarse como texto sin formato (sin markup o valores Unicode).

item_price

float

Precio unitario del ítem.

item_quantity

integer

La cantidad de ítems incluidos en la orden.site

billing_name

string

Nombre o razón social para la factura.

billing_street

string

Domicilio de facturación: Calle y número.

billing_street2

string

Domicilio de facturación: Piso, departamento, unidad, barrio, etc.

billing_postcode

string

Domicilio de facturación: Código postal. Para domicilios de Argentina se debe utilizar formato CPA.

billing_city

string

Domicilio de facturación: Ciudad o localidad.

billing_state

string

Domicilio de facturación: Provincia o estado.

billing_country

string

Domicilio de facturación: País utilizando el código de 2 letras definidos en la ISO 3166-1 alpha-2. (Argentina = AR)

shipping_method

string

Método de envío o empresa. Ejemplos: Correo Argentino, Andreani, Ocasa, Pickit, PUDO, etc.

shipping_name

string

Persona autorizada para recibir la entrega.

shipping_phone

string

Número de teléfono registrado para la entrega del producto.

shipping_street

string

Domicilio de entrega o prestación del servicio: Calle y número.

shipping_street2

string

Domicilio de entrega o prestación del servicio: Piso, departamento, unidad, barrio, etc.

shipping_postcode

string

Domicilio de entrega o prestación del servicio: Código postal. Para domicilios de Argentina se debe utilizar formato CPA.

shipping_city

string

Domicilio de entrega o prestación del servicio: Ciudad o localidad.

shipping_state

string

Domicilio de entrega o prestación del servicio: Provincia o estado.billing_name

shipping_country

string

Domicilio de entrega o prestación del servicio: País utilizando el código de 2 letras definidos en la ISO 3166-1 alpha-2. (Argentina = AR)

custom_fields

object

Conjuntos de campos relevantes en determinados casos de uso o industrias específicas. Pueden ser del tipo string, booleanshipping_country

Example Response

{ "id": 5, "type": "payment_request", "state": "paid", "created_at": "2019-02-22T17:38:23-03:00", "external_reference": "AWSL88", "payer_name": "nombre_pagador", "payer_email": "payer@example.com", "description": "concepto_del_pago", "first_due_date": "2019-02-26T00:00:00-03:00", "first_total": 1554.97, "checkout_url": "https://checkout.pagos360.com/payment-request/cc94799a-36e1-11e4-a340-acde48001122", "request_result": [ { "id": 7, "type": "collected_payment_request_result", "channel": "Pago Fácil", "paid_at": "2017-02-12T00:00:00-03:00", "created_at": "2019-02-22T17:38:24-03:00", "available_at": "2017-02-16T00:00:00-03:00", "is_available": false, "amount": 2503.95, "gross_fee": 151.49, "net_fee": 125.2, "fee_iva": 26.29, "net_amount": 2352.46 } ] }