Skip to content
Payku Docs

Wallet

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

Make payments to third parties from my wallet

Section titled “Make payments to third parties from my wallet”
POST/api/wallet/payout

This method allows you to create a payment order to a third party using funds from your Payku virtual wallet.

Note: For testing purposes (Development environment only), specific amounts will be processed automatically:
• Amounts 1000, 2000, 3000: Will be marked as approved automatically.
• Amounts 1500, 2500, 3500: Will be marked as rejected automatically.

Request body

ParameterTypeDescription
emailrequired string <email>

User's email

max 50 characters
Example: [email protected]
phone string

User's phone number

max 20 characters
Example: 04149876543
subjectrequired string

Description of the order

max 200 characters
Example: description of the order
currencyrequired string

Currency type (ISO format)

max 6 characters
Example: VES
orderrequired string

Merchant order

max 50 characters
Example: order-commerce-999
amountrequired integer

Order amount

max 14 digits
Example: 1000
accountbank_namerequired string

Account holder's name

max 180 characters
Example: John Doe
accountbank_rutrequired string

ID number of the account holder Format: (V/E/J) VXXXXXXXX

max 15 characters
Example: V23654789
accountbank_sbifrequired string

Bank code of the destination account.

  • 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
max 4 characters
Example: 0102
accountbank_typerequired string

Type of account.

  • 1 Checking
  • 3 Savings
max 1 character
Example: 1
accountbank_numrequired string

Customer's account number in Venezuela Format: (0412 / 0414 / 0424 / 0426 / 0416) 9876543

max 200 characters
Example: 04149876543
url_notify string

Callback where the result of the payment will be notified.

  • Note: After making the third-party payment, Payku will automatically respond to the URL provided in url_notify with the result.
    • Approved example:
    • {
      • "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"
      • }
    • }
    • Rejected example:
    • {
      • "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"
      • }
    • }
max 600 characters
Example: https://youwebsite.com/callback/commerce/order-commerce-999
additional_parameters object

Optional customer additional parameters.

max 4000 characters
parameter_1 string

Custom parameter name defined by Payku user

Example: keyValue
parameter_2 string

Custom parameter name defined by Payku user

Example: keyValue
Ventana de terminal
curl -X POST \
https://BASE-URL/api/wallet/payout \
-H 'Accept: application/json, text/plain, */*' \
-H 'Authorization: Bearer PUBLIC-TOKEN' \
-H 'Sign: SHA256-REQUEST-PATH-VALUE-PRIVATE-TOKEN'  \
-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"
  }
}'

Responses

200
{
  "status": "success",
  "identifier_wallet": "wvb5f7232dafff18f9",
  "identifier_payout": "mv40746ab8eff910f41e"
}
Response fields
ParameterTypeDescription
status string

Status of the load to the wallet. The possible statuses that can be obtained are the following:

  • success
  • failed
Example: success
identifier_wallet string

payku virtual wallet movement identifier.

Example: wvb5f7232dafff18f9
identifier_payout string

Third party payment identifier.

Example: mv40746ab8eff910f41e

Get payout V3

Section titled “Get payout V3”
GET/api/payoutv3/{identificadorPayout}

This method allows you to obtain a movement of payments to third parties from your payku virtual wallet using an identifier:

To perform the query it is necessary to add the following at the end of the endpoint /{identificadorPayout} for example: api/payoutv3/wa24bg36767.

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

Responses

200
{
  "payout": {
    "id": "war3999847529816f2",
    "phone": "111111111",
    "email": "[email protected]",
    "subject": "subject order",
    "amount": "3680",
    "accountbank_rut": "111111111",
    "accountbank_name": "test",
    "accountbank_type": 1,
    "accountbank_num": 123123123,
    "accountbank_sbif": "0001",
    "status": "pending",
    "update_at": "2022-06-09 21:10:46",
    "origin_wallet": "wa1933f37cdaf7d1c6",
    "reason_rejection": " Error CCA 51. Cuenta Beneficiario no Existe, error_creditor_account_not_found"
  }
}
Response fields
ParameterTypeDescription
payout object

Destination account identifier.
id string

Destination account identifier.

Example: war3999847529816f2
phone string

Telephone of the destination account holder.

Example: 111111111
email string

Destination account holder's email.

Example: [email protected]
subject string

Application Status.

Example: subject order
amount string

Amount to be deposited in the destination account.

Example: 3680
accountbank_rut string

Rut of the destination account holder.

Example: 111111111
accountbank_name string

Name of the destination account holder.

Example: test
accountbank_type integer

Type of account of the destination bank.

Example: 1
accountbank_num integer

Destination bank account number.

Example: 123123123
accountbank_sbif string

Code of the bank to which the bank account belongs.

Example: 0001
status string

Movement status.

  • pending ("payout registered")
  • processing ("payout in payment process")
  • success ("payout successfully deposited")
  • banking_error ("payout rejected by the bank")
  • fraud_prevention ("payout rejected by compliance")
Example: pending
update_at string

Date the request was made.

Example: 2022-06-09 21:10:46
origin_wallet string

Id de la wallet origen.

Example: wa1933f37cdaf7d1c6
reason_rejection string

Reason for rejection.

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