Record payment for invoice

Records a payment for the invoice. If no payment is due, the invoice is marked as `PAID`. Otherwise, the invoice is marked as `PARTIALLY PAID`.

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

For managing (Create, Update, Delete) invoice.https://uri.paypal.com/services/invoicing/invoices/readwrite

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

payment_idstring<currency_code>Optional

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

Match^[\S\s]*$Length0 <= length <= 22

payment_datestring<date_no_time>Optional

The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

payment_date_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Length20 <= length <= 64

methodenum<payment_method>Required

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

Allowed values

"BANK_TRANSFER"
"CASH"
"CHECK"
"CREDIT_CARD"
"DEBIT_CARD"
"PAYPAL"
"WIRE_TRANSFER"
"OTHER"

notestring<currency_code>Optional

A note associated with an external cash or check payment.

Match^[\S\s]*$Length0 <= length <= 2000

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

shipping_infoobject<contact_name_address>Optional

The contact information of the user. Includes name and address.

contact_name_address properties

4 properties

business_namestringOptional

Required. The business name of the party.

Match^.*$Length0 <= length <= 300

orthographyenum<orthography>Optional

The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on [most widely used writing systems](https://www.worldatlas.com/articles/the-world-s-most-popular-writing-scripts.html).

Allowed values

"Arab"
"Armn"
"Beng"
"Cans"
"Cyrl"
"Deva"
"Ethi"
"Geor"
"Grek"
"Gujr"
"Guru"
"Hani"

nameobject<person_name>Optional

The name of a person.

addressobject<address_portable>Optional

The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).

address_portable properties

10 properties

address_line_1stringOptional

The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

Match^.*$Length0 <= length <= 300

address_line_2stringOptional

The second line of the address, for example, a suite or apartment number.

Match^.*$Length0 <= length <= 300

address_line_3stringOptional

The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address.

Match^.*$Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. This is smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code that is used in Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Match^.*$Length0 <= length <= 100

admin_area_3stringOptional

The sub-locality, suburb, neighborhood, or district. This is smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, *bairro*, or neighborhood.
India. Sub-locality or district. Street name information isn't always available, but a sub-locality or district can be a very small area.

Match^.*$Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Match^.*$Length0 <= length <= 120

admin_area_1stringOptional

The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A *kanton*.

Match^.*$Length0 <= length <= 300

postal_codestringOptional

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Match^.*$Length0 <= length <= 60

country_codestring<country_code>Required

The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

address_detailsobject<Address Details>Optional

The non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is redundant with core fields. For example, `address_portable.address_line_1` is usually a combination of `address_details.street_number`, `street_name`, and `street_type`.

Response Body

`application/json`

curl -X POST "https://example.com/v2/invoicing/invoices/INV2-Z56S-5LLA-Q52L-CPZ5/payments" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "Content-Type: application/json" \  -d '{    "method": "BANK_TRANSFER",    "payment_date": "2018-05-01",    "amount": {      "currency_code": "USD",      "value": "10.00"    }  }'

{  "payment_id": "EXTR-86F38350LX4353815"}

Header Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

payment_idstring<currency_code>Optional

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

Match^[\S\s]*$Length0 <= length <= 22

payment_datestring<date_no_time>Optional

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

payment_date_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Length20 <= length <= 64

methodenum<payment_method>Required

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

Allowed values

"BANK_TRANSFER"
"CASH"
"CHECK"
"CREDIT_CARD"
"DEBIT_CARD"
"PAYPAL"
"WIRE_TRANSFER"
"OTHER"

notestring<currency_code>Optional

A note associated with an external cash or check payment.

Match^[\S\s]*$Length0 <= length <= 2000

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

shipping_infoobject<contact_name_address>Optional

The contact information of the user. Includes name and address.

contact_name_address properties

4 properties

business_namestringOptional

Required. The business name of the party.

Match^.*$Length0 <= length <= 300

orthographyenum<orthography>Optional

Allowed values

"Arab"
"Armn"
"Beng"
"Cans"
"Cyrl"
"Deva"
"Ethi"
"Geor"
"Grek"
"Gujr"
"Guru"
"Hani"

nameobject<person_name>Optional

The name of a person.

addressobject<address_portable>Optional

address_portable properties

10 properties

address_line_1stringOptional

The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

Match^.*$Length0 <= length <= 300

address_line_2stringOptional

The second line of the address, for example, a suite or apartment number.

Match^.*$Length0 <= length <= 300

address_line_3stringOptional

The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address.

Match^.*$Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. This is smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code that is used in Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Match^.*$Length0 <= length <= 100

admin_area_3stringOptional

The sub-locality, suburb, neighborhood, or district. This is smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, *bairro*, or neighborhood.
India. Sub-locality or district. Street name information isn't always available, but a sub-locality or district can be a very small area.

Match^.*$Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Match^.*$Length0 <= length <= 120

admin_area_1stringOptional

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A *kanton*.

Match^.*$Length0 <= length <= 300

postal_codestringOptional

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Match^.*$Length0 <= length <= 60

country_codestring<country_code>Required

The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

address_detailsobject<Address Details>Optional

curl -X POST "https://example.com/v2/invoicing/invoices/INV2-Z56S-5LLA-Q52L-CPZ5/payments" \ -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \ -H "Content-Type: application/json" \ -d '{ "method": "BANK_TRANSFER", "payment_date": "2018-05-01", "amount": { "currency_code": "USD", "value": "10.00" } }'

money properties

contact_name_address properties

person_name properties

address_portable properties

Address Details properties

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

defaultapplication/json

On this page

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Record payment for invoice

money properties

contact_name_address properties

person_name properties

address_portable properties

Address Details properties

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

defaultapplication/json

On this page

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`