Skip to content

README.md

Latest commit

 

History

History
265 lines (193 loc) · 12.1 KB

README.md

File metadata and controls

265 lines (193 loc) · 12.1 KB

MerchantAccounts

Overview

Available Operations

  • list - List all merchant accounts
  • create - Create a merchant account
  • get - Get a merchant account
  • update - Update a merchant account

list

List all merchant accounts in an instance.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

$sdk = Gr4vy\SDK::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$responses = $sdk->merchantAccounts->list(
    cursor: 'ZXhhbXBsZTE',
    limit: 20,
    search: 'merchant-12345'

);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
cursor ?string ➖ A pointer to the page of results to return. ZXhhbXBsZTE
limit ?int ➖ The maximum number of items that are at returned. 20
search ?string ➖ The search term to filter merchant accounts by. merchant-12345

Response

?ListMerchantAccountsResponse

Errors

Error Type Status Code Content Type
Errors\Error400 400 application/json
Errors\Error401 401 application/json
Errors\Error403 403 application/json
Errors\Error404 404 application/json
Errors\Error405 405 application/json
Errors\Error409 409 application/json
Errors\HTTPValidationError 422 application/json
Errors\Error425 425 application/json
Errors\Error429 429 application/json
Errors\Error500 500 application/json
Errors\Error502 502 application/json
Errors\Error504 504 application/json
errors\APIException 4XX, 5XX */*

create

Create a new merchant account in an instance.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

$sdk = Gr4vy\SDK::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Gr4vy\MerchantAccountCreate(
    accountUpdaterEnabled: true,
    asyncNetworkTokensEnabled: true,
    id: 'merchant-12345',
    displayName: 'Example',
);

$response = $sdk->merchantAccounts->create(
    request: $request
);

if ($response->merchantAccount !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Gr4vy\MerchantAccountCreate ✔️ The request object to use for the request.

Response

?CreateMerchantAccountResponse

Errors

Error Type Status Code Content Type
Errors\Error400 400 application/json
Errors\Error401 401 application/json
Errors\Error403 403 application/json
Errors\Error404 404 application/json
Errors\Error405 405 application/json
Errors\Error409 409 application/json
Errors\HTTPValidationError 422 application/json
Errors\Error425 425 application/json
Errors\Error429 429 application/json
Errors\Error500 500 application/json
Errors\Error502 502 application/json
Errors\Error504 504 application/json
errors\APIException 4XX, 5XX */*

get

Get info about a merchant account in an instance.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

$sdk = Gr4vy\SDK::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->merchantAccounts->get(
    merchantAccountId: 'merchant-12345'
);

if ($response->merchantAccount !== null) {
    // handle response
}

Parameters

Parameter Type Required Description Example
merchantAccountId string ✔️ The ID of the merchant account. merchant-12345

Response

?GetMerchantAccountResponse

Errors

Error Type Status Code Content Type
Errors\Error400 400 application/json
Errors\Error401 401 application/json
Errors\Error403 403 application/json
Errors\Error404 404 application/json
Errors\Error405 405 application/json
Errors\Error409 409 application/json
Errors\HTTPValidationError 422 application/json
Errors\Error425 425 application/json
Errors\Error429 429 application/json
Errors\Error500 500 application/json
Errors\Error502 502 application/json
Errors\Error504 504 application/json
errors\APIException 4XX, 5XX */*

update

Update info for a merchant account in an instance.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

$sdk = Gr4vy\SDK::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$merchantAccountUpdate = new Gr4vy\MerchantAccountUpdate(
    accountUpdaterEnabled: true,
    asyncNetworkTokensEnabled: true,
);

$response = $sdk->merchantAccounts->update(
    merchantAccountId: 'merchant-12345',
    merchantAccountUpdate: $merchantAccountUpdate

);

if ($response->merchantAccount !== null) {
    // handle response
}

Parameters

Parameter Type Required Description Example
merchantAccountId string ✔️ The ID of the merchant account. merchant-12345
merchantAccountUpdate MerchantAccountUpdate ✔️ N/A

Response

?UpdateMerchantAccountResponse

Errors

Error Type Status Code Content Type
Errors\Error400 400 application/json
Errors\Error401 401 application/json
Errors\Error403 403 application/json
Errors\Error404 404 application/json
Errors\Error405 405 application/json
Errors\Error409 409 application/json
Errors\HTTPValidationError 422 application/json
Errors\Error425 425 application/json
Errors\Error429 429 application/json
Errors\Error500 500 application/json
Errors\Error502 502 application/json
Errors\Error504 504 application/json
errors\APIException 4XX, 5XX */*