Skip to navigation
CargoExtra Gateway API CopyBillingInvoiceBilling Invoice PaypalCapture

Capture PayPal Invoice Payment

View as Markdown

Finalizes a PayPal invoice payment after PayPal capture.

Required body fields: invoiceNo, amount, currencyCode, paymentId, partPaymentFromWalletBalance.

Response fields: message, status, invoice, invoiceNo, amount, paymentId.

Possible errors:

  • 404: Invoice not found - invoice number does not belong to the customer.
  • 400: Bad Invoice - invoice already paid or in invalid payment state.
  • 400: Invalid Currency - currencyCode does not match invoice currency.
  • 400: Payment method is disabled - PayPal is not active for the currency.
  • 400: Invalid Amount - amount paid does not match expected amount.
  • 400: Missing One or More Required Parameters - required body/query fields were not supplied.
  • 401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found.
  • 403: Access denied - gateway traffic guard/rate policy blocked the request.
  • 429: Too many requests - gateway rate limit exceeded.
  • 500: Unexpected Error - unhandled gateway or downstream service failure.

Request

This endpoint expects an object.
amountintegerRequired
invoiceNointegerRequired
paymentIdstringRequired
currencyCodestringRequired
partPaymentFromWalletBalanceobjectRequired

Response

OK
key_0integer
key_1string
key_2double
key_3string
key_4boolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error