Developer
<?php
namespace Srmklive\PayPal\Traits\PayPalAPI;
trait Identity
{
/**
* Get user profile information.
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/identity/v1/#userinfo_get
*/
public function showProfileInfo()
{
$this->apiEndPoint = 'v1/identity/openidconnect/userinfo?schema=openid';
$this->setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
$this->verb = 'get';
return $this->doPayPalRequest();
}
/**
* List Users.
*
* @param string $field
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/identity/v2/#users_list
*/
public function listUsers(string $field = 'userName')
{
$this->apiEndPoint = "v2/scim/Users?filter={$field}";
$this->setRequestHeader('Content-Type', 'application/scim+json');
$this->verb = 'get';
return $this->doPayPalRequest();
}
/**
* Show details for a user by ID.
*
* @param string $user_id
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/identity/v2/#users_get
*/
public function showUserDetails(string $user_id)
{
$this->apiEndPoint = "v2/scim/Users/{$user_id}";
$this->setRequestHeader('Content-Type', 'application/scim+json');
$this->verb = 'get';
return $this->doPayPalRequest();
}
/**
* Delete a user by ID.
*
* @param string $user_id
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/identity/v2/#users_get
*/
public function deleteUser(string $user_id)
{
$this->apiEndPoint = "v2/scim/Users/{$user_id}";
$this->setRequestHeader('Content-Type', 'application/scim+json');
$this->verb = 'delete';
return $this->doPayPalRequest(false);
}
/**
* Create a merchant application.
*
* @param string $client_name
* @param array $redirect_uris
* @param array $contacts
* @param string $payer_id
* @param string $migrated_app
* @param string $application_type
* @param string $logo_url
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/identity/v1/#applications_post
*/
public function createMerchantApplication(string $client_name, array $redirect_uris, array $contacts, string $payer_id, string $migrated_app, string $application_type = 'web', string $logo_url = '')
{
$this->apiEndPoint = 'v1/identity/applications';
$this->options['json'] = array_filter([
'application_type' => $application_type,
'redirect_uris' => $redirect_uris,
'client_name' => $client_name,
'contacts' => $contacts,
'payer_id' => $payer_id,
'migrated_app' => $migrated_app,
'logo_uri' => $logo_url,
]);
$this->verb = 'post';
return $this->doPayPalRequest();
}
/**
* Create a merchant application.
*
* @param array $features
* @param string $account_property
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/identity/v1/#account-settings_post
*/
public function setAccountProperties(array $features, string $account_property = 'BRAINTREE_MERCHANT')
{
$this->apiEndPoint = 'v1/identity/account-settings';
$this->options['json'] = [
'account_property' => $account_property,
'features' => $features,
];
$this->verb = 'post';
return $this->doPayPalRequest();
}
/**
* Create a merchant application.
*
* @param string $account_property
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/api/identity/v1/#account-settings_deactivate
*/
public function disableAccountProperties(string $account_property = 'BRAINTREE_MERCHANT')
{
$this->apiEndPoint = 'v1/identity/account-settings/deactivate';
$this->options['json'] = [
'account_property' => $account_property,
];
$this->verb = 'post';
return $this->doPayPalRequest();
}
/**
* Get a client token.
*
* @throws \Throwable
*
* @return array|\Psr\Http\Message\StreamInterface|string
*
* @see https://developer.paypal.com/docs/multiparty/checkout/advanced/integrate/#link-sampleclienttokenrequest
*/
public function getClientToken()
{
$this->apiEndPoint = 'v1/identity/generate-token';
$this->verb = 'post';
return $this->doPayPalRequest();
}
}
Developer
Get access token to initiates payment transaction.
| Parameter | Type | Comments |
|---|---|---|
| client_id | string | Enter merchant API client/primary key |
| secret_id | string | Enter merchant API secret key |
| env | string | Enter merchant API environment |
| merchant_id | string | Enter merchant API merchant id |
Request Example (guzzle)
<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', $base_url. 'v1/generate-token', [
'headers' => [
'accept' => 'application/json',
'content-type' => 'application/json',
],
'form_params' => [
'client_id' => '$client_id',
'secret_id' => 'secret_id',
'env' => 'env',
'merchant_id' => 'merchant_id',
],
]);
echo $response->getBody();
**Response: SUCCESS (200 OK)**
{
"message": {
"success": [
"Successfully token is generated"
]
},
"data": {
"token":"eyJpdiI6InpkczhjTjhQdVhUL2lKQ0pSUUx6aUE9PSIsInZhbHVlIjoiVGVBTVBDTXltbjNZcEIvdEJveGpTSno3TU5NRUtnVkhCZ1pHTFNCUnZGQ2UxMnYxN202cEE1YVRDTEFsc0ZERExoTjdtL0dTL2xoU3QzeUJJOExiMUx5T0w1L0llUXhTUkU1cWVLWEdEbEplb0dKNXcwbTNRM0VxdkUwYzZuNFdtNkhMQ0pRZysyNWkvdzBxSlBoSVBSOGFTekNnR2RXNHVtcG9lMGZOTmNCcm1hR3c5Sk9KTnB4Y3ltZDl6cm90MThrR21Ca3B1azc3bXRiQ0J6SW96UVo1elNkU1ZqeE05bTcwWGp1MEUxWlJFdnNWTmpSbnVpeW92b2U4dXZkUGgyb1VmK0luaGdyaFlsVTZlcVpVRnZlTG1DeFF6Ykk2T2h6Z3JzbnIyNHpNdHowSE5JdDR0Y0pZT20zUm1XYW8iLCJtYWMiOiJlY2M4NGE1OGUzYzkzYzk0YzljNmVmNjE0YWI0ZDIwOGI3NDQ2YWEyY2ZhNzc0NzE4ZmY1ZmYyMz
IyZmQzNDY1IiwidGFnIjoiIn0=",
},
"type": "success"
}
**Response: ERROR (400 FAILED)**
{
"message": {
"error": [
"Invalid credentials."
]
},
"data": null,
"type": "error"
}