Pay upon Invoice

To trigger and enable invoices and invoice transactions in the PayPal PLUS Payment Selection Page (PSP), you enable Pay upon Invoice at the account level. The execute payment call returns payment instructions details.

By default, Pay upon Invoice is offered for total amounts between 1,50 and 1470 EUR.

A successful transaction completion redirects the buyer to a success page that provides the PayPal settlement amount in accordance with the payment instructions.

Get payment instructions

When a user selects to Pay upon Invoice, the following parameters are returned in a payment instruction object as part of the response to a successful execute payment request.

Parameter Type Description
reference_number string The ID of the payment instruction.
instruction_type string The type of payment instruction.
recipient_banking_instruction object The recipient bank details.
amount object The base object for all financial-value related fields.
payment_due_date string The date and time when the buyer's payment is due.

Also, the API returns a HATEOAS link that enables you to show payment instructions.

Important: Payment instructions and the HATEAOS link to retrieve payment instructions must be stored in a database table where it can later be retrieved for the invoice print.

Sample response for execute payment

[payment_instruction] => Array
    (
        [reference_number] => 7FC35911MD7697828
        [instruction_type] => PAY_UPON_INVOICE
        [recipient_banking_instruction] => Array
            (
             [bank_name] => Deutsche Bank
             [account_holder_name] => PayPal Europe
             [international_bank_account_number] => DE07120700888000XXXXXX
             [bank_identifier_code] => DEUTDEDBPAL
            )

        [amount] => Array
            (
                [value] => 4.99
                [currency] => EUR
            )

        [payment_due_date] => 2015-09-24

  [links] => Array
            (
                [0] => Array
      (
        [href] => https://api.paypal.com/v1/payments/payment/PAY-1VG08356YH269600PKXOBRAY/payment-instruction
        [rel] => self
        [method] => GET

Note: Payment instructions may also be retrieved at any later stage by calling the Lookup Payment Instructions for a payment resource.

Sample response for payment instructions

lookup payment instructions] => Array
  (
      [reference_number] => 7FC35911MD7697828
      [instruction_type] => PAY_UPON_INVOICE
      [recipient_banking_instruction] => Array
          (
    [bank_name] => Deutsche Bank
    [account_holder_name] => PayPal Europe
    [international_bank_account_number] => DE07120700888000XXXXXX
    [bank_identifier_code] => DEUTDEDBPAL
          )

      [amount] => Array
          (
      [value] => 4.99
      [currency] => EUR
          )

      [payment_due_date] => 2015-09-24
      [links] => Array
          (
[0] => Array
    (
        [href] => https://api.paypal.com/v1/payments/payment/PAY-1VG08356YH269600PKXOBRAY/payment-instruction
        [rel] => self
        [method] => GET
    )

          )
)

Manage invoice payments

PayPal treats Pay upon Invoice transactions the same way that it treats other PLUS transactions. However, you must show the payment instruction that PayPal returns on any generated digital and physical invoices in the shop's admin panel. For example, show the payment instruction on emails, PDFs, and letters that appear in the shop admin panel.

An invoice must only contain the PayPal bank details as returned in the GET call. Do not show the merchant details.

The invoice details must contain:

  • Bank name
  • Account holder name
  • IBAN
  • BIC
  • Ammount due / currency
  • Payment due date
  • Reference number

The payment instructions must always be taken from the values as returned in the instruction. None of the values from the payment instruction object may be hard coded including bank, recipient, and IBAN. These details may be retrieved from the database table or looked up by executing another GET call for the payment resource ID in question.

As best practice, PayPal recommends that you convert the payment due date to the German date format. For example, 2015-09-24 to 24-09-2015.

Also, invoices must have a legal notice:

[Händlername] hat die Forderung gegen Sie im Rahmen eines laufenden Factoringvertrages an die PayPal (Europe) S.àr.l. et Cie, S.C.A. abgetreten. Zahlungen mit schuldbefreiender Wirkung können nur an die PayPal (Europe) S.àr.l. et Cie, S.C.A. geleistet werden.

Note: IBAN is not a static value and must not be saved for future reference. If prior to the invoice print a partial refund was initiated, the changes must be reflected in the payment instructions.