Skip to content

README.md

Latest commit

 

History

History
224 lines (170 loc) · 16.9 KB

README.md

File metadata and controls

224 lines (170 loc) · 16.9 KB

ThreeDsScenarios

Overview

Available Operations

  • Create - Create a 3DS scenario
  • List - List 3DS scenario
  • Update - Update a 3DS scenario
  • Delete - Delete a 3DS scenario

Create

Create a new 3DS scenario for a merchant account. Only available in sandbox environments.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;

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

var res = await sdk.ThreeDsScenarios.CreateAsync(threeDSecureScenarioCreate: new ThreeDSecureScenarioCreate() {
    Conditions = new ThreeDSecureScenarioConditions() {},
    Outcome = new ThreeDSecureScenarioOutcome() {
        Authentication = new ThreeDSecureScenarioOutcomeAuthentication() {
            TransactionStatus = "Y",
        },
    },
});

// handle response

Parameters

Parameter Type Required Description Example
ThreeDSecureScenarioCreate ThreeDSecureScenarioCreate ✔️ N/A
MerchantAccountId string ➖ The ID of the merchant account to use for this request. default

Response

ThreeDSecureScenario

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

List

List all 3DS scenarios for a merchant account. Only available in sandbox environments.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

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

GetThreeDsScenarioResponse? res = await sdk.ThreeDsScenarios.ListAsync(limit: 20);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter Type Required Description Example
Cursor string ➖ A pointer to the page of results to return. ZXhhbXBsZTE
Limit long ➖ The maximum number of items that are at returned. 20
MerchantAccountId string ➖ The ID of the merchant account to use for this request. default

Response

GetThreeDsScenarioResponse

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

Update

Update a 3DS scenario. Only available in sandbox environments.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;

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

var res = await sdk.ThreeDsScenarios.UpdateAsync(
    threeDsScenarioId: "7099948d-7286-47e4-aad8-b68f7eb44591",
    threeDSecureScenarioUpdate: new ThreeDSecureScenarioUpdate() {}
);

// handle response

Parameters

Parameter Type Required Description Example
ThreeDsScenarioId string ✔️ The ID of the 3DS scenario 7099948d-7286-47e4-aad8-b68f7eb44591
ThreeDSecureScenarioUpdate ThreeDSecureScenarioUpdate ✔️ N/A
MerchantAccountId string ➖ The ID of the merchant account to use for this request. default

Response

ThreeDSecureScenario

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

Removes a 3DS scenario from our system. Only available in sandbox environments.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;

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

await sdk.ThreeDsScenarios.DeleteAsync(threeDsScenarioId: "7099948d-7286-47e4-aad8-b68f7eb44591");

// handle response

Parameters

Parameter Type Required Description Example
ThreeDsScenarioId string ✔️ The ID of the 3DS scenario 7099948d-7286-47e4-aad8-b68f7eb44591
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 */*