跳到主要内容

Getting Started

Start your integration here!

Whether you’re using an e-commerce platform or integrating directly with our APIs, getting up and running with PiedPay is quick and easy.

Sign Up for A Merchant Account

Visit PiedPay Dashboard to get started!

Concept​

  • Merchant: Represents a merchant, usually a group/organization, and defaults to the owner of the merchant when the user registers.
  • Account: Represents account, starts with acct_, also represents a company entity, a company's business products, is the entity that carries the transactions and other objects, so the API Key is for the account. The granularity of KYC is also in this layer. Users (including the owner and members of the account) can manage the corresponding functions in the Account dimension.
  • User: Represents the user, each user has an email address for login, there are two types of users
    • Owner: Represents the administrator or the owner of the account/merchant, who has all the privileges of the account/merchant.
    • Member: Represents an invited user, who has the permissions corresponding to the role assigned by the owner.
Owner and Member

A merchant owner can be invited to become a member of another merchant or an account owner, but can only be registered as the owner of a single merchant. The owner or member of an account can be invited to become a member of another merchant or an account owner, but can also register as the owner of a merchant alone.

Developer

Always make sure that your company's account manager invites the developer into the dashboard.

Account Structure​

Account Structure

Direct API Integrations

Integrate PiedPay’s API directly with your e-commerce platform.

1. Submit KYC documents​

Before the live mode API key can be used to initiate API requests for real transactions, the merchant must submit KYC information, which will be reviewed by PiedPay's account manager and the live mode API key will be assigned to the merchant's account upon successful review.

2. Apply payment methods​

2.1 Choose payment methods​

You will need to contact PiedPay's commercial(BD) in order to determine which payment methods you need to set up and the corresponding fee rates, which may take a few days or weeks depending on the payment method.

Here is a list of payment methods supported by PiedPay.

2.2 Confirm pricing for payment methods​

You will need to confirm the pricing with our BD. Only after pricing is configured, that you may test in test mode.

Here is a pricing standard by PiedPay.

3. API integration​

3.1 Test in testmode​

PiedPay allows you to initiate API calls using the test mode API key, the API will make simulated responses and no real money will be involved in test mode.

Refer to the API interface documentation for integration. No matter whether is in test mode or live mode, the API endpoint is the same:

https://api.piedpay.com

3.2 Test in livemode​

Switch to the live mode API key for the acceptance test.

Test Mode ≠ UAT

Please always base your production environment validation on live mode only.

3.3 Best Practice​

Accounts do not exist as a testing role, please do not create new accounts for testing or development purposes, please test through testmode by using test API key.

Livemode usage

4. Launch​

Launch your payment integration.