Skip to content

README.md

Latest commit

 

History

History
204 lines (148 loc) · 11.4 KB

README.md

File metadata and controls

204 lines (148 loc) · 11.4 KB

PaymentMethods.PaymentServiceTokens

Overview

Available Operations

  • list - List payment service tokens
  • create - Create payment service token
  • delete - Delete payment service token

list

List all gateway tokens stored for a payment method.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

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



$response = $sdk->paymentMethods->paymentServiceTokens->list(
    paymentMethodId: 'ef9496d8-53a5-4aad-8ca2-00eb68334389',
    paymentServiceId: 'fffd152a-9532-4087-9a4f-de58754210f0'

);

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

Parameters

Parameter Type Required Description Example
paymentMethodId string ✔️ The ID of the payment method ef9496d8-53a5-4aad-8ca2-00eb68334389
paymentServiceId ?string ➖ The ID of the payment service fffd152a-9532-4087-9a4f-de58754210f0
merchantAccountId ?string ➖ The ID of the merchant account to use for this request. default

Response

?ListPaymentMethodPaymentServiceTokensResponse

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 gateway tokens for a payment method.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

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

$paymentServiceTokenCreate = new Gr4vy\PaymentServiceTokenCreate(
    paymentServiceId: 'fffd152a-9532-4087-9a4f-de58754210f0',
    redirectUrl: 'https://example.com/callback',
);

$response = $sdk->paymentMethods->paymentServiceTokens->create(
    paymentMethodId: 'ef9496d8-53a5-4aad-8ca2-00eb68334389',
    paymentServiceTokenCreate: $paymentServiceTokenCreate

);

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

Parameters

Parameter Type Required Description Example
paymentMethodId string ✔️ The ID of the payment method ef9496d8-53a5-4aad-8ca2-00eb68334389
paymentServiceTokenCreate PaymentServiceTokenCreate ✔️ N/A
merchantAccountId ?string ➖ The ID of the merchant account to use for this request. default

Response

?CreatePaymentMethodPaymentServiceTokenResponse

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 */*

delete

Delete a gateway tokens for a payment method.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

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



$response = $sdk->paymentMethods->paymentServiceTokens->delete(
    paymentMethodId: 'ef9496d8-53a5-4aad-8ca2-00eb68334389',
    paymentServiceTokenId: '703f2d99-3fd1-44bc-9cbd-a25a2d597886'

);

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

Parameters

Parameter Type Required Description Example
paymentMethodId string ✔️ The ID of the payment method ef9496d8-53a5-4aad-8ca2-00eb68334389
paymentServiceTokenId string ✔️ The ID of the payment service token 703f2d99-3fd1-44bc-9cbd-a25a2d597886
merchantAccountId ?string ➖ The ID of the merchant account to use for this request. default

Response

?DeletePaymentMethodPaymentServiceTokenResponse

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 */*