Skip to content

Commit

Permalink
Updating docs with RecipientAddress information.
Browse files Browse the repository at this point in the history
  • Loading branch information
brentscheffler committed Jun 28, 2020
1 parent 70e3dbe commit 8a06347
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ For a full description of the response payload, please see the [official Plaid A

### Payment Initiation (UK only)

* `createRecipient(string $name, string $iban, PaymentAddress $address): object` [[?]](https://plaid.com/docs/#payment-initiation) **Note:** See the **Entities** section for details about the `PaymentAddress` entity needed for this method.
* `createRecipient(string $name, string $iban, RecipientAddress $address): object` [[?]](https://plaid.com/docs/#payment-initiation) **Note:** See the **Entities** section for details about the `RecipientAddress` entity needed for this method.
* `getRecipient(string $recipient_id): object` [[?]](https://plaid.com/docs/#payment-initiation)
* `listRecipients(): object` [[?]](https://plaid.com/docs/#payment-initiation)
* `createPayment(string $recipient_id, string $reference, float $amount, string $currency): object` [[?]](https://plaid.com/docs/#payment-initiation)
Expand All @@ -187,14 +187,14 @@ For a full description of the response payload, please see the [official Plaid A

## Entities

### PaymentAddress
### RecipientAddress

The `TomorrowIdeas\Plaid\Entities\PaymentAddress` entity is used to represent an address object for the recipient of a payment request.
The `TomorrowIdeas\Plaid\Entities\RecipientAddress` entity is used to represent an address object for the recipient of a payment request.

Example:

```php
$address = new TomorrowIdeas\Plaid\Entities\PaymentAddress("123 Elm St.", "Apt 1", "Anytown", "ABC 123", "GB");
$address = new TomorrowIdeas\Plaid\Entities\RecipientAddress("123 Elm St.", "Apt 1", "Anytown", "ABC 123", "GB");
```

## Errors
Expand Down

0 comments on commit 8a06347

Please sign in to comment.