Wallet

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

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ámetro	Tipo	Descripción
emailrequerido	string <email>	Email del usuario máximo 50 caracteres Ejemplo: [email protected]
phone	string	Télefono del usuario máximo 20 caracteres Ejemplo: 04149876543
subjectrequerido	string	Descripción de la orden máximo 200 caracteres Ejemplo: description of the order
currencyrequerido	string	Tipo de moneda (Formato ISO) máximo 6 caracteres Ejemplo: VES
orderrequerido	string	Orden del comercio máximo 50 caracteres Ejemplo: order-commerce-999
amountrequerido	integer	Monto de la orden máximo 14 dígitos Ejemplo: 1000
accountbank_namerequerido	string	Nombre del titular de la cuenta máximo 180 caracteres Ejemplo: John Doe
accountbank_rutrequerido	string	Cédula de identidad del titular Formato: (V/E/J) VXXXXXXXX máximo 15 caracteres Ejemplo: V23654789
accountbank_sbifrequerido	string	Código del banco al que pertenece la cuenta bancaria. 0102 Banco De Venezuela 0104 Banco Venezolano De Credito 0105 Banco Mercantil 0108 Banco Provincial 0114 Banco Del Caribe 0115 Banco Exterior 0128 Banco Caroni 0134 Banesco 0137 Sofitasa 0138 Banco Plaza 0146 Bangente 0151 Banco Fondo Común 0156 100% Banco 0157 Delsur Banco Universal 0163 Banco Del Tesoro 0166 Banco Agrícola De Venezuela 0168 Bancrecer 0169 R4 Banco Microfinanciero C.A. 0171 Banco Activo 0172 Bancamiga 0173 Banco Internacional De Desarrollo 0174 Banplus 0175 Banco Bicentenario 0178 N58 Banco Digital 0191 Banco Nacional De Credito máximo 4 caracteres Ejemplo: 0102
accountbank_typerequerido	string	Tipo de cuenta. 1 Corriente 3 Ahorro máximo 1 caracter Ejemplo: 1
accountbank_numrequerido	string	Número de cuenta del cliente en Venezuela Formato: (0412 / 0414 / 0424 / 0426 / 0416) 9876543 máximo 200 caracteres Ejemplo: 04149876543
url_notify	string	Callback donde se notificará 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": "morexzxxxx", "identifier_payout": "morexzxxxx", "order" : "367734544", "status" : "success", "update_at" : "2023-08-24 12:29:35", "customer" : { "name" : "Jhon Doe", "phone" : "04149876543", "document" : "V23654789", "number" : "04149876543" } } Ejemplo Rechazado: { "id": "morexzxxxx", "identifier_payout": "morexzxxxx", "order" : "367734544", "status" : "banking_error", "update_at" : "2023-08-24 12:29:35", "customer" : { "name" : "Jhon Doe", "phone" : "04149876543", "document" : "V23654789", "number" : "04149876543" } } máximo 600 caracteres Ejemplo: https://youwebsite.com/callback/commerce/order-commerce-999
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

cURL

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": "04149876543",
  "subject": "payOut description 9876",
  "currency": "VES",
  "order": "9876",
  "amount": 1000,
  "accountbank_name": "Jhon Doe",
  "accountbank_rut": "V23654789",
  "accountbank_sbif": "0102",
  "accountbank_type": "1",
  "accountbank_num": "04149876543",
  "url_notify": "https://youwebsite.com/urlnotify?orderClient=9876",
  "additional_parameters": {
    "custom_parameter_1": "keyValue",
    "custom_parameter_2": "SpecificValue2",
    "external_reference": "REF-777"
  }
}'

PHP

$client = new \GuzzleHttp\Client();
$body = $client->request('POST', 'https://BASE_URL/api/wallet/payout', [
  'json' => [
    'email' => '[email protected]',
    'phone' => '04149876543',
    'subject' => 'payOut description 9876',
    'currency' => 'VES',
    'order' => '9876',
    'amount' => 1000,
    'accountbank_name' => 'Jhon Doe',
    'accountbank_rut' => 'V23654789',
    'accountbank_sbif' => '0102',
    'accountbank_type' => '1',
    'accountbank_num' => '04149876543',
    'url_notify' => 'https://youwebsite.com/urlnotify?orderClient=9876',
    'additional_parameters' => [
      'custom_parameter_1' => 'keyValue',
      'custom_parameter_2' => 'SpecificValue2',
      'external_reference' => 'REF-777'
    ]
  ],
  'headers' => [
    'Authorization' => 'Bearer TOKEN_PUBLICO',
    'Sign' => 'SHA256-REQUEST-PATH-VALUE-TOKEN-PRIVADO'
  ]
])->getBody();
$response = json_decode($body);

JS

const data = {
  "email": "[email protected]",
  "phone": "04149876543",
  "subject": "payOut description 9876",
  "currency": "VES",
  "order": "9876",
  "amount": 1000,
  "accountbank_name": "Jhon Doe",
  "accountbank_rut": "V23654789",
  "accountbank_sbif": "0102",
  "accountbank_type": "1",
  "accountbank_num": "04149876543",
  "url_notify": "https://youwebsite.com/urlnotify?orderClient=9876",
  "additional_parameters": {
    "custom_parameter_1": "keyValue",
    "custom_parameter_2": "SpecificValue2",
    "external_reference": "REF-777"
  }
};
const request = async (data) => {
  const response = await fetch('https://BASE_URL/api/wallet/payout', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer TOKEN_PUBLICO',
      'Sign': 'SHA256-REQUEST-PATH-VALUE-TOKEN-PRIVADO'
    },
    body: JSON.stringify(data)
  });
  const result = await response.json();
  console.log(result)
}
request(data);

Respuestas

200

200

{
  "status": "success",
  "identifier_wallet": "wvb5f7232dafff18f9",
  "identifier_payout": "mv40746ab8eff910f41e"
}

Campos de la respuesta

Parámetro	Tipo	Descripción
status	string	Estado de la carga a la wallet. Los posibles estados son: success: exitosa failed: fallida Ejemplo: success
identifier_wallet	string	Identificador del movimiento de la billetera virtual de payku. Ejemplo: wvb5f7232dafff18f9
identifier_payout	string	Identificador del pago a tercero. Ejemplo: mv40746ab8eff910f41e

400

400

Error en la solicitud.

{
  "status": "failed",
  "type": "Unprocessable Entity",
  "message_error": "subject:invalid,amount:is empty,email:is empty,order:invalid"
}

Campos de la respuesta

Parámetro	Tipo	Descripción
status	string	Estatus de la solicitud. Ejemplo: failed
type	string	Tipo de error ocurrido. Ejemplo: Unprocessable Entity
message_error	string	Mensaje de error Ejemplo: subject:invalid,amount:is empty,email:is empty,order:invalid

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/wa24bg36767.

CURL

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' \

PHP

$client = new \GuzzleHttp\Client();
  $body = $client->request('GET', 'https://BASE_URL/api/payoutv3/{identificadorPayout}', [
    'headers' => [
      'Authorization' => 'Bearer TOKEN_PUBLICO',
      'Sign' => 'SHA256-REQUEST-PATH-VALUE-TOKEN-PRIVADO'
    ]
  ])->getBody();
$response = json_decode($body);

JS

const request = async () => {
  const response = await fetch('https://BASE_URL/api/payoutv3/{identificadorPayout}', {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer TOKEN-PUBLICO',
      'Sign': 'SHA256-REQUEST-PATH-VALUE-TOKEN-PRIVADO'
    },
  });
  const result = await response.json();
  console.log(result)
}

request();

Respuestas

200

200

{
  "payout": {
    "id": "war3999847529816f2",
    "phone": "111111111",
    "email": "[email protected]",
    "subject": "subject order",
    "amount": "3680",
    "accountbank_rut": "V23654789",
    "accountbank_name": "test",
    "accountbank_type": 1,
    "accountbank_num": 123123123,
    "accountbank_sbif": "0102",
    "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ámetro	Tipo	Descripció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: 111111111
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	Rut del titular de la cuenta destino. Ejemplo: V23654789
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 cuenta del banco destino. Ejemplo: 123123123
accountbank_sbif	string	Código del banco al que pertenece la cuenta bancaria. Ejemplo: 0102
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

400

400

Error en la solicitud.

{
  "status": "failed",
  "type": "Unprocessable Entity",
  "message_error": "subject:invalid,amount:is empty,email:is empty,order:invalid"
}

Campos de la respuesta

Parámetro	Tipo	Descripción
status	string	Estatus de la solicitud. Ejemplo: failed
type	string	Tipo de error ocurrido. Ejemplo: Unprocessable Entity
message_error	string	Mensaje de error Ejemplo: subject:invalid,amount:is empty,email:is empty,order:invalid

404

404

Identificador no existe.

{
  "status": "failed",
  "type": "Not Found",
  "id": "is not valid"
}

Campos de la respuesta

Parámetro	Tipo	Descripción
status	string	Estatus de la solicitud. Ejemplo: failed
type	string	Tipo de error ocurrido. Ejemplo: Not Found
id	string	Información de id Ejemplo: is not valid