PaymentServices

Overview

Available Operations

List - List payment services
Create - Update a configured payment service
Get - Get payment service
Update - Configure a payment service
Delete - Delete a configured payment service
Verify - Verify payment service credentials
Session - Create a session for a payment service definition

List

List the configured payment services.

Example Usage

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

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

ListPaymentServicesRequest req = new ListPaymentServicesRequest() {
    Method = "card",
    Cursor = "ZXhhbXBsZTE",
    Deleted = true,
};

ListPaymentServicesResponse? res = await sdk.PaymentServices.ListAsync(req);

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

    res = await res.Next!();
}

Parameters

Parameter	Type	Required	Description
`request`	ListPaymentServicesRequest	✔️	The request object to use for the request.

Response

ListPaymentServicesResponse

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

Updates the configuration of a payment service.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;
using System.Collections.Generic;

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

var res = await sdk.PaymentServices.CreateAsync(paymentServiceCreate: new PaymentServiceCreate() {
    DisplayName = "Stripe",
    PaymentServiceDefinitionId = "stripe-card",
    Fields = new List<Field>() {
        new Field() {
            Key = "api_key",
            Value = "key-12345",
        },
        new Field() {
            Key = "api_key",
            Value = "key-12345",
        },
    },
    AcceptedCurrencies = new List<string>() {
        "USD",
        "EUR",
        "GBP",
    },
    AcceptedCountries = new List<string>() {
        "US",
        "DE",
        "GB",
    },
    ThreeDSecureEnabled = true,
    SettlementReportingEnabled = true,
});

// handle response

Parameters

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

Response

PaymentService

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	/

Get

Get the details of a configured payment service.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;

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

var res = await sdk.PaymentServices.GetAsync(paymentServiceId: "fffd152a-9532-4087-9a4f-de58754210f0");

// handle response

Parameters

Parameter	Type	Required	Description	Example
`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

PaymentService

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

Configures a new payment service for use by merchants.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;

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

var res = await sdk.PaymentServices.UpdateAsync(
    paymentServiceId: "fffd152a-9532-4087-9a4f-de58754210f0",
    paymentServiceUpdate: new PaymentServiceUpdate() {
        SettlementReportingEnabled = true,
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`PaymentServiceId`	string	✔️	the ID of the payment service	fffd152a-9532-4087-9a4f-de58754210f0
`PaymentServiceUpdate`	PaymentServiceUpdate	✔️	N/A
`MerchantAccountId`	string	➖	The ID of the merchant account to use for this request.	default

Response

PaymentService

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

Deletes all the configuration of a payment service.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;

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

await sdk.PaymentServices.DeleteAsync(paymentServiceId: "fffd152a-9532-4087-9a4f-de58754210f0");

// handle response

Parameters

Parameter	Type	Required	Description	Example
`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

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	/

Verify

Verify the credentials of a configured payment service

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;
using System.Collections.Generic;

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

var res = await sdk.PaymentServices.VerifyAsync(verifyCredentials: new VerifyCredentials() {
    PaymentServiceDefinitionId = "stripe-card",
    Fields = new List<Field>() {},
});

// handle response

Parameters

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

Response

object

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	/

Session

Creates a session for a payment service that supports sessions.

Example Usage

using Gr4vy;
using Gr4vy.Models.Components;
using System.Collections.Generic;

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

var res = await sdk.PaymentServices.SessionAsync(
    paymentServiceId: "fffd152a-9532-4087-9a4f-de58754210f0",
    requestBody: new Dictionary<string, object>() {

    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`PaymentServiceId`	string	✔️	the ID of the payment service	fffd152a-9532-4087-9a4f-de58754210f0
`RequestBody`	Dictionary<String, object>	✔️	N/A
`MerchantAccountId`	string	➖	The ID of the merchant account to use for this request.	default

Response

CreateSession

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	/

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PaymentServices

Overview

Available Operations

List

Example Usage

Parameters

Response

Errors

Create

Example Usage

Parameters

Response

Errors

Get

Example Usage

Parameters

Response

Errors

Update

Example Usage

Parameters

Response

Errors

Delete

Example Usage

Parameters

Errors

Verify

Example Usage

Parameters

Response

Errors

Session

Example Usage

Parameters

Response

Errors

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

PaymentServices

Overview

Available Operations

List

Example Usage

Parameters

Response

Errors

Create

Example Usage

Parameters

Response

Errors

Get

Example Usage

Parameters

Response

Errors

Update

Example Usage

Parameters

Response

Errors

Delete

Example Usage

Parameters

Errors

Verify

Example Usage

Parameters

Response

Errors

Session

Example Usage

Parameters

Response

Errors