Download the PHP package banxa/php-sdk without Composer

Banxa official PHP SDK

Table of Contents

• General info
  • Installation
  • Authentication
    • Domain, ApiKey and ApiSecret
  • Dependencies
  • Usage
    • Sandbox
    • Production
• Localisation
  • Countries
  • US States
• Currencies
  • Fiat
  • Crypto
• Payment Methods
  • Buy & Sell order type
  • Buy order type
  • Sell order type
• Prices
  • Buy order types
  • Buy order type
  • Sell order types
  • Sell order type
• Orders
  • Retrieving Order(s)
    • Fetch orders
    • Fetch order
  • Order creation
    • Creating a buy order
    • Creating a NFT buy order
    • Creating a sell order
  • Confirm sell order
• Identity
  • Create Identity

General info

The Banxa SDK is a plug and play ready to go implementation to access our services.
It allows for a simple and fast integration.

Installation

Install the package via composer

Authentication

ApiKey and ApiSecret

While on-boarding with banxa, you will be provided with API keys and a subdomain ([partnername].banxa.com),
initially these will be for the sandbox environment. Once you are done testing the implementation, you will receive the credentials to use the production environment.

Dependencies

Usage

Sandbox

`

Production

`

Localisation

Countries

Global

Fetch all available countries

Result Example

US States

Fetch all available US States

Result Example

Currencies

Fiat

Buy order type

Fetch all available fiat currencies for buy order type.

Sell order type

Fetch all available fiat currencies for sell order type.

Result Example

Crypto

Buy order type

Fetch all cryptocurrencies for buy order type.

Sell order type

Fetch all cryptocurrencies for sell-order type.

Result Example

Payment Methods

Buy & Sell order type payment methods

Fetch all available payment providers for buy and sell order type

Result Example

Buy order type payment methods

Fetch all available payment providers for buy order type

Result Example

Sell order type payment methods

Fetch all available payment methods for sell order type

Result Example

Prices

Get prices for Payment Methods to obtain a payment method id for each specific fiat.

Buy order types pricing

Fetch all available prices for buy order type

Result Example

Buy order type pricing

Fetch single price for buy order type for a specific payment method

Result Example

Sell order types pricing

Fetch all available prices for sell order type

Result Example

Sell order type pricing

Fetch single price for buy order type for a specific payment method

Result Example

Orders

Retrieving orders

Fetch orders

Fetch all orders within a specific time range. (paginated)

Result Example

Fetch order

Fetch single order

Result Example

Creating orders

Allows your customer to create a buy or sell crypto order with Banxa. Upon success, the response will contain a checkout URL which will be unique for the order. The customer will be redirected to this URL to complete the checkout process, which will expire after 1 minute if a redirect does not occur.

When creating an order you will be required to create a BuyOrderTransaction/SellOrderTransaction/NftBuyOrderTransaction object. This object will allow you to create a transaction using a fiat amount, coin amount, or if you require both, you can specify your own amount using the createDynamic method, this will depend on your business use case.

Creating a buy order

BuyOrderTransaction using Fiat as base amount

BuyOrderTransaction using Coin as base amount

BuyOrderTransaction using dynamic sourceAmount or targetAmount

When using BuyOrderTransaction::createDynamic you will need to specify $source(Fiat), $target(Coin), and either $sourceAmount or $targetAmount

optionalOrderParameters

Buy order full example

Result Example

---

Creating a NFT buy order

NftBuyOrderTransaction

NftData

Nft

Create VideoNftMedia

Create ImageNftMedia

Nft buy order full example

Result Example

---

Creating a Sell order

SellOrderTransaction using Fiat as base amount

sellOrderTransaction using Coin as base amount

sellOrderTransaction using dynamic sourceAmount or targetAmount

When using SellOrderTransaction::createDynamic you will need to specify $source(Coin), $target(Fiat), and either $sourceAmount or $targetAmount

optionalOrderParameters

Sell order full example

Result Example

---

Confirm sell order

Once the coin amount transfer for a Sell Order has been executed,
Banxa must be notified by sending a request to this endpoint with transaction hash, source and destination wallet address details.

Result Example

Identity

Create Identity

Allows you to share customer details with Banxa before an Order is created.
This reduces the need for customers to re-submit personal details and upload KYC documentation during the Banxa checkout flow.
Detailed guide on how to implement this API can be found here. You can also find Testing information here

IdentitySharingCollection

IdentitySharingProvider

CustomerDetail

ResidentialAddress

CustomerIdentity

IdentityDocumentCollection

IdentityDocument

Full Example

Result Example