react-native-payments/docs/PaymentRequest.md

Welcome to the best and most comprehensive library for integrating payments like Apple Pay and Google Pay into your React Native app.

# PaymentRequest
### constructor(methodData, details, ?options)
Initializes the payment request.

__Arguments__
- methodData - `Array<PaymentMethodData>`
- details - `PaymentDetailsInit`
- ?options - `PaymentOptions`

<details>
<summary><strong>Example</strong></summary>

```es6
const METHOD_DATA = [
  {
    supportedMethods: ['apple-pay'],
    data: {
      merchantIdentifier: 'merchant.com.your-app.namespace',
      supportedNetworks: ['visa', 'mastercard', 'amex'],
      countryCode: 'US',
      currencyCode: 'USD'
    }
  }
];

const DETAILS = {
  id: 'demo',
  displayItems: [
    {
      label: 'Movie Ticket',
      amount: { currency: 'USD', value: '15.00' }
    },
    {
      label: 'Shipping',
      amount: { currency: 'USD', value: '0.00' }
    }
  ],
  total: {
    label: 'Merchant Name',
    amount: { currency: 'USD', value: '15.00' }
  },
  shippingOptions: [
    {
      id: 'economy',
      label: 'Economy Shipping',
      amount: { currency: 'USD', value: '0.00' },
      detail: 'Arrives in 3-5 days',
      selected: true
    },
    {
      id: 'express',
      label: 'Express Shipping',
      amount: { currency: 'USD', value: '5.00' },
      detail: 'Arrives tomorrow'
    }
  ]
};

const OPTIONS = {
  requestPayerName: true,
  requestPayerPhone: true,
  requestPayerEmail: true,
  requestShipping: true
};

const paymentRequest = new PaymentRequest(METHOD_DATA, DETAILS, OPTIONS);
```

</details>

---

### canMakePayments()
Determines if a payment request can be used to accept a payment based on the supported networks provided in the payment method data.

<details>
<summary><strong>Example</strong></summary>

```es6
paymentRequest.canMakePayments()
  .then(canMakePayments => {
	if (canMakePayments) {
	  return paymentRequest.show();
	}

	// Show fallback payment method
  });
```

</details>

---

### static canMakePaymentsUsingNetworks()
**(IOS only)** Determines if user has active cards in Apple pay that matches passed networks.

__Arguments__
- usingNetworks - `Array`

<details>
<summary><strong>Example</strong></summary>

```es6
PaymentRequest
    .canMakePaymentsUsingNetworks(['Visa', 'AmEx', 'MasterCard'])
    .then(canMakePayments => {
        if (canMakePayments) {
            // do some stuff
        }
    });
```

</details>

---

### show()
Displays the payment request to the user.

<details>
<summary><strong>Example</strong></summary>

```es6
paymentRequest
  .show()
  .then(paymentResponse => chargePaymentResponse(paymentResponse));
```

</details>

---

### abort()
Dismisses the payment request.

<details>
<summary><strong>Example</strong></summary>

```es6
paymentRequest.abort();
```

</details>

---

### id
Returns the payment requests's `details.id`

<details>
<summary><strong>Example</strong></summary>

```es6
console.log(paymentRequest.id); // demo
```

</details>

---

### shippingAddress
A payment request's `shippingAddress` is populated when the user provides a shipping address. It is `null` by default.

<details>
<summary><strong>Example</strong></summary>

```es6
console.log(paymentRequest.shippingAddress); // null
```

</details>

---

### shippingOption
A payment request's `shippingOption` is populated when the user chooses a shipping option. It is `null` by default.

<details>
<summary><strong>Example</strong></summary>

```es6
console.log(paymentRequest.shippingOption); // economy
```

</details>

---