Skip to content
Payku Docs

Wallet

Lets you generate bank transactions from your payku virtual wallet.

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

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 the funds in your wallet virtual payku.

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>

Client email

maximum 50 characters
Example: [email protected]
phone string

Client phone. Format: 519YYYYYYYY

maximum 20 characters
Example: 51906310864
subjectrequired string

Order Description

maximum 200 characters
Example: test Gmoney peru
currencyrequired string

Currency description (ISO format)

maximum 6 characters
Example: PEN
orderrequired string

E-commerce order

maximum 80 characters
Example: 0011010101777
amountrequired integer

Order amount.

Note: the minimum amount is 5 soles (PEN) and the maximum amount is 30000 soles (PEN).

maximum 14 digits
Example: 1
accountbank_namerequired string

Name of the destination account holder

maximum 180 characters
Example: PAYKU PERU SAC
accountbank_rutrequired string

Identity document of the destination account holder in Peru: DNI, Cédula de Extranjería (CE) or passport. The field name is kept for backwards compatibility. Example (DNI): 47566578

between 7 to 12 characters
Example: 47566578
accountbank_sbifrequired string

Code of the bank to which the bank account belongs.

maximum 4 characters
Example: 001
accountbank_typerequired string

Account type.

  • 1 Checking account
  • 3 Saving account
maximum 1 character
Example: 1
accountbank_numrequired string

Customer's CCI (Interbank Account Code) number.

Note: The interbank CCI is a number composed of 20 digits. Only for YAPE, you may provide the associated phone number.

Format: 519YYYYYYYY

maximum 20 characters
Example: 01128901338000251968
url_notify string

url where the result of the payment will be notified.

  • Note: After making the payment to third parties, payku will automatically respond to the endpoint entered in urlnotify the result of the operation.
    • Approved Example:
    • {
      • "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"
    • }
    • Rejected Example:
    • {
      • "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",
    • }
maximum 600 characters
Example: https://youwebsite.com/urlnotify?orderClient=98745
additional_parameters object

Client additional parameters

maximum 4000 characters
parameter_1 string

Parameter name given by user payku

Example: keyValue
parameter_2 string

Parameter name given by user payku

Example: keyValue2
order_ext string

Name of the external order given by the user payku (Optional)

Example: fff-777
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: SIGN'  \
-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"
      }
    }'

Responses

200
{
  "status": "success",
  "identifier_wallet": "wab5f7232dafff18f9",
  "identifier_payout": "mpe33e36b01e8a11b9ee"
}
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: wab5f7232dafff18f9
identifier_payout string

Third party payment identifier.

Example: mpe33e36b01e8a11b9ee

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

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": "111111111111",
    "accountbank_name": "test",
    "accountbank_type": 1,
    "accountbank_num": "00328901338000251968",
    "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

Identity document of the destination account holder: DNI, Cédula de Extranjería (CE) or passport.

Example: 111111111111
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's CCI (Interbank Account Code) number or in case of YAPE, the beneficiary's mobile phone number.

Example: 00328901338000251968
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