Skip to content

Files

Latest commit

 

History

History
168 lines (128 loc) · 12.5 KB

README.md

File metadata and controls

168 lines (128 loc) · 12.5 KB

PaymentServiceTokens

(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

using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    merchantAccountId: "default",
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>"
);

var res = await sdk.PaymentMethods.PaymentServiceTokens.ListAsync(
    paymentMethodId: "ef9496d8-53a5-4aad-8ca2-00eb68334389",
    paymentServiceId: "fffd152a-9532-4087-9a4f-de58754210f0"
);

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

Models.Components.PaymentServiceTokens

Errors

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

Create

Create a gateway tokens for a payment method.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    merchantAccountId: "default",
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>"
);

var res = await sdk.PaymentMethods.PaymentServiceTokens.CreateAsync(
    paymentMethodId: "ef9496d8-53a5-4aad-8ca2-00eb68334389",
    paymentServiceTokenCreate: new PaymentServiceTokenCreate() {
        PaymentServiceId = "fffd152a-9532-4087-9a4f-de58754210f0",
        RedirectUrl = "https://dual-futon.biz",
    }
);

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

PaymentServiceToken

Errors

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

Delete

Delete a gateway tokens for a payment method.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    merchantAccountId: "default",
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>"
);

await sdk.PaymentMethods.PaymentServiceTokens.DeleteAsync(
    paymentMethodId: "ef9496d8-53a5-4aad-8ca2-00eb68334389",
    paymentServiceTokenId: "703f2d99-3fd1-44bc-9cbd-a25a2d597886"
);

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

Errors

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