Skip to main content
POST
/
v2
/
invoicing
/
invoices
/
{invoice_id}
/
payments
Record payment for invoice
curl --request POST \
  --url https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{invoice_id}/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "BANK_TRANSFER",
  "payment_id": "<string>",
  "payment_date": "<string>",
  "payment_date_time": "<string>",
  "note": "<string>",
  "amount": {
    "currency_code": "<string>",
    "value": "<string>"
  },
  "shipping_info": {
    "business_name": "<string>",
    "name": {
      "prefix": "<string>",
      "given_name": "<string>",
      "surname": "<string>",
      "middle_name": "<string>",
      "suffix": "<string>",
      "alternate_full_name": "<string>",
      "full_name": "<string>"
    },
    "address": {
      "country_code": "<string>",
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "address_line_3": "<string>",
      "admin_area_4": "<string>",
      "admin_area_3": "<string>",
      "admin_area_2": "<string>",
      "admin_area_1": "<string>",
      "postal_code": "<string>",
      "address_details": {
        "street_number": "<string>",
        "street_name": "<string>",
        "street_type": "<string>",
        "delivery_service": "<string>",
        "building_name": "<string>",
        "sub_building": "<string>"
      }
    }
  }
}
'
{
  "payment_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Oauth 2.0 authentication

Path Parameters

​
invoice_id
string
required

The ID of the draft invoice to delete.

Maximum string length: 2147483647

Body

application/json

The details of the payment to record against the invoice.

The payment details of the invoice. Includes payment type, method, date, discount, and transaction type.

​
method
enum<string>
required

The payment mode or method through which the invoicer can accept the payment.

Available options:
BANK_TRANSFER,
CASH,
CHECK,
CREDIT_CARD,
DEBIT_CARD,
PAYPAL,
WIRE_TRANSFER,
OTHER
Maximum string length: 255
​
payment_id
string

The ID for a PayPal payment transaction. Required for the PAYPAL payment type.

Maximum string length: 22
​
payment_date
string<ppaas_date_notime_v2>

The date when the invoice was paid, in Internet date and time format. For example, yyyy-MM-dd z.

Required string length: 10
​
payment_date_time
string<ppaas_date_time_v3>

The date-time when the invoice was paid. For example, yyyy-MM-dd T HH: mm: ss z. The time zone will be UTC.

Required string length: 20 - 64
​
note
string

A note associated with an external cash or check payment.

Maximum string length: 2000
​
amount
Money · object

The payment amount to record against the invoice. If you omit this parameter, the total invoice amount is marked as paid. This amount cannot exceed the amount due.

​
shipping_info
Contact Information · object

The recipient's shipping information. Includes the user's contact information, which includes name and address.

Response

A successful request returns the HTTP 200 Created status code and a reference to the recorded payment.

The reference to the payment detail.

​
payment_id
string

The ID for the invoice payment.

Required string length: 1 - 22