Create Payment Request

The create payment request resource endpoint creates a loan and reserves the specified order amount. This process is called authorisations. When you authorise, finmid will generate a unique id that you'll use to reference the transaction moving forward.

For creating a new payment request, you need the following things:

  1. Create a new ID for this payment request (we recommend using the invoice number),
  2. Choose repayment term days,
  3. Buyer's ID specified on creation,
  4. Seller ID
  5. Total order amount.
  6. (Optional) Invoice due date, which can be added now, or via the update endpoint.
⚠️

Invoice Number

Invoice number is optional upon payment request creation. However, it must be provided prior to capturing the payment request. Invoice number can be provided via the Update Payment Request endpoint

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 100
^[a-zA-Z0-9_\.\-]{1,100}$
integer
required
≥ 0

Repayment period term in days.

string
required
length ≤ 100
^[a-zA-Z0-9_\.\-]{1,100}$
string
required
length ≤ 100
^[a-zA-Z0-9_\.\-]{1,100}$

seller of the payment request

metadata
object
string
required

Three-letter currency code (ISO 4217).

number
required
^(?:\+|-)?[0-9]+(?:\.[0-9]+)$

The total amount of the order with up to 2 decimal places.

string
length ≤ 100

Invoice ID corresponding to the transactions in the payment request.

date
number
^(?:\+|-)?[0-9]+(?:\.[0-9]+)$

The percentage value expressed relative to the total intent amount, which overrides the default total fee deducted upon payout(s).

boolean

If set to true, the payment request will be paid-out immediately after creation.

Responses

401

Missing or invalid API key. Could not authenticate API request.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json