Direct API Integration

⌘K
  2. Home
  4. Docs
  6. Direct API Integration
  8. Cross-Border Payments (PA...
  10. Invoice Upload API

Invoice Upload API

The Invoice Upload API enables merchants to upload payment invoices required for settlement.
Please refer to the below cURL:

curl --location --globoff --request PUT 'https://sandbox-apis.boxpay.tech/v0/merchants/<merchantId>/transactions/<transactionId>/invoices' \
--header 'Authorization: Bearer <apiKey>' \
--form 'invoiceFile=@"<file path>"' \
--form 'invoiceId="<invoice id>"'
Request Parameters:
ParameterTypeRequiredDescription
invoiceFilePDF file RequiredInvoice File in the PDF format
invoiceIdStringRequiredUnique InvoiceID as mentioned in the Invoice

Path Parameters:
ParameterTypeRequiredDescription
merchantIdStringRequiredBoxPay unique id assigned to Merchants. Required to be passed in URL(path parameters) in API calls
transactionIdStringRequiredBoxPay unique transactionId
Sample Success Response –
{
    "pspCode": "PAYU",
    "merchantId": "<merchantId>",
    "transactionId": "<transactionId>",
    "status": "Approved",
    "reason": "File Uploaded Successfully"
}

List of Payment Status

StatusDescription
ReceivedPayment Request was successfully received by BoxPay. It will only be visible to merchants in case of batches with delayed execution.
BatchedPayment Request has been added to a batch to be executed with PSP.
RequiresActionPayment needs input from customer/shopper and requires redirection
PostedPayment request was posted to PSP but has not been executed yet. This status would be available in case of Capture, Refund, Void in case of PSPs that communicate the final status over the callback
ApprovedPayment request was processed by PSP successfully
RejectedPayment request was declined by PSP due to invalid payment instrument details. This represents business failures and are not retryable
FailedPayment request was not successfully processed by PSP due to technical failures. These are retryable with another or same PSPs
SettledPayment request has been settled and money has moved to merchant or customer account depending on the operation(capture/refund)

How can we help?