Presentment Currency Integration

Presentment currency is supported on the following APIs:

• PayPal REST Payments
• NVP/SOAP Express Checkout

Prerequisites

To use presentment currencies, you must:

1. Be enrolled in the pilot program. For more information, reach out to your PayPal account manager.

2. Be able to make calls to the PayPal REST or NVP/SOAP API.

   • REST APIs:

     Before you can integrate Presentment Currency, you must set up your development environment. After you get a token that lets you access protected REST API resources, you create sandbox accounts to test your web and mobile apps. For details, see Get started.

     Then, return to this page to integrate Presentment Currency.

   • NVP/SOAP APIs: You must have the appropriate credentials to make NVP/SOAP API calls.

3. Verify the receiver of funds has a PayPal account. Presentment currencies are supported only for PayPal account holders.

Change currency code passed in API calls

After you enroll in the pilot program and access to the presentment currencies is enabled, you can transact in holding currencies or presentment currencies using the PayPal REST Payments API or the NVP/SOAP Express Checkout API.

To use the presentment currency in your integration, you must update the currency code you pass in any of your API requests that reference currency.

These API samples demonstrate the use of presentment currency codes:

• REST API sample
• NVP API sample
• SOAP API sample

REST API sample

This Payments API sample request creates a payment and uses the presentment currency code for the Kenyan Shilling (KES):

1{
2  "intent": "sale",
3  "payer": {
4    "payment_method": "paypal"
5  },
6  "transactions": [{
7    "amount": {
8      "total": "20.00",
9      "currency": "KES"
10    },
11    "description": "The transaction description.",
12    "invoice_number": "984891351",
13    "payment_options": {
14      "allowed_payment_method": "INSTANT_FUNDING_SOURCE"
15    },
16    "item_list": {
17      "items": [{
18        "name": "Hat",
19        "description": "Blue Hat",
20        "quantity": "2",
21        "price": "10",
22        "sku": "product1",
23        "currency": "KES"
24      }]
25    }
26  }],
27  "redirect_urls": {
28    "return_url": "https://example.com/return",
29    "cancel_url": "https://example.com/cancel"
30  }
31}

Make sure you update the currency codes in your other Payments REST API requests in a similar manner.

Related information

• PayPal REST Payments API
• Create payment operation

NVP API sample

This Express Checkout API sample request specifies parameters for a sale payment with the NVP SetExpressCheckout operation and uses the presentment currency code for the Kenyan Shilling (KES):

1USER=<xxxxxxxx>
2PWD=<xxxxxxx>
3SIGNATURE=<xxxxxxxxx>
4METHOD=SetExpressCheckout
5VERSION=124.0
6RETURNURL=https://example.com/return
7CANCELURL=https://example.com/cancel
8PAYMENTREQUEST_0_PAYMENTACTION=Sale
9PAYMENTREQUEST_0_AMT=524.20
10PAYMENTREQUEST_0_CURRENCYCODE=KES
11PAYMENTREQUEST_0_DESC=test EC payment

Make sure you update the currency codes in your other Express Checkout API requests in a similar manner.

Related information

• NVP/SOAP Express Checkout API
• SetExpressCheckout operation

SOAP API sample

This Express Checkout API sample request specifies parameters for a sale payment with the SOAP SetExpressCheckout operation and uses the presentment currency code for the Kenyan Shilling (KES):

1USER=<username>
2VENDOR=<vendor>
3PARTNER=PayPal
4PWD=<password>
5TRXTYPE=S
6TENDER=P
7ACTION=S
8AMT=0.01
9CURRENCY=KES
10RETURNURL=https://example.com/return
11CANCELURL=https://example.com/cancel
12ORDERDESC=test order
13INVNUM=INX123

Make sure you update the currency codes in your other Express Checkout API requests in a similar manner.

Related information

• NVP/SOAP Express Checkout API
• SetExpressCheckout operation