Skip to content
Payku Docs

Mall

The product has been specially designed for those integrating companies of different brands with different lines of business which can be grouped while maintaining their diversity in the same virtual space or mall.

Offering the possibility of grouping the payment of purchases made in multiple virtual stores in a single transaction.

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

Create Mall transaction

Section titled “Create Mall transaction”
POST/api/mall

This method allows the insertion of data from a transaction.

Request body

ParameterTypeDescription
emailrequired string <email>

Customer email.

maximum 50 characters
Example: [email protected]
paymentrequired integer

Identifier of the payment method. If the identifier is sent, the payer will be redirected directly to the indicated means of payment.

  • 1 Webpay
  • 4 Etpay (Transfer)
  • 6 Pago46
  • 9 Mach
  • 19 Fintoc (Transfer)
  • 23 Tenpo
  • 26 Floid (Transfer)
  • 99 All
maximum 2 characters
Example: 1
merchantrequired array of arrays

Array containing the clients, each client is an array containing its public token or marketplace affiliation id, transaction value, description, id of the specific event which if not owned must pass null and individual order number.

maximum 200 characters
Example: [["81b6179e4feeef2b50af71d660f830de",30000,"item1",null,"4545"],["bcf6c06c523d9394be41bc0174c43d1476f274abb342955aac93cc8014737b3b",25000,"item2",null,"4546"],["81b6179e4fffff2b50af71d66f7830de",15000,"item3",null,"4547"]]
orderrequired integer

Trade order, this must be unique.

maximum 40 characters
Example: 123
urlreturnrequired string <url>

return url of the trade where payku will redirect the payer.

maximum 200 characters
Example: https://youwebsite.cl/urlreturn
urlnotify string <url>

callback url of the business where payku will notify the payment.

maximum 600 characters
Example: https://youwebsite.cl/urlnotify
 
curl -X POST \
https://BASE_URL/api/mall \
-H 'Accept: application/json, text/plain, */*' \
-H 'Sign: SIGN  \
-H 'Authorization: Bearer TOKEN_PUBLICO  \
-H 'Content-Type: application/json' \
-H 'Host: BASE_URL' \
-d {
    "email": "[email protected]",
    "payment": 1,
    "merchant": [
      ["81b6179e4feeef2b50af71d660f830de", "30000", "item1", null, "4545"],
      ["bcf6c06c523d9394be41bc0174c43d1476f274abb342955aac93cc8014737b3b","25000","item2", null, "4546"],
      ["PUBLIC-TOKEN","15000","item3", null, "4547"]
    ],
    "order": 123,
    "urlreturn": "https://youwebsite.cl/urlreturn",
    "urlnotify": "https://youwebsite.cl/urlnotify"
  }'

Responses

200
{
  "status": "success",
  "individual_orders": [
    {
      "merchant": "81b6179e4feeef2b50af71d660f830de",
      "amount": 30000,
      "subject": "item1",
      "event": null,
      "identificador": "9917068816213146",
      "individual_order": "9654"
    },
    {
      "merchant": "81b6179e4feeef2b50af71d66f7830de",
      "amount": 25000,
      "subject": "item2",
      "event": null,
      "identificador": "9917068816213146",
      "individual_order": "9654"
    },
    {
      "merchant": "81b6179e4fffff2b50af71d66f7830de",
      "amount": 15000,
      "subject": "item3",
      "event": null,
      "identificador": "9917068816213146",
      "individual_order": "9654"
    }
  ],
  "url": "https://BASE_URL/gateway/mall/malld200058ab44739ddee2adcd2f5"
}
Response fields
ParameterTypeDescription
status string

Transaction status The possible statuses you can get are the following:

  • pending
  • success
  • rejected
  • refunded partial
  • refunded
Example: success
individual_orders array of objects

Arrangement containing beneficiary information.

Example: [{"merchant":"81b6179e4feeef2b50af71d660f830de","amount":30000,"subject":"item1","event":null,"identificador":"9917068816213146","individual_order":"9654"},{"merchant":"81b6179e4feeef2b50af71d66f7830de","amount":25000,"subject":"item2","event":null,"identificador":"9917068816213146","individual_order":"9654"},{"merchant":"81b6179e4fffff2b50af71d66f7830de","amount":15000,"subject":"item3","event":null,"identificador":"9917068816213146","individual_order":"9654"}]
merchant string

Beneficiary's name.
amount string

Amount of the product or service.
detail string

Description of the transaction.
event string

ID of the event, if it does not have event it must pass null.
identificador string

Transaction identifier.

Example: 9917068816213146
individual_order string

Individual transaction identifier.

Example: 4546
url string

URL has redirect user.

Example: https://BASE_URL/gateway/mall/malld200058ab44739ddee2adcd2f5

Get Mall transaction

Section titled “Get Mall transaction”
GET/api/mall/{identificadorTrasaccion}

This method allows you to obtain the information of a payment made in Payku

Path parameters

ParameterTypeDescription
idrequired string

id of the transaction to request

maximum 30 characters
 
curl -X GET \
https://BASE-URL/api/mall/ID-IDENTIFICADOR  \
-H 'Accept: application/json, text/plain, */*' \
-H 'Authorization: Bearer PUBLIC-TOKEN' \
-H 'Content-Type: application/json' \
-H 'Host: BASE-URL ' \

Responses

200
{
  "status": "success",
  "id": "10ac494c1d8da71d98ea",
  "created_at": "2019-10-25 14:10:03",
  "amount": "98745",
  "payment": {
    "media": "Webpay",
    "verification_key": "6669cbd982ef54c28f2f15fb9dc5262d",
    "authorization_code": "107742",
    "last_4_digits": "1233",
    "card_type": "",
    "currency": "CLP"
  },
  "merchant": [
    {
      "name": "John Doe",
      "amount": 30000,
      "subject": "item1"
    },
    {
      "name": "Jane Doe",
      "amount": 25000,
      "subject": "item2"
    },
    {
      "name": "Enteprise",
      "amount": 15000,
      "subject": "item3"
    }
  ]
}
Response fields
ParameterTypeDescription
status string

Transaction status The possible statuses you can get are the following:

  • pending
  • success
  • rejected
  • refunded partial
  • refunded
Example: success
id string

Identifier of the transaction created by Payku.

Example: 10ac494c1d8da71d98ea
created_at string

Registration date.

Example: 2019-10-25 14:10:03
amount string

Amount.

Example: 98745
payment object
media string

Payment method, used by the user.

Example: Webpay
verification_key string

Verification code created by Payku.

Example: 6669cbd982ef54c28f2f15fb9dc5262d
authorization_code string

Authorization code.

Example: 107742
last_4_digits string

Last 4 digits of the affiliated card.

Example: 1233
card_type string

Card type.

Example:
currency string

Currency.

Example: CLP
merchant array of objects

Arrangement containing beneficiary information.

Example: [{"name":"John Doe","amount":30000,"subject":"item1"},{"name":"Jane Doe","amount":25000,"subject":"item2"},{"name":"Enteprise","amount":15000,"subject":"item3"}]
name string

Name of the beneficiary.
amount string

Amount of the product or service.
subject string

Description of the product or service.
2016 - 2026 | Payku SpA