> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.mycargoextra.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mycargoextra.com/_mcp/server. # Pay Invoice From Wallet POST http://localhost:9000/api/v1/billing/invoice/pay Content-Type: application/json Pays an invoice using wallet balance. Required body fields: `invoice` invoice number, `currency` code. Optional depending on payment flow: `cloneId`, `partPaymentFromWalletBalance` object. Response fields: `message`, `invoiceNo`, `amount`, `walletBalance`. Possible errors: - 404: Invoice not found - invoice number does not belong to the customer. - 404: User not found - authenticated customer was not found downstream. - 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: Customer Invoice does not match expected credentials - invoice belongs to another customer. - 400: Invoice already paid - invoice status is already paid. - 400: Wrong Amount - invoice payable amount is invalid. - 400: Insufficient funds - wallet balance cannot cover the invoice. - 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. Reference: https://docs.mycargoextra.com/cargo-extra-gateway-api-copy/billing/invoice/billing-invoice-pay/pay-invoice-from-wallet ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /api/v1/billing/invoice/pay: post: operationId: pay-invoice-from-wallet summary: Pay Invoice From Wallet description: >- Pays an invoice using wallet balance. Required body fields: `invoice` invoice number, `currency` code. Optional depending on payment flow: `cloneId`, `partPaymentFromWalletBalance` object. Response fields: `message`, `invoiceNo`, `amount`, `walletBalance`. Possible errors: - 404: Invoice not found - invoice number does not belong to the customer. - 404: User not found - authenticated customer was not found downstream. - 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: Customer Invoice does not match expected credentials - invoice belongs to another customer. - 400: Invoice already paid - invoice status is already paid. - 400: Wrong Amount - invoice payable amount is invalid. - 400: Insufficient funds - wallet balance cannot cover the invoice. - 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. tags: - >- subpackage_billing.subpackage_billing/invoice.subpackage_billing/invoice/billingInvoicePay responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/billing_invoice_billing > invoice > pay_Pay Invoice From Wallet_Response_200 '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/PostApiV1BillingInvoicePayRequestBadRequestError '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/PostApiV1BillingInvoicePayRequestUnauthorizedError '403': description: Forbidden content: application/json: schema: $ref: >- #/components/schemas/PostApiV1BillingInvoicePayRequestForbiddenError '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/PostApiV1BillingInvoicePayRequestNotFoundError '429': description: Too Many Requests content: application/json: schema: $ref: >- #/components/schemas/PostApiV1BillingInvoicePayRequestTooManyRequestsError '500': description: Internal Server Error content: application/json: schema: $ref: >- #/components/schemas/PostApiV1BillingInvoicePayRequestInternalServerError requestBody: content: application/json: schema: type: object properties: cloneId: type: string invoice: type: integer currency: type: string partPaymentFromWalletBalance: $ref: >- #/components/schemas/ApiV1BillingInvoicePayPostRequestBodyContentApplicationJsonSchemaPartPaymentFromWalletBalance required: - cloneId - invoice - currency - partPaymentFromWalletBalance servers: - url: http://localhost:9000 description: http://localhost:9000 components: schemas: ApiV1BillingInvoicePayPostRequestBodyContentApplicationJsonSchemaPartPaymentFromWalletBalance: type: object properties: currency: type: string exchangeRate: type: integer chargeTotalBefore: type: integer chargeTotalCurrent: type: integer required: - currency - exchangeRate - chargeTotalBefore - chargeTotalCurrent title: >- ApiV1BillingInvoicePayPostRequestBodyContentApplicationJsonSchemaPartPaymentFromWalletBalance billing_invoice_billing > invoice > pay_Pay Invoice From Wallet_Response_200: type: object properties: key_0: type: integer key_1: type: string key_2: type: number format: double key_3: type: string key_4: type: boolean required: - key_0 - key_1 - key_2 - key_3 - key_4 title: >- billing_invoice_billing > invoice > pay_Pay Invoice From Wallet_Response_200 PostApiV1BillingInvoicePayRequestBadRequestError: type: object properties: message: type: string required: - message title: PostApiV1BillingInvoicePayRequestBadRequestError PostApiV1BillingInvoicePayRequestUnauthorizedError: type: object properties: message: type: string required: - message title: PostApiV1BillingInvoicePayRequestUnauthorizedError PostApiV1BillingInvoicePayRequestForbiddenError: type: object properties: message: type: string required: - message title: PostApiV1BillingInvoicePayRequestForbiddenError PostApiV1BillingInvoicePayRequestNotFoundError: type: object properties: message: type: string required: - message title: PostApiV1BillingInvoicePayRequestNotFoundError PostApiV1BillingInvoicePayRequestTooManyRequestsError: type: object properties: message: type: string required: - message title: PostApiV1BillingInvoicePayRequestTooManyRequestsError PostApiV1BillingInvoicePayRequestInternalServerError: type: object properties: message: type: string required: - message title: PostApiV1BillingInvoicePayRequestInternalServerError ``` ## Examples **Request** ```json { "cloneId": "64f000000000000000000002", "invoice": 100123, "currency": "NGN", "partPaymentFromWalletBalance": { "currency": "NGN", "exchangeRate": 1, "chargeTotalBefore": 15000, "chargeTotalCurrent": 5000 } } ``` **Response** ```json { "key_0": 100123, "key_1": "Invoice payment successful", "key_2": 15000, "key_3": "NGN", "key_4": true } ``` **SDK Code** ```python billing_invoice_billing > invoice > pay_Pay Invoice From Wallet_example import requests url = "http://localhost:9000/api/v1/billing/invoice/pay" payload = { "cloneId": "64f000000000000000000002", "invoice": 100123, "currency": "NGN", "partPaymentFromWalletBalance": { "currency": "NGN", "exchangeRate": 1, "chargeTotalBefore": 15000, "chargeTotalCurrent": 5000 } } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript billing_invoice_billing > invoice > pay_Pay Invoice From Wallet_example const url = 'http://localhost:9000/api/v1/billing/invoice/pay'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"cloneId":"64f000000000000000000002","invoice":100123,"currency":"NGN","partPaymentFromWalletBalance":{"currency":"NGN","exchangeRate":1,"chargeTotalBefore":15000,"chargeTotalCurrent":5000}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go billing_invoice_billing > invoice > pay_Pay Invoice From Wallet_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "http://localhost:9000/api/v1/billing/invoice/pay" payload := strings.NewReader("{\n \"cloneId\": \"64f000000000000000000002\",\n \"invoice\": 100123,\n \"currency\": \"NGN\",\n \"partPaymentFromWalletBalance\": {\n \"currency\": \"NGN\",\n \"exchangeRate\": 1,\n \"chargeTotalBefore\": 15000,\n \"chargeTotalCurrent\": 5000\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby billing_invoice_billing > invoice > pay_Pay Invoice From Wallet_example require 'uri' require 'net/http' url = URI("http://localhost:9000/api/v1/billing/invoice/pay") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{\n \"cloneId\": \"64f000000000000000000002\",\n \"invoice\": 100123,\n \"currency\": \"NGN\",\n \"partPaymentFromWalletBalance\": {\n \"currency\": \"NGN\",\n \"exchangeRate\": 1,\n \"chargeTotalBefore\": 15000,\n \"chargeTotalCurrent\": 5000\n }\n}" response = http.request(request) puts response.read_body ``` ```java billing_invoice_billing > invoice > pay_Pay Invoice From Wallet_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("http://localhost:9000/api/v1/billing/invoice/pay") .header("Content-Type", "application/json") .body("{\n \"cloneId\": \"64f000000000000000000002\",\n \"invoice\": 100123,\n \"currency\": \"NGN\",\n \"partPaymentFromWalletBalance\": {\n \"currency\": \"NGN\",\n \"exchangeRate\": 1,\n \"chargeTotalBefore\": 15000,\n \"chargeTotalCurrent\": 5000\n }\n}") .asString(); ``` ```php billing_invoice_billing > invoice > pay_Pay Invoice From Wallet_example request('POST', 'http://localhost:9000/api/v1/billing/invoice/pay', [ 'body' => '{ "cloneId": "64f000000000000000000002", "invoice": 100123, "currency": "NGN", "partPaymentFromWalletBalance": { "currency": "NGN", "exchangeRate": 1, "chargeTotalBefore": 15000, "chargeTotalCurrent": 5000 } }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp billing_invoice_billing > invoice > pay_Pay Invoice From Wallet_example using RestSharp; var client = new RestClient("http://localhost:9000/api/v1/billing/invoice/pay"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"cloneId\": \"64f000000000000000000002\",\n \"invoice\": 100123,\n \"currency\": \"NGN\",\n \"partPaymentFromWalletBalance\": {\n \"currency\": \"NGN\",\n \"exchangeRate\": 1,\n \"chargeTotalBefore\": 15000,\n \"chargeTotalCurrent\": 5000\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift billing_invoice_billing > invoice > pay_Pay Invoice From Wallet_example import Foundation let headers = ["Content-Type": "application/json"] let parameters = [ "cloneId": "64f000000000000000000002", "invoice": 100123, "currency": "NGN", "partPaymentFromWalletBalance": [ "currency": "NGN", "exchangeRate": 1, "chargeTotalBefore": 15000, "chargeTotalCurrent": 5000 ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:9000/api/v1/billing/invoice/pay")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```