Sprinque API

Authentication
Auth
- /api/v1/token/temppost
Buyers
Country
- /api/v1/countries/get
Language
- /api/v1/languages/get
Users
Transactions
Credit note
- Update credit note file.post
Seller
Settlements
- Settlement Overviewget
- Settlement detailsget

Partner APIs

Redirect Checkout
- Initiate a redirect checkout flow with sprinquepost

Sprinque API

Authentication
Auth
- /api/v1/token/temppost
Buyers
Country
- /api/v1/countries/get
Language
- /api/v1/languages/get
Users
Transactions
Credit note
- Update credit note file.post
Seller
Settlements
- Settlement Overviewget
- Settlement detailsget

Partner APIs

Redirect Checkout
- Initiate a redirect checkout flow with sprinquepost

Capture

post https://api-sandbox.sprinque.com/api/v1/transactions/capture/{transaction_id}

The Capture API is used to capture an authorization hold.
It is called once an invoice has been issued for the order.
It initiates the settlement of funds to the Merchant.

URL Expired

The URL for this request expired after 30 days.

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

transaction_id

string

required

Unique id of the transaction generated by Sprinque.

Body Params

invoice

object

required

shipment

object

required

Address the order is being shipped to.

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)

merchant_order_id

string

Order id generated by the merchant.

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

Response body

object

transaction_id

string

required

Unique ID for each transaction lifecycle call to Sprinque.

invoice

object

required

invoice_id

string

required

Unique ID generated for each invoice registered with Sprinque.

merchant_invoice_id

string

required

Invoice number generated by the merchant.

url

uri

Url generated by the merchant from where the invoice pdf can be downloaded.

file_id

string

Either URL or file_id of the invoice is needed for capture. File_id can be generated by calling the upload_file api

additional_file_url

uri

Url generated by the merchant from where the additional pdf can be downloaded.

amount

string

required

The monetary value of the invoice.

currency

string

Defaults to EUR

Currency code in ISO 4217.

date

required

Date of invoice. Format YYYY-MM-DD

status

string

required

Current status of the invoice from predefined values: Open.

due_date

date

required

Due date of the invoice (date of invoice creation plus payment term). Format YYYY-MM-DD

settlement_date

date | null

This field is used to specify the settlement date for dynamic settlements if this feature is enabled for the merchant.

shipment

object

required

Address the order is being shipped to.

shipped_on

date | null

Date order was shipped. Format YYYY-MM-DD

carrier

string

Carrier through whom shipment was sent. Example - DHL, PostNL etc.

tracking_number

string

Tracking number of the shipment.

address

object

required

Address the order is being shipped to.

available_credit_balance

string

required

Available credit limit after capture.

transaction_status

string

required

Transaction status indicates the current state of a transaction. Possible values: CAPTURED, CAPTURE DECLINED, SETTLED

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)

Has additional fields

trace_id

string

required

Unique ID generated by Sprinque for each API call.

merchant_order_id

string

Order id generated by the merchant.

pay_page_url

uri

required

Link to pay page for this invoice.

Updated over 1 year ago

Void

Refund

Language


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

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

application/json

Updated over 1 year ago

Void

Refund

Sprinque API
Authentication
Auth
/api/v1/token/temppost
Buyers
Get all Buyersget
Register Buyerpost
Search Businesspost
Verify OTP for Buyer userpost
Get Buyer Detailsget
Generate OTP for Buyer userpost
Country
/api/v1/countries/get
Language
/api/v1/languages/get
Users
Delete Userdelete
Get User Detailsget
Update User Detailspatch
List Users Detailsget
Create Userpost
Transactions
Upload filepost
Get all Transactionsget
Get Transaction Detailsget
Refundpost
Capturepost
Voidpost
Authorizationpost
Credit note
Update credit note file.post
Seller
This endpoint is used to get the seller details.get
Use this endpoint for getting the pricing details.get
List all Payment Collection Accountsget
This endpoint is used to get the payment collection details.get
Settlements
Settlement detailsget
Settlement Overviewget

Partner APIs
Redirect Checkout
Initiate a redirect checkout flow with sprinquepost

Sprinque API
Authentication
Auth
/api/v1/token/temppost
Buyers
Get all Buyersget
Register Buyerpost
Search Businesspost
Verify OTP for Buyer userpost
Get Buyer Detailsget
Generate OTP for Buyer userpost
Country
/api/v1/countries/get
Language
/api/v1/languages/get
Users
Delete Userdelete
Get User Detailsget
Update User Detailspatch
List Users Detailsget
Create Userpost
Transactions
Upload filepost
Get all Transactionsget
Get Transaction Detailsget
Refundpost
Capturepost
Voidpost
Authorizationpost
Credit note
Update credit note file.post
Seller
This endpoint is used to get the seller details.get
Use this endpoint for getting the pricing details.get
List all Payment Collection Accountsget
This endpoint is used to get the payment collection details.get
Settlements
Settlement detailsget
Settlement Overviewget

Partner APIs
Redirect Checkout
Initiate a redirect checkout flow with sprinquepost

201