API PAGOS360 1.0.0

La API para desarrolladores de PAGOS360 permite administrar aspectos de tu cuenta PAGOS360. Aquí podrás explorar los diferentes endpoints, consultar las descripciones y ver ejemplos de peticiones (requests) y respuestas (responses) en algunos de los lenguajes de programación más populares.

Server

https://api.sandbox.pagos360.com

Sandbox (Test)

https://api.pagos360.com

Producción

Authentication

http bearerAuth

Todas las peticiones privadas requieren una API Key, que es un token de acceso del tipo Bearer que se envía en cada petición HTTP por medio de la cabecera (header) Authorization.Las API Key pueden ser generadas accediendo a tu cuenta PAGOS360 desde la sección de Integraciones.

Solicitudes De Pago

Requerimientos individuales de cobro que se envían o generan para que una persona abone un importe específico.

POST

/payment-request

GET

/payment-request/{id}

GET

/helper/channel-installments/{amount}

Crear Solicitud de Pago

Crea una nueva solicitud de pago individualizando la intención de recibir un cobro.

Auth

Request Body

object	object
payment_request	object
description	string
first_due_date	string
first_total	number
payer_name	string
external_reference	string
second_due_date	string
second_total	number
payer_email	string

POST /payment-request

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.sandbox.pagos360.com/payment-request' \ --header 'Authorization: Bearer {token}' \ --data '{  "payment_request": {    "description": "{string}",    "first_due_date": "{string}",    "first_total": "{number}",    "payer_name": "{string}",    "external_reference": "{string}",    "second_due_date": "{string}",    "second_total": "{number}",    "payer_email": "{string}"  }}'
Copy

Responses

201

Created

object	object
id	integer
type	string
state	string
created_at	string
payer_name	string
description	string
first_due_date	string
first_total	number
checkout_url	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "type": "{string}", "state": "{string}", "created_at": "{string}", "payer_name": "{string}", "description": "{string}", "first_due_date": "{string}", "first_total": "{number}", "checkout_url": "{string}"}
Copy

Obtener Solicitud de Pago

Retorna el detalle de una solicitud de pago.

Auth

Path Params

id integer

Query String

detail_retentions boolean

GET /payment-request/{id}

xxxxxxxxxx
 
curl --get \ --url 'https://api.sandbox.pagos360.com/payment-request/%7Bid%7D' \ --header 'Authorization: Bearer {token}' \ --data detail_retentions={detail_retentions}
Copy

Responses

200

object	object
id	integer
state	string
first_total	number

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}", "first_total": "{number}"}
Copy

Obtener Planes y Cuotas

Retorna el detalle de los planes y cuotas disponibles para un monto determinado.

Auth

Path Params

amount number

GET /helper/channel-installments/{amount}

xxxxxxxxxx
 
curl --get \ --url 'https://api.sandbox.pagos360.com/helper/channel-installments/%7Bamount%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

array	array[object]
name	string
code	string
installments	array[object]
installments	integer
description	string
total_amount	number

Response

xxxxxxxxxx
 
[ {  "name": "{string}",  "code": "{string}",  "installments": [   {    "installments": "{integer}",    "description": "{string}",    "total_amount": "{number}"   }  ] }]
Copy

Debito Automatico En Cbu

Cobro de cuotas, suscripciones o servicios mensuales, debitando el dinero directamente de la cuenta bancaria del cliente final.

/adhesion/{id}/cancel

/debit-request/{id}/cancel

POST

/validator/next-business-day

Crear Adhesión

Crea una nueva adhesión a débito automático en CBU.

Auth

Request Body

object	object
adhesion	object
adhesion_holder_name	string
email	string
description	string
short_description	string
cbu_number	string
cbu_holder_name	string
cbu_holder_id_number	integer

POST /adhesion

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.sandbox.pagos360.com/adhesion' \ --header 'Authorization: Bearer {token}' \ --data '{  "adhesion": {    "adhesion_holder_name": "{string}",    "email": "{string}",    "description": "{string}",    "short_description": "{string}",    "cbu_number": "{string}",    "cbu_holder_name": "{string}",    "cbu_holder_id_number": "{integer}"  }}'
Copy

Responses

201

Created

object	object
id	integer
state	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}"}
Copy

Obtener Adhesión

Retorna el detalle de una adhesión a débito automático.

Auth

Path Params

id integer

GET /adhesion/{id}

xxxxxxxxxx
 
curl --get \ --url 'https://api.sandbox.pagos360.com/adhesion/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
id	integer
state	string
cbu_number	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}", "cbu_number": "{string}"}
Copy

Cancelar Adhesión

Cancela una adhesión a débito automático.

Auth

Path Params

id integer

PUT /adhesion/{id}/cancel

xxxxxxxxxx
 
curl --request PUT \ --url 'https://api.sandbox.pagos360.com/adhesion/%7Bid%7D/cancel' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
id	integer
state	string
state_comment	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}", "state_comment": "{string}"}
Copy

Crear Solicitud de Débito

Crea una nueva solicitud de débito en base a una adhesión en CBU.

Auth

Request Body

object	object
debit_request	object
adhesion_id	integer
description	string
first_due_date	string
first_total	number

POST /debit-request

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.sandbox.pagos360.com/debit-request' \ --header 'Authorization: Bearer {token}' \ --data '{  "debit_request": {    "adhesion_id": "{integer}",    "description": "{string}",    "first_due_date": "{string}",    "first_total": "{number}"  }}'
Copy

Responses

201

Created

object	object
id	integer
state	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}"}
Copy

Obtener Solicitud de Débito

Retorna el detalle de una solicitud de débito.

Auth

Path Params

id integer

Query String

detail_retentions boolean

GET /debit-request/{id}

xxxxxxxxxx
 
curl --get \ --url 'https://api.sandbox.pagos360.com/debit-request/%7Bid%7D' \ --header 'Authorization: Bearer {token}' \ --data detail_retentions={detail_retentions}
Copy

Responses

200

object	object
id	integer
state	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}"}
Copy

Cancelar Solicitud de Débito

Cancela una solicitud de débito.

Auth

Path Params

id integer

PUT /debit-request/{id}/cancel

xxxxxxxxxx
 
curl --request PUT \ --url 'https://api.sandbox.pagos360.com/debit-request/%7Bid%7D/cancel' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
id	integer
state	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}"}
Copy

Obtener Siguiente Día Hábil

Obtener el próximo día hábil a partir de una fecha dada.

Auth

Request Body

object	object
next_business_day	object
date	string
days	integer

POST /validator/next-business-day

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.sandbox.pagos360.com/validator/next-business-day' \ --header 'Authorization: Bearer {token}' \ --data '{  "next_business_day": {    "date": "{string}",    "days": "{integer}"  }}'
Copy

Responses

200

string string

Response

xxxxxxxxxx
 
{ "schema": "{string}"}
Copy

Debito Automatico En Tarjeta

Funciona de manera muy similar al débito en CBU, pero está orientado a tarjetas de crédito.

/card-adhesion/{id}/cancel

POST

/card-debit-request

GET

/card-debit-request/{id}

PUT

/card-debit-request/{id}/cancel

Crear Adhesión en Tarjeta

Crea una nueva adhesión a débito automático en tarjeta.

Auth

Request Body

object	object
card_adhesion	object
adhesion_holder_name	string
external_reference	string
email	string
card_holder_name	string
card_number	string
description	string

POST /card-adhesion

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.sandbox.pagos360.com/card-adhesion' \ --header 'Authorization: Bearer {token}' \ --data '{  "card_adhesion": {    "adhesion_holder_name": "{string}",    "external_reference": "{string}",    "email": "{string}",    "card_holder_name": "{string}",    "card_number": "{string}",    "description": "{string}"  }}'
Copy

Responses

201

Created

object	object
id	integer
state	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}"}
Copy

Obtener Adhesión en Tarjeta

Retorna el detalle de una adhesión a débito automático en tarjeta.

Auth

Path Params

id integer

GET /card-adhesion/{id}

xxxxxxxxxx
 
curl --get \ --url 'https://api.sandbox.pagos360.com/card-adhesion/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
id	integer
state	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}"}
Copy

Cancelar Adhesión en Tarjeta

Cancela una adhesión a débito automático en Tarjeta.

Auth

Path Params

id integer

PUT /card-adhesion/{id}/cancel

xxxxxxxxxx
 
curl --request PUT \ --url 'https://api.sandbox.pagos360.com/card-adhesion/%7Bid%7D/cancel' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
id	integer
state	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}"}
Copy

Crear Solicitud de Débito en Tarjeta

Crea una nueva solicitud de débito en tarjeta.

Auth

Request Body

object	object
card_debit_request	object
card_adhesion_id	integer
month	integer
year	integer
amount	number
description	string

POST /card-debit-request

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.sandbox.pagos360.com/card-debit-request' \ --header 'Authorization: Bearer {token}' \ --data '{  "card_debit_request": {    "card_adhesion_id": "{integer}",    "month": "{integer}",    "year": "{integer}",    "amount": "{number}",    "description": "{string}"  }}'
Copy

Responses

201

Created

object	object
id	integer
state	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}"}
Copy

Obtener Solicitud de Débito en Tarjeta

Retorna el detalle de una solicitud de débito en tarjeta.

Auth

Path Params

id integer

Query String

detail_retentions boolean

GET /card-debit-request/{id}

xxxxxxxxxx
 
curl --get \ --url 'https://api.sandbox.pagos360.com/card-debit-request/%7Bid%7D' \ --header 'Authorization: Bearer {token}' \ --data detail_retentions={detail_retentions}
Copy

Responses

200

object	object
id	integer
state	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}"}
Copy

Cancelar Solicitud de Débito en Tarjeta

Cancela una solicitud de débito en tarjeta.

Auth

Path Params

id integer

PUT /card-debit-request/{id}/cancel

xxxxxxxxxx
 
curl --request PUT \ --url 'https://api.sandbox.pagos360.com/card-debit-request/%7Bid%7D/cancel' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
id	integer
state	string

Response

xxxxxxxxxx
 
{ "id": "{integer}", "state": "{string}"}
Copy

Reportes

Es la sección donde se consolida toda la información transaccional. Permite acceder a los datos de todas las operaciones realizadas, estados de cuenta y conciliaciones.

GET

/report/collection/{date}

GET

/report/chargeback/{date}

GET

/report/refund/{date}

GET

/report/settlement/{date}

GET

/report/retentions/{date}

Obtener Cobranzas

Retorna todas las cobranzas para el día especificado.

Auth

Path Params

date string

GET /report/collection/{date}

xxxxxxxxxx
 
curl --get \ --url 'https://api.sandbox.pagos360.com/report/collection/%7Bdate%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
account_id	string
total_collected	number
data	array[object]
request_id	integer
amount_paid	number

Response

xxxxxxxxxx
 
{ "account_id": "{string}", "total_collected": "{number}", "data": [  {   "request_id": "{integer}",   "amount_paid": "{number}"  } ]}
Copy

Obtener Reversiones

Retorna todas las Reversiones para el día especificado.

Auth

Path Params

date string

GET /report/chargeback/{date}

xxxxxxxxxx
 
curl --get \ --url 'https://api.sandbox.pagos360.com/report/chargeback/%7Bdate%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
account_id	string
total_chargeback	number
data	array[object]
request_id	integer
reverted_amount	number

Response

xxxxxxxxxx
 
{ "account_id": "{string}", "total_chargeback": "{number}", "data": [  {   "request_id": "{integer}",   "reverted_amount": "{number}"  } ]}
Copy

Obtener Devoluciones

Retorna todas las devoluciones para el día especificado.

Auth

Path Params

date string

GET /report/refund/{date}

xxxxxxxxxx
 
curl --get \ --url 'https://api.sandbox.pagos360.com/report/refund/%7Bdate%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
account_id	string
total_refunded	number
data	array[object]
request_id	integer
refunded_amount	number

Response

xxxxxxxxxx
 
{ "account_id": "{string}", "total_refunded": "{number}", "data": [  {   "request_id": "{integer}",   "refunded_amount": "{number}"  } ]}
Copy

Obtener Rendición

Retorna el detalle de transacciones que conforman una rendición para el día especificado.

Auth

Path Params

date string

GET /report/settlement/{date}

xxxxxxxxxx
 
curl --get \ --url 'https://api.sandbox.pagos360.com/report/settlement/%7Bdate%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
account_id	string
settlement_amount	number
data	array[object]
request_id	integer
credit	number

Response

xxxxxxxxxx
 
{ "account_id": "{string}", "settlement_amount": "{number}", "data": [  {   "request_id": "{integer}",   "credit": "{number}"  } ]}
Copy

Obtener Retenciones y Percepciones

Retorna todas las retenciones y percepciones para el día especificado.

Auth

Path Params

date string

GET /report/retentions/{date}

xxxxxxxxxx
 
curl --get \ --url 'https://api.sandbox.pagos360.com/report/retentions/%7Bdate%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
account_id	string
total_amount	number
data	array[object]
request_id	integer
amount	number

Response

xxxxxxxxxx
 
{ "account_id": "{string}", "total_amount": "{number}", "data": [  {   "request_id": "{integer}",   "amount": "{number}"  } ]}
Copy

Cuenta Pagos360

Es el panel principal de control. Desde aqui se puede consultar el saldo de los fondos disponibles y el dinero que está próximo a liquidarse. Además, a nivel integración, permite realizar consultas para saber el estado de la cuenta en tiempo real.

GET

/account/balances

Obtener Saldos

Retorna el saldo disponible, el saldo pendiente y el ID identificador de tu cuenta PAGOS360.

Auth

GET /account/balances

xxxxxxxxxx
 
curl --get \ --url 'https://api.sandbox.pagos360.com/account/balances' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
user_account_id	string
available_balance	number
unavailable_balance	number

Response

xxxxxxxxxx
 
{ "user_account_id": "{string}", "available_balance": "{number}", "unavailable_balance": "{number}"}
Copy