Ir al contenido
Payku Docs

Wallet

Permite generar transacciones bancarias desde tu billetera virtual payku.

URL base: https://app.payku.cl/ (Default server) · https://des.payku.cl/ (Sandbox server)

Realizar pagos a terceros desde mi wallet

Sección titulada «Realizar pagos a terceros desde mi wallet»
POST/api/wallet/payout

Este método permite crear una orden de pago a un tercero utilizando los fondos de tu billetera virtual payku.

Nota: Para fines de prueba (Solo ambiente desarrollo), los montos específicos se procesarán automáticamente:
• Montos 1000, 2000, 3000: Se marcarán como aprobados automáticamente.
• Montos 1500, 2500, 3500: Se marcarán como rechazados automáticamente.

Cuerpo de la solicitud

ParámetroTipoDescripción
emailrequerido string <email>

Email del usuario

máximo 50 caracteres
Ejemplo: [email protected]
phone string

Télefono del usuario. Formato: 519YYYYYYYY

máximo 20 caracteres
Ejemplo: 51906310864
subjectrequerido string

Descripción de la orden

máximo 200 caracteres
Ejemplo: test Gmoney peru
currencyrequerido string

Tipo de moneda (Formato ISO)

máximo 6 caracteres
Ejemplo: PEN
orderrequerido string

Orden del comercio

máximo 50 caracteres
Ejemplo: 0011010101777
amountrequerido integer

Monto de la orden.

Nota: el monto mínimo es de 5 soles (PEN) y el monto máximo es de 30000 soles (PEN).

máximo 14 dígitos
Ejemplo: 1
accountbank_namerequerido string

Nombre del titular de la cuenta

máximo 180 caracteres
Ejemplo: PAYKU PERU SAC
accountbank_rutrequerido string

Documento de identidad del titular de la cuenta en Perú: DNI, Cédula de Extranjería (CE) o Pasaporte. El nombre del campo se mantiene por compatibilidad. Ejemplo (DNI): 47566578

entre 7 a 12 caracteres
Ejemplo: 47566578
accountbank_sbifrequerido string

Código del banco al que pertenece la cuenta bancaria.

máximo 4 caracteres
Ejemplo: 011
accountbank_typerequerido string

Tipo de cuenta.

  • 1 Corriente
  • 3 Ahorro
máximo 1 caracterer
Ejemplo: 1
accountbank_numrequerido string

Número de CCI (Código de Cuenta Interbancario) del cliente.

Nota: El CCI interbancario es un número compuesto por 20 dígitos. Solo para el caso de YAPE, puede enviar el número de teléfono asociado.

Formato: 519YYYYYYYY

máximo 20 caracteres
Ejemplo: 01128901338000251968
url_notify string

url donde se notificare el resultado del pago.

  • Nota: Luego de realizar el pago a terceros payku respondera de forma automática al endpoint ingresado en urlnotify el resultado de la operación.
    • Ejemplo Aprobado:
    • {
      • "id": "mpexxzxxxx",
      • "identifier_payout": "mpexxzxxxx",
      • "order" : "367734544",
      • "status" : "success",
      • "update_at" : "2023-08-24 12:29:35",
      • "customer" : {
        • "name" : "Jhon Doe",
        • "phone" : "987654321",
        • "document" : "87654321",
        • "number" : "987654321"
      • }
    • }
    • Ejemplo Rechazado:
    • {
      • "id": "mpexxzxxxx",
      • "identifier_payout": "mpexxzxxxx",
      • "order" : "367734544",
      • "status" : "banking_error",
      • "update_at" : "2023-08-24 12:29:35",
      • "customer" : {
        • "name" : "Jhon Doe",
        • "phone" : "987654321",
        • "document" : "87654321",
        • "number" : "987654321"
      • }
    • }
máximo 600 caracteres
Ejemplo: https://www.youwebsite.com/urlnotify?orderClient=98745
additional_parameters object

Parámetros adicionales del cliente (Opcional).

máximo 4000 caracteres
parameter_1 string

Nombre del parámetro dado por el usuario payku

Ejemplo: keyValue
parameter_2 string

Nombre del parámetro dado por el usuario payku

Ejemplo: keyValue
order_ext string

Nombre de la orden externa dado por el usuario payku (Opcional)

Ejemplo: fff-777
Ventana de terminal
curl -X POST \
https://BASE-URL/api/wallet/payout \
-H 'Accept: application/json, text/plain, */*' \
-H 'Authorization: Bearer TOKEN-PUBLICO' \
-H 'Sign: SHA256-REQUEST-PATH-VALUE-TOKEN-PRIVADO'  \
-H 'Content-Type: application/json' \
-H 'Host: BASE-URL' \
-d '{
      "email": "[email protected]",
      "phone": "51906310864",
      "subject": "test Gmoney peru",
      "currency": "PEN",
      "order": "0011010101777",
      "amount": 1,
      "accountbank_name": "PAYKU PERU SAC",
      "accountbank_rut": "47566578",
      "accountbank_sbif": "011",
      "accountbank_type": "1",
      "accountbank_num": "01128901338000251968",
      "url_notify": "https://www.youwebsite.com/urlnotify?orderClient=98745",
      "additional_parameters":
      {
        "parameter_1": "keyValue",
        "parameter_2": "keyValue",
        "order_ext": "fff-777"
      }
    }'

Respuestas

200
{
  "status": "success",
  "identifier_wallet": "wab5f7232dafff18f9",
  "identifier_payout": "mpe33e36b01e8a11b9ee"
}
Campos de la respuesta
ParámetroTipoDescripción
status string

Estatus de la carga a la wallet.Los posibles estados que puede obtener son los siguientes:

  • success
  • failed
Ejemplo: success
identifier_wallet string

Identificador del movimiento de la billetera virtual de payku.

Ejemplo: wab5f7232dafff18f9
identifier_payout string

Identificador del pago a tercero.

Ejemplo: mpe33e36b01e8a11b9ee

Obtener payout V3

Sección titulada «Obtener payout V3»
GET/api/payoutv3/{identificadorPayout}

Este método permite obtener un movimiento de pagos a terceros de su billetera virtual payku mediante un identificador:

Para realizar la consulta es necesario agregar al final del endpoint lo siguiente /{identificadorPayout} como por ejemplo: api/payoutv3/mpe33e36b01e8a11b9ee.

curl -X GET \
https://BASE-URL/api/payoutv3/{identificadorPayout}  \
-H 'Accept: application/json, text/plain, */*' \
-H 'Authorization: Bearer TOKEN-PUBLICO' \
-H 'Sign: SHA256-REQUEST-PATH-VALUE-TOKEN-PRIVADO'  \
-H 'Content-Type: application/json' \
-H 'Host: BASE-URL' \

Respuestas

200
{
  "payout": {
    "id": "war3999847529816f2",
    "phone": "987654321",
    "email": "[email protected]",
    "subject": "subject order",
    "amount": "3680",
    "accountbank_rut": "111111111111",
    "accountbank_name": "test",
    "accountbank_type": 1,
    "accountbank_num": 123123123,
    "accountbank_sbif": "0001",
    "status": "pending",
    "update_at": "2023-06-09 21:10:46",
    "origin_wallet": "wa1933f37cdaf7d1c6",
    "reason_rejection": " Error CCA 51. Cuenta Beneficiario no Existe, error_creditor_account_not_found"
  }
}
Campos de la respuesta
ParámetroTipoDescripción
payout object

Datos cuenta destino.
id string

Identificador de la cuenta destino.

Ejemplo: war3999847529816f2
phone string

Teléfono del titular de cuenta destino.

Ejemplo: 987654321
email string

Correo del titular de cuenta destino.

Ejemplo: [email protected]
subject string

Estatus de la solicitud.

Ejemplo: subject order
amount string

Monto a depositado en la cuenta destino.

Ejemplo: 3680
accountbank_rut string

Documento de identidad del titular de la cuenta destino: DNI, Cédula de Extranjería (CE) o Pasaporte.

Ejemplo: 111111111111
accountbank_name string

Nombre del titular de la cuenta destino.

Ejemplo: test
accountbank_type integer

Tipo de cuenta del banco destino.

Ejemplo: 1
accountbank_num integer

Número de CCI (Código de Cuenta Interbancario) del banco destino o en caso de YAPE el número celular del beneficiario.

Ejemplo: 123123123
accountbank_sbif string

Código del banco al que pertenece la cuenta bancaria.

Ejemplo: 0001
status string

Estatus del movimiento.

  • pending ("payout registrado")
  • processing ("payout en proceso de pago")
  • success ("payout depositado exitosamente")
  • banking_error ("payout rechazado por el banco")
  • fraud_prevention ("payout rechazado por compliance")
Ejemplo: pending
update_at string

Fecha que se realizo la solicitud.

Ejemplo: 2023-06-09 21:10:46
origin_wallet string

Id de la wallet origen.

Ejemplo: wa1933f37cdaf7d1c6
reason_rejection string

Motivo del rechazo.

Ejemplo: Error CCA 51. Cuenta Beneficiario no Existe, error_creditor_account_not_found
2016 - 2026 | Payku SpA