Download the PHP package gr4vy/gr4vy-php without Composer

Gr4vy PHP SDK (Beta)

Developer-friendly & type-safe PHP SDK specifically catered to leverage the Gr4vy API.

[!IMPORTANT] This is a Beta release of our latest SDK. Please refer to the legacy PHP SDK for the latest stable build.

Summary

Gr4vy Typescript SDK

The official Gr4vy SDK for Typescript provides a convenient way to interact with the Gr4vy API from your server-side application. This SDK allows you to seamlessly integrate Gr4vy's powerful payment orchestration capabilities, including:

• Creating Transactions: Initiate and process payments with various payment methods and services.
• Managing Buyers: Store and manage buyer information securely.
• Storing Payment Methods: Securely store and tokenize payment methods for future use.
• Handling Webhooks: Easily process and respond to webhook events from Gr4vy.
• And much more: Access the full suite of Gr4vy API payment features.

This SDK is designed to simplify development, reduce boilerplate code, and help you get up and running with Gr4vy quickly and efficiently. It handles authentication, request signing, and provides easy-to-use methods for most API endpoints.

Table of Contents

• Gr4vy PHP SDK (Beta)
  • SDK Installation
  • SDK Example Usage
  • Bearer token generation
  • Embed token generation
  • Merchant account ID selection
  • Webhooks verification
  • Authentication
  • Available Resources and Operations
  • Global Parameters
  • Pagination
  • Retries
  • Error Handling
  • Server Selection
• Development
  • Testing
  • Maturity
  • Contributions

SDK Installation

The SDK relies on Composer to manage its dependencies.

To install the SDK and add it as a dependency to an existing composer.json file:

SDK Example Usage

Example

[!IMPORTANT] Please use ->setSecuritySource(Auth::withToken($privateKey)) where the documentation mentions ->setSecurity('<YOUR_BEARER_TOKEN_HERE>').

Bearer token generation

Alternatively, you can create a token for use with the SDK or with your own client library.

Note: This will only create a token once. Use Auth::withToken with our SDK to dynamically generate a token for every request.

Embed token generation

Alternatively, you can create a token for use with Embed as follows.

Note: This will only create a token once. Use Auth::withToken with our SDK to dynamically generate a token for every request.

Merchant account ID selection

Depending on the key used, you might need to explicitly define a merchant account ID to use. In our API, this uses the X-GR4VY-MERCHANT-ACCOUNT-ID header. When using the SDK, you can set the merchantAccountId when initializing the SDK.

Webhooks verification

The SDK makes it easy to verify that incoming webhooks were actually sent by Gr4vy. Once you have configured the webhook subscription with its corresponding secret, that can be verified the following way:

Parameters

• payload: The raw payload string received in the webhook request.
• secret: The secret used to sign the webhook. This is provided in your Gr4vy dashboard.
• signatureHeader: The X-Gr4vy-Signature header from the webhook request.
• timestampHeader: The X-Gr4vy-Timestamp header from the webhook request.
• timestampTolerance: (Optional) The maximum allowed difference (in seconds) between the current time and the timestamp in the webhook. Defaults to 0 (no tolerance).

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

To authenticate with the API the bearerAuth parameter must be set when initializing the SDK. For example:

Available Resources and Operations

Global Parameters

A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set merchant_account_id to ` at SDK initialization and then you do not have to pass the same value on calls to operations likeget`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameter is available.

Example

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned object will be a Generator instead of an individual response.

Working with generators is as simple as iterating over the responses in a foreach loop, and you can see an example below:

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide an Options object built with a RetryConfig object to the call:

If you'd like to override the default retry strategy for all operations that support retries, you can pass a RetryConfig object to the SDKBuilder->setRetryConfig function when initializing the SDK:

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.

By default an API error will raise a errors\APIException exception, which has the following properties:

When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the create method throws the following exceptions:

Example

Server Selection

Select Server by Name

You can override the default server globally using the setServer(string $serverName) builder method when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

If the selected server has variables, you may override its default values using the associated builder method(s):

Example

Override Server URL Per-Client

The default server can also be overridden globally using the setServerUrl(string $serverUrl) builder method when initializing the SDK client instance. For example:

Development

Testing

To run the tests, install PHP and compose, ensure to download the private_key.pem for the test environment, and run the following.

Additionally, the following tools can be used to lint the code.

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy