Skip to main content
POST
/
payment-services
/
verify
C#
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.VerifyAsync(verifyCredentials: new VerifyCredentials() {
    PaymentServiceDefinitionId = "stripe-card",
    Fields = new List<Field>() {},
});

// 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.Verify(ctx, components.VerifyCredentials{
PaymentServiceDefinitionID: "stripe-card",
Fields: []components.Field{},
})
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.VerifyCredentials;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.VerifyPaymentServiceCredentialsResponse;
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();

VerifyPaymentServiceCredentialsResponse res = sdk.paymentServices().verify()
.verifyCredentials(VerifyCredentials.builder()
.paymentServiceDefinitionId("stripe-card")
.fields(List.of())
.build())
.call();

if (res.any().isPresent()) {
System.out.println(res.any().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();

$verifyCredentials = new Gr4vy\VerifyCredentials(
paymentServiceDefinitionId: 'stripe-card',
fields: [],
);

$response = $sdk->paymentServices->verify(
verifyCredentials: $verifyCredentials
);

if ($response->any !== null) {
// handle response
}
from gr4vy import Gr4vy
import os


with Gr4vy(
id="example",
server="sandbox",
merchant_account_id="default",
bearer_auth=auth.with_token(open("./private_key.pem").read())
) as g_client:

res = g_client.payment_services.verify(payment_service_definition_id="stripe-card", fields=[])

# 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.verify({
paymentServiceDefinitionId: "stripe-card",
fields: [],
});

console.log(result);
}

run();
curl --request POST \
--url https://api.sandbox.{id}.gr4vy.app/payment-services/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payment_service_definition_id": "<string>",
"fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
'
{
  "type": "error",
  "code": "bad_request",
  "status": 400,
  "message": "Generic error",
  "details": []
}
{
"type": "error",
"code": "unauthorized",
"status": 401,
"message": "No valid API authentication found",
"details": []
}
{
"type": "error",
"code": "forbidden",
"status": 403,
"message": "Generic error",
"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": "Generic error",
"details": [],
"resource_id": "cdc70639-cb9c-4222-a73f-b8ce39f7821b"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
{
"type": "error",
"code": "too_early",
"status": 425,
"message": "Generic error",
"details": []
}
{
"type": "error",
"code": "too_many_requests",
"status": 429,
"message": "Generic error",
"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
payment_service_definition_id
string
required

The ID of the payment service definition to verify the fields against

Example:

"stripe-card"

fields
Field · object[]
required

The fields and their values, or a set of updated fields to merge with existing values.

payment_service_id
string<uuid> | null

The optional ID of the configured payment service. New fields will be merged with any existing fields already stored before they are verified.

Example:

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

Response

Successful Response