Payment orders list

Service that allows the listing of a merchant's payment orders.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Number of items to return in the list

integer

Page number to be listed

string
enum

Filter by order status

Possible values:

  • PENDING - Waiting for the buyer to pay the payment order.
  • READY4PAY - The buyer has been shown the modal and the order is ready for the buyer to pay for the order with his wallet.
  • AWAITING_PAYMENT - A first confirmation has been received by the blockchain network, it is waiting to have the required confirmations.
  • AWAITING_DELIVERY - The payment for the product or service has already been made and the delivery of the product or service is in process.
  • DELIVERED_SERVICE - The service has already been delivered.
  • AWAITING_SHIPMENT - The guide for the products has already been uploaded and the shipment is in process.
  • SHIPPED - The product or service has been shipped.
  • SHIPMENT_ERROR - There was a problem in the shipping process.
  • AWAITING_SHOPPER_APPROVAL - Waiting for approval from the buyer to confirm that they have received the product or service.
  • DISPUTED - The buyer has started a dispute process with the merchant.
  • PENDING_SHOPPER_RETURN - The merchant is waiting for the buyer to return the product, as a result of the dispute.
  • REFUNDED - The product or service has been refunded to the buyer.
  • COMPLETED - The buyer confirms the receipt of the product or service satisfactorily and the exchange of the value of the sale to stable currency has been made only if applicable.
  • SETTLED - The merchant transaction has been settled.
date

Filter from an initial date. Notation as defined by RFC 3339, section 5.6.

date

Filter to an end date. Notation as defined by RFC 3339, section 5.6.

string

Filter by Order ID

string

Filter by shopper's email address

string
enum

Filter by sales channel

Possible values:

  • JAVASCRIPT - Orders created from an integration via API.
  • ECOMMERCE - Orders created from an integration via eCommerce plugin.
  • PAYMENT_LINK - Orders created with a payment link.
  • TPV - Orders created from the POS app.
Allowed:
string

Filter by POS ID

string

Filter by discount code

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

Language
Credentials
Bearer
ACCESS_TOKEN
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json