Configure a payment service

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

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

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",
        },
    },
    AcceptedCurrencies = new List<string>() {
        "USD",
        "EUR",
        "GBP",
    },
    AcceptedCountries = new List<string>() {
        "US",
        "DE",
        "GB",
    },
    ThreeDSecureEnabled = true,
    SettlementReportingEnabled = true,
    RefundIngestionEnabled = true,
});

// handle response

package main

import(
	"context"
	"os"
	gr4vygo "github.com/gr4vy/gr4vy-go"
	"github.com/gr4vy/gr4vy-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := gr4vygo.New(
        gr4vygo.WithMerchantAccountID("default"),
        gr4vygo.WithSecurity(os.Getenv("GR4VY_BEARER_AUTH")),
    )

    res, err := s.PaymentServices.Create(ctx, components.PaymentServiceCreate{
        DisplayName: "Stripe",
        PaymentServiceDefinitionID: "stripe-card",
        Fields: []components.Field{
            components.Field{
                Key: "api_key",
                Value: "key-12345",
            },
        },
        AcceptedCurrencies: []string{
            "USD",
            "EUR",
            "GBP",
        },
        AcceptedCountries: []string{
            "US",
            "DE",
            "GB",
        },
        ThreeDSecureEnabled: gr4vygo.Pointer(true),
        SettlementReportingEnabled: gr4vygo.Pointer(true),
        RefundIngestionEnabled: gr4vygo.Pointer(true),
    }, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.components.Field;
import com.gr4vy.sdk.models.components.PaymentServiceCreate;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.CreatePaymentServiceResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .merchantAccountId("default")
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        CreatePaymentServiceResponse res = sdk.paymentServices().create()
                .paymentServiceCreate(PaymentServiceCreate.builder()
                    .displayName("Stripe")
                    .paymentServiceDefinitionId("stripe-card")
                    .fields(List.of(
                        Field.builder()
                            .key("api_key")
                            .value("key-12345")
                            .build()))
                    .acceptedCurrencies(List.of(
                        "USD",
                        "EUR",
                        "GBP"))
                    .acceptedCountries(List.of(
                        "US",
                        "DE",
                        "GB"))
                    .threeDSecureEnabled(true)
                    .settlementReportingEnabled(true)
                    .refundIngestionEnabled(true)
                    .build())
                .call();

        if (res.paymentService().isPresent()) {
            System.out.println(res.paymentService().get());
        }
    }
}

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

$sdk = Gr4vy\SDK::builder()
    ->setId('example')
    ->setServer('sandbox')
    ->setSecuritySource(Auth::withToken($privateKey))
    ->setMerchantAccountId('default')
    ->build();

$paymentServiceCreate = new Gr4vy\PaymentServiceCreate(
    displayName: 'Stripe',
    paymentServiceDefinitionId: 'stripe-card',
    fields: [
        new Gr4vy\Field(
            key: 'api_key',
            value: 'key-12345',
        ),
    ],
    acceptedCurrencies: [
        'USD',
        'EUR',
        'GBP',
    ],
    acceptedCountries: [
        'US',
        'DE',
        'GB',
    ],
    threeDSecureEnabled: true,
    settlementReportingEnabled: true,
    refundIngestionEnabled: true,
);

$response = $sdk->paymentServices->create(
    paymentServiceCreate: $paymentServiceCreate
);

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

from gr4vy import Gr4vy
import os


with Gr4vy(
    merchant_account_id="default",
    bearer_auth=os.getenv("GR4VY_BEARER_AUTH"),
) as g_client:

    res = g_client.payment_services.create(display_name="Stripe", payment_service_definition_id="stripe-card", fields=[
        {
            "key": "api_key",
            "value": "key-12345",
        },
    ], accepted_currencies=[
        "USD",
        "EUR",
        "GBP",
    ], accepted_countries=[
        "US",
        "DE",
        "GB",
    ], three_d_secure_enabled=True, settlement_reporting_enabled=True, refund_ingestion_enabled=True)

    # Handle response
    print(res)

import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";

const gr4vy = new Gr4vy({
    id: "example",
    server: "sandbox",
    merchantAccountId: "default",
    bearerAuth: withToken({
      privateKey: fs.readFileSync("private_key.pem", "utf8"),
    }),
});

async function run() {
  const result = await gr4vy.paymentServices.create({
    displayName: "Stripe",
    paymentServiceDefinitionId: "stripe-card",
    fields: [
      {
        key: "api_key",
        value: "key-12345",
      },
    ],
    acceptedCurrencies: [
      "USD",
      "EUR",
      "GBP",
    ],
    acceptedCountries: [
      "US",
      "DE",
      "GB",
    ],
    threeDSecureEnabled: true,
    settlementReportingEnabled: true,
    refundIngestionEnabled: true,
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.sandbox.{id}.gr4vy.app/payment-services \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "Stripe",
  "payment_service_definition_id": "stripe-card",
  "fields": [
    {
      "key": "api_key",
      "value": "key-12345"
    }
  ],
  "accepted_currencies": [
    "USD",
    "EUR",
    "GBP"
  ],
  "accepted_countries": [
    "US",
    "DE",
    "GB"
  ]
}
'

{
  "merchant_account_id": "default",
  "payment_service_definition_id": "stripe-card",
  "method": "card",
  "display_name": "Stripe",
  "position": 1,
  "accepted_currencies": [
    "USD",
    "EUR",
    "GBP"
  ],
  "accepted_countries": [
    "US",
    "DE",
    "GB"
  ],
  "payment_method_tokenization_enabled": true,
  "network_tokens_enabled": true,
  "open_loop": true,
  "settlement_reporting_enabled": true,
  "refund_ingestion_enabled": true,
  "created_at": "2013-07-16T19:23:00.000+00:00",
  "updated_at": "2013-07-16T19:23:00.000+00:00",
  "type": "payment-service",
  "id": "fffd152a-9532-4087-9a4f-de58754210f0",
  "active": true,
  "status": "created",
  "three_d_secure_enabled": true,
  "merchant_profile": {},
  "webhook_url": "<string>",
  "fields": [
    {
      "key": "api_key",
      "value": "key-12345"
    }
  ],
  "reporting_fields": [
    {
      "key": "api_key",
      "value": "key-12345"
    }
  ],
  "is_deleted": false
}

{
  "type": "error",
  "code": "bad_request",
  "status": 400,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "unauthorized",
  "status": 401,
  "message": "No valid API authentication found",
  "details": []
}

{
  "type": "error",
  "code": "forbidden",
  "status": 403,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "not_found",
  "status": 404,
  "message": "The resource could not be found",
  "details": []
}

{
  "type": "error",
  "code": "method_not_allowed",
  "status": 405,
  "message": "Method Not Allowed",
  "details": []
}

{
  "type": "error",
  "code": "duplicate_record",
  "status": 409,
  "message": "Request failed validation",
  "details": [],
  "resource_id": "cdc70639-cb9c-4222-a73f-b8ce39f7821b"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "type": "error",
  "code": "too_early",
  "status": 425,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "too_many_requests",
  "status": 429,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "server_error",
  "status": 500,
  "message": "Request could not be processed",
  "details": []
}

{
  "type": "error",
  "code": "bad_gateway",
  "status": 502,
  "message": "Request could not be processed",
  "details": []
}

{
  "type": "error",
  "code": "gateway_timeout",
  "status": 504,
  "message": "Request could not be processed",
  "details": []
}

POST

payment-services

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

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

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",
        },
    },
    AcceptedCurrencies = new List<string>() {
        "USD",
        "EUR",
        "GBP",
    },
    AcceptedCountries = new List<string>() {
        "US",
        "DE",
        "GB",
    },
    ThreeDSecureEnabled = true,
    SettlementReportingEnabled = true,
    RefundIngestionEnabled = true,
});

// handle response

package main

import(
	"context"
	"os"
	gr4vygo "github.com/gr4vy/gr4vy-go"
	"github.com/gr4vy/gr4vy-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := gr4vygo.New(
        gr4vygo.WithMerchantAccountID("default"),
        gr4vygo.WithSecurity(os.Getenv("GR4VY_BEARER_AUTH")),
    )

    res, err := s.PaymentServices.Create(ctx, components.PaymentServiceCreate{
        DisplayName: "Stripe",
        PaymentServiceDefinitionID: "stripe-card",
        Fields: []components.Field{
            components.Field{
                Key: "api_key",
                Value: "key-12345",
            },
        },
        AcceptedCurrencies: []string{
            "USD",
            "EUR",
            "GBP",
        },
        AcceptedCountries: []string{
            "US",
            "DE",
            "GB",
        },
        ThreeDSecureEnabled: gr4vygo.Pointer(true),
        SettlementReportingEnabled: gr4vygo.Pointer(true),
        RefundIngestionEnabled: gr4vygo.Pointer(true),
    }, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.components.Field;
import com.gr4vy.sdk.models.components.PaymentServiceCreate;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.CreatePaymentServiceResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .merchantAccountId("default")
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        CreatePaymentServiceResponse res = sdk.paymentServices().create()
                .paymentServiceCreate(PaymentServiceCreate.builder()
                    .displayName("Stripe")
                    .paymentServiceDefinitionId("stripe-card")
                    .fields(List.of(
                        Field.builder()
                            .key("api_key")
                            .value("key-12345")
                            .build()))
                    .acceptedCurrencies(List.of(
                        "USD",
                        "EUR",
                        "GBP"))
                    .acceptedCountries(List.of(
                        "US",
                        "DE",
                        "GB"))
                    .threeDSecureEnabled(true)
                    .settlementReportingEnabled(true)
                    .refundIngestionEnabled(true)
                    .build())
                .call();

        if (res.paymentService().isPresent()) {
            System.out.println(res.paymentService().get());
        }
    }
}

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

$sdk = Gr4vy\SDK::builder()
    ->setId('example')
    ->setServer('sandbox')
    ->setSecuritySource(Auth::withToken($privateKey))
    ->setMerchantAccountId('default')
    ->build();

$paymentServiceCreate = new Gr4vy\PaymentServiceCreate(
    displayName: 'Stripe',
    paymentServiceDefinitionId: 'stripe-card',
    fields: [
        new Gr4vy\Field(
            key: 'api_key',
            value: 'key-12345',
        ),
    ],
    acceptedCurrencies: [
        'USD',
        'EUR',
        'GBP',
    ],
    acceptedCountries: [
        'US',
        'DE',
        'GB',
    ],
    threeDSecureEnabled: true,
    settlementReportingEnabled: true,
    refundIngestionEnabled: true,
);

$response = $sdk->paymentServices->create(
    paymentServiceCreate: $paymentServiceCreate
);

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

from gr4vy import Gr4vy
import os


with Gr4vy(
    merchant_account_id="default",
    bearer_auth=os.getenv("GR4VY_BEARER_AUTH"),
) as g_client:

    res = g_client.payment_services.create(display_name="Stripe", payment_service_definition_id="stripe-card", fields=[
        {
            "key": "api_key",
            "value": "key-12345",
        },
    ], accepted_currencies=[
        "USD",
        "EUR",
        "GBP",
    ], accepted_countries=[
        "US",
        "DE",
        "GB",
    ], three_d_secure_enabled=True, settlement_reporting_enabled=True, refund_ingestion_enabled=True)

    # Handle response
    print(res)

import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";

const gr4vy = new Gr4vy({
    id: "example",
    server: "sandbox",
    merchantAccountId: "default",
    bearerAuth: withToken({
      privateKey: fs.readFileSync("private_key.pem", "utf8"),
    }),
});

async function run() {
  const result = await gr4vy.paymentServices.create({
    displayName: "Stripe",
    paymentServiceDefinitionId: "stripe-card",
    fields: [
      {
        key: "api_key",
        value: "key-12345",
      },
    ],
    acceptedCurrencies: [
      "USD",
      "EUR",
      "GBP",
    ],
    acceptedCountries: [
      "US",
      "DE",
      "GB",
    ],
    threeDSecureEnabled: true,
    settlementReportingEnabled: true,
    refundIngestionEnabled: true,
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.sandbox.{id}.gr4vy.app/payment-services \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "Stripe",
  "payment_service_definition_id": "stripe-card",
  "fields": [
    {
      "key": "api_key",
      "value": "key-12345"
    }
  ],
  "accepted_currencies": [
    "USD",
    "EUR",
    "GBP"
  ],
  "accepted_countries": [
    "US",
    "DE",
    "GB"
  ]
}
'

{
  "merchant_account_id": "default",
  "payment_service_definition_id": "stripe-card",
  "method": "card",
  "display_name": "Stripe",
  "position": 1,
  "accepted_currencies": [
    "USD",
    "EUR",
    "GBP"
  ],
  "accepted_countries": [
    "US",
    "DE",
    "GB"
  ],
  "payment_method_tokenization_enabled": true,
  "network_tokens_enabled": true,
  "open_loop": true,
  "settlement_reporting_enabled": true,
  "refund_ingestion_enabled": true,
  "created_at": "2013-07-16T19:23:00.000+00:00",
  "updated_at": "2013-07-16T19:23:00.000+00:00",
  "type": "payment-service",
  "id": "fffd152a-9532-4087-9a4f-de58754210f0",
  "active": true,
  "status": "created",
  "three_d_secure_enabled": true,
  "merchant_profile": {},
  "webhook_url": "<string>",
  "fields": [
    {
      "key": "api_key",
      "value": "key-12345"
    }
  ],
  "reporting_fields": [
    {
      "key": "api_key",
      "value": "key-12345"
    }
  ],
  "is_deleted": false
}

{
  "type": "error",
  "code": "bad_request",
  "status": 400,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "unauthorized",
  "status": 401,
  "message": "No valid API authentication found",
  "details": []
}

{
  "type": "error",
  "code": "forbidden",
  "status": 403,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "not_found",
  "status": 404,
  "message": "The resource could not be found",
  "details": []
}

{
  "type": "error",
  "code": "method_not_allowed",
  "status": 405,
  "message": "Method Not Allowed",
  "details": []
}

{
  "type": "error",
  "code": "duplicate_record",
  "status": 409,
  "message": "Request failed validation",
  "details": [],
  "resource_id": "cdc70639-cb9c-4222-a73f-b8ce39f7821b"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "type": "error",
  "code": "too_early",
  "status": 425,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "too_many_requests",
  "status": 429,
  "message": "Request failed validation",
  "details": []
}

{
  "type": "error",
  "code": "server_error",
  "status": 500,
  "message": "Request could not be processed",
  "details": []
}

{
  "type": "error",
  "code": "bad_gateway",
  "status": 502,
  "message": "Request could not be processed",
  "details": []
}

{
  "type": "error",
  "code": "gateway_timeout",
  "status": 504,
  "message": "Request could not be processed",
  "details": []
}

This endpoint requires the payment-services.write scope.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-gr4vy-merchant-account-id

string

The ID of the merchant account to use for this request.

Example:

"default"

Body

application/json

Request body for activating a payment service

display_name

string

required

The display name for the payment service.

Required string length: 1 - 200

Example:

"Stripe"

payment_service_definition_id

string

required

The definition ID of the service to configure.

Required string length: 1 - 50

Example:

"stripe-card"

fields

Field · object[]

required

The non-secret credential fields that have been configured for this payment service. Any secret fields are omitted.

Show child attributes

accepted_currencies

string[]

required

A list of currencies for which this service is enabled, in ISO 4217 three-letter code format.

Minimum array length: 1

Pattern: ^[A-Z]{3}$

Example:

["USD", "EUR", "GBP"]

accepted_countries

string[]

required

A list of countries for which this service is enabled, in ISO two-letter code format.

Minimum array length: 1

Pattern: ^[A-Z]{2}$

Example:

["US", "DE", "GB"]

reporting_fields

Field · object[] | null

The non-secret reporting fields that have been configured for this payment service. Any secret fields are omitted.

Show child attributes

position

integer | null

Deprecated field used to define the order in which to process payment services

Example:

1

active

boolean | null

default:true

Defines if this payment service is currently active.

Example:

true

three_d_secure_enabled

boolean

default:false

Defines if this payment service has 3DS enabled.

Example:

true

merchant_profile

Merchant Profile · object | null

An object containing a key for each supported card schemes, and for each key an object with the 3DS profile for this service for that scheme.

Show child attributes

payment_method_tokenization_enabled

boolean | null

Defines if this payment service support payment method tokenization.

Example:

true

network_tokens_enabled

boolean | null

Defines if this payment service supports network tokens.

Example:

true

open_loop

boolean | null

Defines if this payment service is open loop.

Example:

true

settlement_reporting_enabled

boolean

default:false

Defines if this payment service has settlement reporting enabled.

Example:

true

refund_ingestion_enabled

boolean

default:false

Defines if this payment service has refund ingestion enabled.

Example:

true

Response

Successful Response

merchant_account_id

string

required

The ID of the merchant account this job belongs to.

Example:

"default"

payment_service_definition_id

string

required

The definition ID of the service that has been configured.

Required string length: 1 - 50

Example:

"stripe-card"

method

string

required

The payment method that this service supports.

Example:

"card"

display_name

string

required

The display name for the payment service.

Required string length: 1 - 200

Example:

"Stripe"

position

integer

required

Deprecated field used to define the order in which to process payment services

Example:

1

accepted_currencies

string[]

required

A list of currencies for which this service is enabled, in ISO 4217 three-letter code format.

Pattern: ^[A-Z]{3}$

Example:

["USD", "EUR", "GBP"]

accepted_countries

string[]

required

A list of countries for which this service is enabled, in ISO two-letter code format.

Pattern: ^[A-Z]{2}$

Example:

["US", "DE", "GB"]

payment_method_tokenization_enabled

boolean

required

Defines if this payment service support payment method tokenization.

Example:

true

network_tokens_enabled

boolean

required

Defines if this payment service supports network tokens.

Example:

true

open_loop

boolean

required

Defines if this payment service is open loop.

Example:

true

settlement_reporting_enabled

boolean

required

Defines if this payment service has settlement reporting enabled.

Example:

true

refund_ingestion_enabled

boolean

required

Defines if this payment service has refund ingestion enabled.

Example:

true

created_at

string<date-time>

required

The date and time when this payment service was first created in our system.

Example:

"2013-07-16T19:23:00.000+00:00"

updated_at

string<date-time>

required

The date and time when this payment service was last updated in our system.

Example:

"2013-07-16T19:23:00.000+00:00"

type

string

default:payment-service

Always payment-service

Allowed value: "payment-service"

Example:

"payment-service"

string<uuid>

default:The ID of the payment service

Example:

"fffd152a-9532-4087-9a4f-de58754210f0"

active

boolean

default:true

Defines if this payment service is currently active.

Examples:

true

false

status

string

default:The current status of this service.

Example:

"created"

three_d_secure_enabled

boolean | null

Defines if this payment service has 3DS enabled.

Example:

true

merchant_profile

Merchant Profile · object | null

An object containing a key for each supported card schemes, and for each key an object with the 3DS profile for this service for that scheme.

Show child attributes

webhook_url

string | null

The URL that needs to be configured with this payment service as the receiving endpoint for webhooks from the service to our system. Currently, we dp not yet automatically register webhooks on setup, and therefore webhooks need to be registered manually by the merchant.

fields

Field · object[] | null

The non-secret credential fields that have been configured for this payment service. Any secret fields are omitted.

Show child attributes

reporting_fields

Field · object[] | null

The non-secret reporting fields that have been configured for this payment service. Any secret fields are omitted.

Show child attributes

is_deleted

boolean

default:false

Defines if this payment service has been deleted

Example:

false

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Payouts

Refunds

Sessions

Settlement records

Disputes

Instruments

Vault

PSPs & Gateways

Errors

Other

Configure a payment service

Authorizations

Headers

Body

Response