README

用于连接Onboarding API的软件开发套件

安装

您应该添加PlacetoPay仓库

{
    "repositories": [
        {
            "type": "composer",
            "url": "https://dev.placetopay.com/repository"
        }
    ]
}

然后，您可以通过composer安装该包

composer require placetopay/onboarding-sdk

使用方法

首先，需要创建Gateway类的一个实例，并将凭证（apiKey, url）作为数组传递给参数。示例

return new Gateway([
    'apiKey' => 'MpZTLddJ8aOTIB4V',
    'url' => Urls::SANDBOX,
]);

可用方法

validateIdentity()

为了验证身份，必须从Gateway类实例中调用validateIdentity()方法，并传递OnboardingTransaction类的一个实例作为参数，该实例接收一个包含请求字段的数组。示例

$data = new OnboardingTransaction([
    'person' => [
        'document_type' => 'CC',
        'document' => '1061111110',
        'document_issue_date' => '2007-04-25',
        'name' => 'Pedro Alberto',
        'surname' => 'Pérez Jiménez',
        'email' => 'juan.pabon@evertecinc.com',
        'mobile' => [
            'mobile' => '3152364205',
            'mobile_prefix' => 57,
            'mobile_country' => 'CO',
        ],
    ],
    'approval_url' => 'https://dev.placetopay',
    'denial_url' => 'https://dev.placetopay',
    'locale' => 'es',
]);

$response = $gateway->validateIdentity($data);

query()

为了查询，必须从Gateway类实例中调用query()方法，并传递OnboardingTransaction类的一个实例作为参数，该实例接收一个包含请求ID的数组。示例

$response = $gateway->query(new OnboardingTransaction(['requestID' => 186]));

响应

每个可用方法获得的响应都属于一个'状态'类型的实体，该实体为包含Placetopay 'Base'包的项目所理解。它包括：状态、原因、消息和日期。

{
  +status: "OK"
  +reason: "00"
  +message: "{"data":{"request_id":267,
                    "url":"https:\/\/onboarding-uat.placetopay.ws\/validation\/255?signature=d3da8f17e0fa1e4bed97802e51a4968823df8eecbbd2255c9b93437aac80b713",
                    "initial_status":1}}"
  +date: "2022-11-24T22:41:12+00:00"
}

仅获取状态

$response->status

仅获取原因

$response->reason

仅获取消息

$response->message

仅获取日期

$response->date

要获取消息中的某些特定数据，必须解码消息属性中的JSON，并访问所需的数据属性。

示例

json_decode($response->message)->data->url   //To get the url of an identity to validate

常量

Urls类包含以下常量

public const SANDBOX = 'https://onboarding-uat.placetopay.ws';
public const MOCK_SERVER = 'https://stoplight.io';

建议在给Gateway实例中的"url"字段赋值时使用它们。

重要

请记住，必须将OnboardingTransaction的实例作为参数传递给可用方法，以避免异常或错误。

pabon / onboarding-sdk

维护者

详细信息