Authorization

post https://api-sandbox.sprinque.com/api/v1/transactions/authorize/{buyer_id}

The Authorization API is used to create an authorization hold on the available credit limit for a buyer.
if the transaction amount is within the available credit limit for the buyer, an authorization hold is successfully created.

Ideally, you can use Sprinque Merchant SDK for order creation. But if that's not the case, please pass IPv4 or IPv6 to the metadata of the auth call like this:

metadata: {IPv4: '192.0.2.146'}

NOTE - Merchant Order Id shared in the Authorisation API call can be overwritten with the Merchant Order Id in the Capture API call. This is done to help provide flexibility to merchants who perform Auth with Sprinque before creating an order on their side.

Path Params

buyer_id

string

required

Unique id of the business generated by sprinque during business registration.

Body Params

merchant_order_id

string

required

length ≤ 100

Order number of the purchase, generated by the Merchant.

payment_terms

string

NET7 - Net7
NET15 - Net15
NET30 - Net30
NET45 - Net45
NET60 - Net60
NET90 - Net90
PAY_IN_3 - Pay In 3
PAY_IN_6 - Pay In 6
PAY_IN_9 - Pay In 9
PAY_IN_12 - Pay In 12
PAY_IN_ADVANCE - Pay In Advance

order_amount

string

required

The monetary value of the order.

order_currency

string

length ≤ 3

Defaults to EUR

Order note currency code in ISO 4217. Supported: EUR.

shipping_address

object

required

Address the order is being shipped to.

issued_by

string

User email who authorized the transaction.

metadata

object

Metadata is a JSON object for passing any custom information like the digital footprint of the buyer. (e.g., IP address, browser type etc)

Headers

X-API-KEY-ID

string

required

Sprinque authenticates using API keys.
API Key can be generated on the Sprinque
MCC portal from the “My Account” page.
The same key can be used for all API calls.

Response

Callback

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.sprinque.com/api/v1/transactions/authorize/buyer_id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "order_currency": "EUR"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201