Capture PayPal Invoice Payment | CargoExtra Global Logistics USA

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.

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

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

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.

$	curl -X POST http://localhost:9000/api/v1/billing/invoice/paypal/capture \
>	-H "Content-Type: application/json" \
>	-d '{
>	"amount": 250,
>	"invoiceNo": 458732,
>	"paymentId": "PAYPAL-9X8Y7Z6W5V4U3T2S1R0",
>	"currencyCode": "USD",
>	"partPaymentFromWalletBalance": {
>	"currency": "USD",
>	"exchangeRate": 1,
>	"chargeTotalBefore": 250,
>	"chargeTotalCurrent": 0
>	}
>	}'

1	{
2	"key_0": 458732,
3	"key_1": "Payment captured successfully",
4	"key_2": 250,
5	"key_3": "PAYPAL-9X8Y7Z6W5V4U3T2S1R0",
6	"key_4": true
7	}