Prepare Invoice Part Payment From Wallet | CargoExtra Global Logistics USA

Prepares an invoice for part-payment where current wallet balance is used first and remaining amount is paid online.

Required body fields: invoice invoice number, currency code.

Response fields: message, invoice.invoiceNo, invoice.eligibleForPayment, invoice.partPaymentFromWalletBalance, invoice.currencyPaid, invoice.exchangeRate, invoice.chargeTotal.

Possible errors:

404: Invoice not found - invoice number does not belong to the customer.
404: Currency not found - supplied currency code is unknown.
400: Currency does not match expected credentials - invoice currency differs from request.
400: Wallet not found - customer wallet is missing.
400: Invoice already paid - invoice status is already paid.
400: Wrong Amount - invoice payable amount is invalid.
400: Wallet balance is too high for this endpoint - use full wallet payment instead.
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.

Prepares an invoice for part-payment where current wallet balance is used first and remaining amount is paid online. Required body fields: `invoice` invoice number, `currency` code. Response fields: `message`, `invoice.invoiceNo`, `invoice.eligibleForPayment`, `invoice.partPaymentFromWalletBalance`, `invoice.currencyPaid`, `invoice.exchangeRate`, `invoice.chargeTotal`. Possible errors: - 404: Invoice not found - invoice number does not belong to the customer. - 404: Currency not found - supplied currency code is unknown. - 400: Currency does not match expected credentials - invoice currency differs from request. - 400: Wallet not found - customer wallet is missing. - 400: Invoice already paid - invoice status is already paid. - 400: Wrong Amount - invoice payable amount is invalid. - 400: Wallet balance is too high for this endpoint - use full wallet payment instead. - 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.

invoiceintegerRequired

currencystringRequired

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

Prepares an invoice for part-payment where current wallet balance is used first and remaining amount is paid online.

Required body fields: invoice invoice number, currency code.

Response fields: message, invoice.invoiceNo, invoice.eligibleForPayment, invoice.partPaymentFromWalletBalance, invoice.currencyPaid, invoice.exchangeRate, invoice.chargeTotal.

Possible errors:

404: Invoice not found - invoice number does not belong to the customer.
404: Currency not found - supplied currency code is unknown.
400: Currency does not match expected credentials - invoice currency differs from request.
400: Wallet not found - customer wallet is missing.
400: Invoice already paid - invoice status is already paid.
400: Wrong Amount - invoice payable amount is invalid.
400: Wallet balance is too high for this endpoint - use full wallet payment instead.
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/part-process \
>	-H "Content-Type: application/json" \
>	-d '{
>	"invoice": 100123,
>	"currency": "NGN"
>	}'

1	{
2	"key_0": 7724,
3	"key_1": "string",
4	"key_2": 4012.6776549813535,
5	"key_3": "string",
6	"key_4": false
7	}