Webhook Events

On/Off-ramp Webhooks

Sardine Payments

shield-halved

envelope

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 Guide

Testing Credentials

Issue Reporting

On/Off-ramp Product Overview

Quickstart

Crypto On/Off-ramp Testing Guide

NFT Checkout 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

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

This endpoint returns a URL that redirects the user to perform document-based KYC verification.

Get KYC Widget URL

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

Get Supported Tokens

Get Enabled Tokens

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

Get information about User's payment methods

Get Payment Method information

This endpoint returns a URL where users can be redirected to connect external fiat payment methods, including credit/debit cards, bank accounts, and SEPA.

Get Add Fiat Account Widget URL

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 an Order by ID

This endpoint retrieves the list of orders placed by the user, with optional filtering based on specific query parameters like userId.

Get User Orders

This endpoint allows users to file a support ticket with Sardine by providing their contact information and details about the issue.

Create Support Ticket

This endpoint is used to initiate an onramp transaction, converting fiat to crypto and delivering the crypto to a destination wallet.

Create Onramp Order

This endpoint is used to initiate an offramp transaction, converting crypto to fiat and transferring funds to the user's connected payment method.

Create Offramp Order

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 Order(s)

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.

Create Payout

Update NFT Status

Update Order

Get information about Bank Account object

Get Bank Account

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

Retrieve result of document verification 

Fetch KYC

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

Security Portal

Contact Us

Getting Started

Integration Guides

API Reference

API Reference (NFT)

Get Started

Mobile Integration

Web Integration

API Integration

Sardine's NFT checkout widget offers a quick way to integrate the ability to directly purchase NFTs from fiat through a URL, and then settle with crypto.

webhook	description
draft	User has created an order
expired	User did not confirm the purchase
declined	User attempted a purchase but their payment attempt was declined
processing	Order was confirmed, waiting for payment
processed	Payment was processed successfully
complete	Order was executed and delivered to user

Onboarding and Testing

On/Off Ramps

NFT Checkout

On/Off-ramp Webhooks

Webhook Events

Onboarding and Testing

On/Off Ramps

NFT Checkout

​Webhook Events

Webhook Events