Initiate Payment

post

https://business-api.mypatricia.co/v1/payment/initiate

This section describes how to initiate a payment using cryptocurrency on Patricia Business.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This page allows you to initialize a payment intent for cryptocurrency. Every successful initialization returns a payment url that the user can now use to complete their transaction.

Body Params

currency

string

required

Defaults to NGN

The currency the merchant wishes to accept payment in. Currency must be in a three-letter ISO currency code and in uppercase. The supported currencies include "NGN", "GHC", "KES", "USD". Where NGN represents Nigerian Naira, GHC is Ghanian Cedis, KES is Kenyan Shilling and USD is US Dollars. amount integer Amount intended to be collected by the merchant. A positive integer representing how much is to be charged. Please note that currencies here are denominated in Naira and not Kobo (e.g 1 will charge N1). The minimum amount to charge is N1 and the maximum charge per transaction is N1,000,000.

amount

int32

required

Defaults to 1000

Amount that the customer/user intends to pay

first_name

string

required

Defaults to James

This is the first name of the customer performing the transaction. This attribute only accepts alphanumeric characters.

last_name

string

required

Defaults to Blunt

This is the last name of the customer performing the transaction. This attribute only accepts alphanumeric characters.

string

required

Defaults to [email protected]

This is the email of the customer performing the transaction. A fully valid email is expected here. Patricia Business will email the customer a transaction receipt after every successful transaction.

payment_method

string

required

Defaults to crypto_bitcoin, crypto_ethereum, crypto_tether, crypto_ripple, crypto_dogecoin

The payment method should always be crypto_bitcoin if the merchant intends to charge their client in cryptocurrency.

business_reference

string

Defaults to ref_id_12345

The business reference isn't a required parameter, this is because Patricia generates a reference for all her transaction. But in the case where a company decides to provide one, they must ensure that the said reference is unique.

metadata

json

metadata is an optional field that the merchant can use to to send additional data points that isn't supported by Patricia. These data must be an object.

Headers

Bearer

string

required

Bearer token.

Responses

200200

400400

401401