Security Portal

Contact Us

Sardine Payments

Getting Started

Integration Guides

API Reference

API Reference (NFT)

Get Started

Get information about Bank Account object

Get Bank Account

Bank Account

Introduction to SardinePay

Get Started With Sardine

Crypto On-ramp

Crypto Off-ramp

NFT Checkout

Payment Methods

Supported Assets

Geo Coverage

Pricing and Transaction Limits

Pricing

Onboarding and Integration Overview

Testing Credentials

Issue Reporting

Quickstart

Crypto On/Off-ramp Architecture and Webhooks

Mobile Integration

Web Integration

Crypto On/Off-ramp Testing Guide

Webhooks

Exchange your `clientId` and `clientSecret` for a `clientToken` that can be be used in frontend code. `clientToken` will be unusable after the `expiresAt` time, which will normally be after 30 min. 


To try the request in the mock server on the right, substitute username for clientId and password for clientSecret. 

If `reference_id` is passed, it will be passed to the Order object upon when the transaction happens. It can then be used as a filter in the /orders endpoint

Get Client Token

Get all trades made by your users. 

Additionally, `cursor` can be passed which references an existing `trade_id`. A maximum of 50 trades will be returned in a request, with an empty value for the `nextCursor` if at the end of the list. 

Filterable by `trade_id`, `customer_id` and `client_token`

Get Trades

Initiate a Trade using Sardine. 

Set `buyOrSell` field to `buy` if converting fiat to crypto, and to `sell` if selling crypto to obtain fiat

Currenly, only `usd` is supported for `fiatType`, with more currency types coming soon. 

You can see list of all supported currencies for `assetType` [here](https://sardineai.stoplight.io/docs/crypto-on-ramp/ZG9jOjQyODg0NjQ3-supported-tokens)

Create Trade

Sardine returns a quote on the amount of cryptocurrency that can be purchased or sold (for off-ramp), along with the associated fees, which are as follows

- Network fee - Also known as "gas", paid out to faciliate and validate the transaction

- Processing fee: Used to cover Sardine's cost of money movement, fraud check and compliance

Get Quote

Sardine can accept information from your documentary KYC vendor.

Send Identity information

Sardine has a deep integration with a best in class KYC provider to verify your users. The response from this endpoint contains a url which can be embedded in an iframe or opened in a new window to handle the KYC process, after which Sardine will be able to get the data from the provider directly. 

Accept Identity documents

Get Supported Tokens

Get Enabled Tokens

Get information about User's payment methods

Get Payment Method information

Fetch information about an Order once its completed

The `status` of an Order can be one of the following

`Draft` - This is an open or ongoing order

`Processed`* - The payment has been completed.

`Declined`* - The transacation was declined, due to payment method issues

`UserCustody` - Crypto purchased for user but is in Sardine's custodied wallet

`Complete` - The payment is complete and the crypto has been delivered to the user's wallet. A `txHash` will be present to denote successful on chain settlement. 

`Expired` - Order expired before execution

Events marked with an * can also be captured via event handlers on the frontend


### Fetching Orders

Full list of Orders is obtained by making a call to the endpoint with no filters. 


You have multiple options of filtering orders

**1. Filtering by `order_id`**

If a `redirect_url` was passed to the Sardine checkout (e.g. https://crytpoapp.com"), when then transaction is completed, Sardine will redirect the user to this url with an `order_id` appended i.e. https://cryptoapp.com?order_id=73103-erhed-317313

This `order_id` can then be used as a filter on this endpoint

E.g. `/v1/orders/491c113c-4485-47cd-b011-252068b753dc`

**2. Filtering by `referenceId`**
If a `referenceId` was passed in the call to create the `clientToken` for this call, it can now be used to filter for Orders that were created then. 

E.g. `/v1/orders?referenceId=42ead95db5aeb6c`

**3. Filtering by `externalUserId`**

If a `externalUserId` was passed in /auth/client-tokens, it can be used to filter for Orders with that ID. This is useful for associating transactions with a user




**3. Filtering by `startDate` and `endDate`**
If `startDate` or `endDate` are passed in YYYY-MM-DD format, the list of Orders will be filtered to those that were created in this range

E.g. `/v1/orders?startDate=2022-08-01&endDate=2022-08-15`



`paymentStatus` field within the `payment` object in the response can be

- Draft
- Pending

For bank transfers, the value could be

- Sent
- Complete
- Returned
- Failed

For card transactions, the value can be

- Authorized
- Captured
- Declined
- Pending3DS
- Failure3DS
- Voided

Get Order(s)

Retrieve result of document verification 

Fetch KYC

Fetches list of all customers. Can be filtered by passing `customerId`

Get Customers

Send User information to Sardine to store theie information and create a risk profile

Post Customer Information

Simply populate the appropriate field in the plaidData object. Make sure to fill in the correct field corresponding to the correct Plaid API endpoint. For example, if you call the Plaid transactions API, you should set plaidData.transactionsResponse to be the JSON string containing the response. Note that the response fields in plaidData are all optional and you may populate as many or few as you would like, as long as an authResponse is sent at least once per account.

Important note: You must provide an authResponse at least once per customer bank account so that we can store the mapping from bank account to Plaid account ID.

Send Bank Information

Get list of regions where Sardine is supported, separated by county and state regions

Get Geocoverage

List of fiat currencies supported by Sardine

Get Fiat Currencies

Add new Bank Account to User. 
Currently, this can be done in one of two ways

1. Using a processor token from bank aggregator service like Plaid
2. Sending information about the user's bank account collected through a Plaid like service

Add new Bank Account using aggregator token

Delete bank account with the corresponding bank account ID

Delete Bank Account

Exchange your `clientId` and `clientSecret` for a `clientToken` that can be be used in frontend code. `clientToken` will be unusable after the `expiresAt` time, which will normally be after 30 min. 


To try the request in the mock server on the right, substitute username for clientId and password for clientSecre

Post Client Token

Fetch information about an Order once its completed

The `status` of an Order can be one of the following

`Draft` - This is an open or ongoing order

`Expired`* - The user didn't complete the transaction within the `expiration` time

`Processed`* - The payment has been completed.

`Declined`* - The transacation was declined, due to payment method issues

`Cancelled`* - The transaction did not complete, which could be for a number of reasons, as outlined in the reason codes below. 

`Complete`* - The payment is complete and the crypto has been delivered to the user's wallet. A `txHash` will be present to denote successful on chain settlement. 

`Refunded` - The User's payment has been refunded to their original payment method


### For Smart Contract Integrations

Orders might end up in `Cancelled` state, due to a number of reasons, which Sardine will share through a `reasonCode` parameter as part of an `error` object in the Order. After an Order has been Cancelled, it will move to the `Refunded` state

The following reason codes might appear

`NETF` - Network Failure
`PRCC` - Price Change beyond threshold
`RISD` - Risk Decline
`NA` - NFT Not Available


Events marked with an * can also be captured via event handlers on the frontend


### Fetching Orders

Full list of Orders is obtained by making a call to the endpoint with no filters. 


You have multiple options of filtering orders

1. Filtering by `orderId`
If a `redirect_url` was passed to the Sardine checkout (e.g. https://crytpoapp.com"), when then transaction is completed, Sardine will redirect the user to this url with an `order_id` appended i.e. https://cryptoapp.com?order_id=73103-erhed-317313

This `order_id` can then be used as a filter on this endpoint, this form
https://api.sandbox.sardine.ai/v1/orders/3103-erhed-317313


2. Filtering by `referenceId`
If a `referenceId` was passed in the call to create the `clientToken` for this call, it can now be used to filter for Orders that were created then. 

3. Filtering by `startDate` and `endDate`
If `startDate` or `endDate` are passed in YYYY-MM-DD format, the list of Orders will be filtered to those that were created in this range

4. Filtering by `externalUserId`


Get fiat currencies

Fetch payouts information by `order_id` or `payout_id`

1. By `order_id`

Make a GET request to /payouts/order_id={}

2. By `payout_id`

Make a GET request to /payouts/{payout_id}

Fetch Payout Information

Create a Payout where Sardine will send crypto to specified wallet(s) in specified cryptocurrencies. 

A Payout can be created associated with a corresponding fiat order (where Sardine has also done the fiat processing) or without one (where Sardine does not do the fiat component). 

To trigger Payouts without the fiat processing being done by Sardine, contact your Integration team.

API Reference

Payment Method

Identity

Customers

Banks

Get Bank Account

Query Parameters

Response