Resolve overpaid Transaction

Partna API docs

API Reference

Dashboard

Support

Welcome to Partna API docs. 
With our API, you can:
1. Collect and payout local currencies. 

2. Onramp and Offramp your users with crypto

These docs will cover the available endpoints and provide example code for using the API. They will hopefully help you build your product and use case seamlessly. 

If have any questions, feel free to send a mail to dev@getpartna.com

Introduction

To make it easier to test and develop with Partna, we have built different Staging and Production environments.

Environments

Authentication

Webhooks allow you to set up a notification system that can be used to receive updates on certain requests made to the Partna API.

Webhooks

Rate Tiers

Collect local currency payments from customers

Collect

Collect local currency payments from customers and convert to crypto

Onramp

Make instant local currency transfers to your customers

Payout

Receive crypto and make instant local currency transfers to your customers

Offramp

Retrieves account balance for the selected currency

Retrieve merchant account balance

Retrieves merchant record - username, email, callback URL, merchant logo, creditCurrency, API key expiry date-time

Retrieve merchant record

Update merchant record

Sends a mock payment request (only in staging environment)

Make a mock payment

Retrieves conversion rates for all supported currencies

Retrieves conversion rates

Retrieves transaction summary for the selected currency for a merchant

Retrieve merchant transaction summary

Create a new voucher payment

Retrieves an existing voucher record(s). When no query param is provided, all the voucher record for the merchant will be returned. If accountNumber field is provided in the query, all the voucher records associated with the given accountNumber for the merchant will be returned.

Retrieve voucher record

Retrieves a collection of voucher records, sorted in descending order by their creation date.

Get multiple records

Redeem existing unused voucher

Redeems an existing unused voucher and transfers crypto to the provided wallet address

Redeem and withdraw

Retrieves fee for a given voucher amount and currency.

Retrieves minimum and maximum voucher amounts for each currency.

Retrieves minimum and maximum voucher amounts

Creates a new managed bank account using user identity and contact information.

Create a new bank account

Returns static bank account details associated with the given email.

Retrieve static accounts for a user

Create api key

Create payment

Get a single payment

Get a transaction

Get current rates

Get minimum amount allowed

Get supported currencies

Get supported cryptocurrencies and networks

Get supported cryptocurrencies and network

Retrieve the callback url used as webhook

Retrieve subscribed webhook url

Retrieve user's transaction records

Retrieve user's transaction summary

Retrieves a user's crypto wallet addresses

Set the callback url that will be used as webhook

Subscribe to webhook

Withdraw balance

Verifies the bank account and returns the bank account details

Resolve bank account

Retrieve a list of supported banks

Retrieves account balance for each currency

Retrieve user's account balance

Transfer funds from user's balance to another user (fiat-to-fiat)

Transfer funds

Transfer crypto from one wallet address to another

Wallet transfer

Welcome to Partna version 4 API docs. 
If have any questions, feel free to send a mail to dev@getpartna.com

Get all accounts or filter using account name. The account name must be an alphanumeric lowercase hex string between 2 to 40 characters long

Get Account

Create bank account. You need to complete KYC before creating a bank account.

Create Bank Account

Create Account

Get Accounts Details

Update Account Email

Get Account Profile

Get Banks

Convert Currency

Get Transfer

Create Transfer

Get Single Transaction

Initiate Transfer

Withdraw

Get discounts applied on USD-NGN offramp transaction rates based on the transaction amount.

Get Discounts

Initiate BVN KYC

Confirm BVN OTP

Confirm phone number associated with account BVN.

Confirm Phone

Handle BVN OTP Method

Resolve bank account by account number and bank code.

Resolve Bank

Supported Verification Methods

Get Account MFA

Validate Account MFA

Enable Account MFA

Disable Account MFA

Mock Deposit

Mock Fiat Deposit

Get Pending Pricing

Trigger pricing reminder, charge, retry or receipt.

Pricing Alert

Onramp and Offramp

Get Rate

Verify Rate Key

Get a list of supported assets including symbols, contract details, withdrawal constraints, and transaction explorer links.

Get Supported Assets

Update user endpoint ID and callback URL.

Update User

Create User

Generate API Key

Delete API Key

Get the valid scopes for API jey generation.

Get API Key scopes

Get API Keys

Get Balances

Invalidate API Key

Get preferred registration type, fee settings, deposit account, and crypto payment source.

Get Registration, Deposit and Fee Settings

Update preferred registration type, fee settings, deposit account, and crypto payment source.

Collect & Onramp

Offramp

Payout

Resolve overpaid Transaction

Query Parameters

Response