Create Invoice for Merchant

post

https://api.staging.finharbor.io/crypto-acquiring/merchant/invoice

This endpoint allows a merchant to create a new invoice. If successful, it returns the invoice ID and a payment URL.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

terminalId

string

required

Terminal id initialized invoice.

externalId

string

external identifier of the invoice.

clientId

string

External client ID provided by the merchant.

desc

string

External description of invoice.

currency

string

required

Currency of invoice.

clientEmail

string

Client's email for notification and callback

type

string

enum

Defaults to ORIGINAL

Type of invoice request.

Allowed:

eligibleDiscountCodes

array of strings

List of available discount codes that can be applied.

eligibleDiscountCodes

appliedDiscountCode

string

Discount code that was applied to the invoice.

items

array of objects

required

List of products included in the invoice.

items*

expireAt

date-time

Timestamp when the invoice expires and is no longer payable.

overpaidAmount

string

≥ 0

Fixed fee amount in the invoice currency.

overpaidPercent

string

≥ 0

Percentage fee applied to the invoice amount.

underpaidAmount

string

≥ 0

Fixed fee amount in the invoice currency.

underpaidPercent

string

≥ 0

Percentage fee applied to the invoice amount.

commonReturnUrl

string

Common ReturnUrl.

Responses

Language

Credentials

OAuth2

Loading…

Response

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

application/json

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error