> 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.

# Capture PayPal Invoice Payment

POST http://localhost:9000/api/v1/billing/invoice/paypal/capture
Content-Type: application/json

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.

Reference: https://docs.mycargoextra.com/cargo-extra-gateway-api-copy/billing/invoice/billing-invoice-paypal/capture/capture-pay-pal-invoice-payment

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /api/v1/billing/invoice/paypal/capture:
    post:
      operationId: capture-pay-pal-invoice-payment
      summary: Capture PayPal Invoice Payment
      description: >-
        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.
      tags:
        - >-
          subpackage_billing.subpackage_billing/invoice.subpackage_billing/invoice/billingInvoicePaypal.subpackage_billing/invoice/billingInvoicePaypal/capture
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/billing_invoice_billing > invoice >
                  paypal_capture_Capture PayPal Invoice Payment_Response_200
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1BillingInvoicePaypalCaptureRequestBadRequestError
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1BillingInvoicePaypalCaptureRequestUnauthorizedError
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1BillingInvoicePaypalCaptureRequestForbiddenError
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1BillingInvoicePaypalCaptureRequestNotFoundError
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1BillingInvoicePaypalCaptureRequestTooManyRequestsError
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1BillingInvoicePaypalCaptureRequestInternalServerError
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                invoiceNo:
                  type: integer
                paymentId:
                  type: string
                currencyCode:
                  type: string
                partPaymentFromWalletBalance:
                  $ref: >-
                    #/components/schemas/ApiV1BillingInvoicePaypalCapturePostRequestBodyContentApplicationJsonSchemaPartPaymentFromWalletBalance
              required:
                - amount
                - invoiceNo
                - paymentId
                - currencyCode
                - partPaymentFromWalletBalance
servers:
  - url: http://localhost:9000
    description: http://localhost:9000
components:
  schemas:
    ApiV1BillingInvoicePaypalCapturePostRequestBodyContentApplicationJsonSchemaPartPaymentFromWalletBalance:
      type: object
      properties:
        currency:
          type: string
        exchangeRate:
          type: integer
        chargeTotalBefore:
          type: integer
        chargeTotalCurrent:
          type: integer
      required:
        - currency
        - exchangeRate
        - chargeTotalBefore
        - chargeTotalCurrent
      title: >-
        ApiV1BillingInvoicePaypalCapturePostRequestBodyContentApplicationJsonSchemaPartPaymentFromWalletBalance
    billing_invoice_billing > invoice > paypal_capture_Capture PayPal Invoice Payment_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 > paypal_capture_Capture PayPal
        Invoice Payment_Response_200
    PostApiV1BillingInvoicePaypalCaptureRequestBadRequestError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      title: PostApiV1BillingInvoicePaypalCaptureRequestBadRequestError
    PostApiV1BillingInvoicePaypalCaptureRequestUnauthorizedError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      title: PostApiV1BillingInvoicePaypalCaptureRequestUnauthorizedError
    PostApiV1BillingInvoicePaypalCaptureRequestForbiddenError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      title: PostApiV1BillingInvoicePaypalCaptureRequestForbiddenError
    PostApiV1BillingInvoicePaypalCaptureRequestNotFoundError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      title: PostApiV1BillingInvoicePaypalCaptureRequestNotFoundError
    PostApiV1BillingInvoicePaypalCaptureRequestTooManyRequestsError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      title: PostApiV1BillingInvoicePaypalCaptureRequestTooManyRequestsError
    PostApiV1BillingInvoicePaypalCaptureRequestInternalServerError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      title: PostApiV1BillingInvoicePaypalCaptureRequestInternalServerError

```

## Examples



**Request**

```json
{
  "amount": 250,
  "invoiceNo": 458732,
  "paymentId": "PAYPAL-9X8Y7Z6W5V4U3T2S1R0",
  "currencyCode": "USD",
  "partPaymentFromWalletBalance": {
    "currency": "USD",
    "exchangeRate": 1,
    "chargeTotalBefore": 250,
    "chargeTotalCurrent": 0
  }
}
```

**Response**

```json
{
  "key_0": 458732,
  "key_1": "Payment captured successfully",
  "key_2": 250,
  "key_3": "PAYPAL-9X8Y7Z6W5V4U3T2S1R0",
  "key_4": true
}
```

**SDK Code**

```python billing_invoice_billing > invoice > paypal_capture_Capture PayPal Invoice Payment_example
import requests

url = "http://localhost:9000/api/v1/billing/invoice/paypal/capture"

payload = {
    "amount": 250,
    "invoiceNo": 458732,
    "paymentId": "PAYPAL-9X8Y7Z6W5V4U3T2S1R0",
    "currencyCode": "USD",
    "partPaymentFromWalletBalance": {
        "currency": "USD",
        "exchangeRate": 1,
        "chargeTotalBefore": 250,
        "chargeTotalCurrent": 0
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript billing_invoice_billing > invoice > paypal_capture_Capture PayPal Invoice Payment_example
const url = 'http://localhost:9000/api/v1/billing/invoice/paypal/capture';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"amount":250,"invoiceNo":458732,"paymentId":"PAYPAL-9X8Y7Z6W5V4U3T2S1R0","currencyCode":"USD","partPaymentFromWalletBalance":{"currency":"USD","exchangeRate":1,"chargeTotalBefore":250,"chargeTotalCurrent":0}}'
};

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 > paypal_capture_Capture PayPal Invoice Payment_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:9000/api/v1/billing/invoice/paypal/capture"

	payload := strings.NewReader("{\n  \"amount\": 250,\n  \"invoiceNo\": 458732,\n  \"paymentId\": \"PAYPAL-9X8Y7Z6W5V4U3T2S1R0\",\n  \"currencyCode\": \"USD\",\n  \"partPaymentFromWalletBalance\": {\n    \"currency\": \"USD\",\n    \"exchangeRate\": 1,\n    \"chargeTotalBefore\": 250,\n    \"chargeTotalCurrent\": 0\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 > paypal_capture_Capture PayPal Invoice Payment_example
require 'uri'
require 'net/http'

url = URI("http://localhost:9000/api/v1/billing/invoice/paypal/capture")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 250,\n  \"invoiceNo\": 458732,\n  \"paymentId\": \"PAYPAL-9X8Y7Z6W5V4U3T2S1R0\",\n  \"currencyCode\": \"USD\",\n  \"partPaymentFromWalletBalance\": {\n    \"currency\": \"USD\",\n    \"exchangeRate\": 1,\n    \"chargeTotalBefore\": 250,\n    \"chargeTotalCurrent\": 0\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java billing_invoice_billing > invoice > paypal_capture_Capture PayPal Invoice Payment_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("http://localhost:9000/api/v1/billing/invoice/paypal/capture")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 250,\n  \"invoiceNo\": 458732,\n  \"paymentId\": \"PAYPAL-9X8Y7Z6W5V4U3T2S1R0\",\n  \"currencyCode\": \"USD\",\n  \"partPaymentFromWalletBalance\": {\n    \"currency\": \"USD\",\n    \"exchangeRate\": 1,\n    \"chargeTotalBefore\": 250,\n    \"chargeTotalCurrent\": 0\n  }\n}")
  .asString();
```

```php billing_invoice_billing > invoice > paypal_capture_Capture PayPal Invoice Payment_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:9000/api/v1/billing/invoice/paypal/capture', [
  'body' => '{
  "amount": 250,
  "invoiceNo": 458732,
  "paymentId": "PAYPAL-9X8Y7Z6W5V4U3T2S1R0",
  "currencyCode": "USD",
  "partPaymentFromWalletBalance": {
    "currency": "USD",
    "exchangeRate": 1,
    "chargeTotalBefore": 250,
    "chargeTotalCurrent": 0
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp billing_invoice_billing > invoice > paypal_capture_Capture PayPal Invoice Payment_example
using RestSharp;

var client = new RestClient("http://localhost:9000/api/v1/billing/invoice/paypal/capture");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"amount\": 250,\n  \"invoiceNo\": 458732,\n  \"paymentId\": \"PAYPAL-9X8Y7Z6W5V4U3T2S1R0\",\n  \"currencyCode\": \"USD\",\n  \"partPaymentFromWalletBalance\": {\n    \"currency\": \"USD\",\n    \"exchangeRate\": 1,\n    \"chargeTotalBefore\": 250,\n    \"chargeTotalCurrent\": 0\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift billing_invoice_billing > invoice > paypal_capture_Capture PayPal Invoice Payment_example
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "amount": 250,
  "invoiceNo": 458732,
  "paymentId": "PAYPAL-9X8Y7Z6W5V4U3T2S1R0",
  "currencyCode": "USD",
  "partPaymentFromWalletBalance": [
    "currency": "USD",
    "exchangeRate": 1,
    "chargeTotalBefore": 250,
    "chargeTotalCurrent": 0
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:9000/api/v1/billing/invoice/paypal/capture")! 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()
```