Create a new payment link

post/payment-provider-payment-link

Create a new payment link for an invoice, adhoc invoice or customer

SecuritybearerAuth

Request

Request Body schema: application/json

New payment provider payment link

paymentProviderId required	integer <int32> Payment provider identifier
amountInMajorCurrency required	number [ 0.01 .. 100000 ] Amount in major currency (e.g pounds/dollars/euros)
description required	string Description of the payment
emailAddress	string Customer email address
invoiceId	integer <int64> Invoice identifier, if payment is for an invoice
adhocInvoiceId	integer <int64> adhoc invoice identifier, if payment is for an adhoc invoice
customerId	integer <int64> Customer identifier, if payment is for a customer

Responses

200

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Payload

application/json

{"paymentProviderId": 1,
"amountInMajorCurrency": 10.5,
"description": "string",
"emailAddress": "string",
"invoiceId": 1,
"adhocInvoiceId": 1,
"customerId": 1
}

Response samples

application/json

{"id": 1,
"paymentProviderId": 1,
"amountInMajorCurrency": 10.5,
"currencyId": 1,
"description": "string",
"emailAddress": "string",
"invoiceId": 1,
"adhocInvoiceId": 1,
"customerId": 1,
"paymentLink": "https://instantpaymentlink/exampleref"
}