Authentication
Learn how to set up authentication for the Bamboo API. Step-by-step guide for implementing authentication headers, handling private keys, and configuring API response languages.
Purchase API
You can create a purchase using our API. Customer Type and Flow Type drive the purchase workflow.
We implemented The Bamboo Payment API using REST services and JSON format (Content-Type: application/json) for message exchange.
You must make every API call using HTTPS (TLS 1.3) and handle each operation’s HTTP response code to determine the processing status of the sent transaction.
Customer Type
You can have either Anonymous or Registered customers regardless of the flow type. Anonymous customers are not registered on the site and make a one-time purchase. The registered customers are shoppers registered on the website, so they can be identified and have extra functionalities such as recurrences.
Flow type
You can use two different workflows to authorize a purchase:
- API
- Redirect
Note
Flow type depends on each payment method. It’s specified in the payment methods table by country in the column FLOW.
API flow
Upon invoking the API to initiate a purchase, the invocation response will directly provide a status, which could be either final or partial.
For purchases using API, you can use any of the following options:
- Purchase creation, which can be local or CrossBorder.
- Direct purchase
- Purchase preview
Redirect flow
When you invoke the API to initiate a purchase, you obtain a CommerceAction. This CommerceAction signals that the Merchant needs to take necessary steps to advance the payment process. In such instances, the API returns a URL linked to the CommerceAction to direct the customer to this URL for further payment continuation.
For Redirect purchases, refer to Redirect flow payments.
What's next?
Tokenization
During the purchase flow, there are two types of customers, Anonymous users, and Registered users. This section explains both types and how to include them in a purchase.
Purchase
Learn how to create a purchase using the API flow by providing its basic information. Furthermore, explore the various operations available for existing purchases.
Refunds
Refunds allow you to reverse a confirmed purchase, either partially or in full, accommodating various scenarios such as customer returns, order cancellations, or billing corrections.
Anti-fraud system information
All the purchases received through API or Redirection flow for merchants in the Payments Facilitator model, are evaluated by the anti-fraud system.
Webhooks
You can implement a service to receive and process notifications sent from the Bamboo Payment systems.
