API Reference

Payment order registration

post
https://api.zenki.fi/v1/pay/orders

Service that allows registering a payment order and associating it with a merchant.

Body Params

A JSON structure will be sent that will have the required information to create an order.

string
required
length ≤ 9

Data model version, its current value should be v1.0.0.

string | null

Unique order identifier generated by the merchant. In order to have correct traceability and adequate conversion metrics, it is required to send the OrderId field or the CardId Field.

string | null

Unique identifier of the shopping cart that allows identifying the purchase of one or more products or services. In order to have correct traceability and adequate conversion metrics, it is required to send the OrderId field or the CardId Field.

string
enum
required

Indicates the model for the product delivery or service delivery.

Possible values:

  • WITH_CARRIER - If a courier is going to be used for the shipment and delivery of the product or service.
  • WITHOUT_CARRIER - If a courier is not going to be used for the shipment and delivery of the product or service.
  • MIXED - If a courier is going to be used to send part of the products or services and another part is delivered without using a courier.
Allowed:
string
required
length ≤ 2

Unique country identifier, the definition of the ISO_3166-1 standard is used with 2 characters, see:https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 or https://www.iso.org/iso-3166-country-codes.html

shopper
object | null

Buyer information.

breakdown
object
required

Summary of shopping cart amounts.

items
array of objects
required

Set of products or services considered within the shopping cart.

items*

Complementary information of the order that the merchant requires to send and inform Zenkipay.

Headers
string

Unique customer identifier used to establish connection with Zenkipay services.

string

Indicates the language type code for which the content of the services response is returned according to the language reported.

The definition of the ISO_639 standard is used. See: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes or https://www.iso.org/iso-639-language-codes.html

string
required

Content type accepted.

string
required

Accepted formats.

Responses

Updated over 2 years ago

Language
Credentials
Bearer
ACCESS_TOKEN
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/json
Updated over 2 years ago