Payment links

Save the uploaded payment links

Step 2 of the bulk upload. Persists the payment links that were validated by importPaymentLinks, identified by the correlationId returned there. Separating validation from the write keeps a partially invalid sheet from creating any links.

post/v2/paymentRequest/saveInvoice

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/paymentRequest/saveInvoice
  • Auth: API key in header Authorization

Query parameters

correlationIdstring required

The correlationId returned by the import step.

operation'save' required

The operation to perform on the validated data. Send save.

Request body

object required

Response

The payment links that were created from the validated sheet.

_idstring

Internal record id.

paymentLinkIdstring

The payment link identifier, e.g. PL-2348668602.

paymentRequestIdstring

The underlying payment request id, e.g. PR-2348668602.

merchantIdstring

The merchant id, e.g. MID-XXXXX-XXX.

storeNamestring
descriptionstring
customerNamestring
customerunknown
currencystring
totalAmountnumber
totalAmountWithoutFeesnumber

The amount before extraFees are applied.

availableAmountForRefundnumber
paymentTypestring
paymentStatusstring

Payment state, e.g. paid, unpaid.

statestring
dueDateunknown
creationDatestring
referenceIdstring
invoiceReferenceIdstring
isSuspendedPaymentboolean
isManualCaptureboolean
isDeletedboolean
isPaymentLinkboolean
isBulkCreatedboolean
labelsstring[]
transactionsobject[]

Transactions recorded against the link.

virtualAmountunknown
virtualCurrencyunknown
virtualExchangeRateunknown
virtualRateRecordedAtunknown

Changes

No recorded changes to this operation across all 1 revision of this API.