Record payment for invoice
POST {{base_url}}/v2/invoicing/invoices/:invoice_id/payments
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
.
Request Body
{"method"=>"CASH", "payment_date"=>"2022-02-07", "amount"=>{"currency_code"=>"USD", "value"=>"10.00"}, "type"=>"EXTERNAL", "transaction_type"=>"CAPTURE", "note"=>"<A note associated with an external cash or check payment.>", "shipping_info"=>{"name"=>{"given_name"=>"Stephanie", "surname"=>"Meyers"}, "address"=>{"address_line_1"=>"1234 Main Street", "admin_area_2"=>"Anytown", "admin_area_1"=>"CA", "postal_code"=>"98765", "country_code"=>"US"}}}
HEADERS
| Key | Datatype | Required | Description |
| Content-Type | string | | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. |
| PayPal-Request-Id | string | | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. |
| PayPal-Client-Metadata-Id | string | | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. |
| PayPal-Partner-Attribution-Id | string | | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. |
| PayPal-Auth-Assertion | string | | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant.
|
| Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
| Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
RESPONSES
status: OK
{"payment_id":"EXTR-12P37088AD6588246"}