Skip to main content
GET
/
payment-services
C#
using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

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

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!();
}
package main

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

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

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

res, err := s.PaymentServices.List(ctx, operations.ListPaymentServicesRequest{
Cursor: gr4vygo.Pointer("ZXhhbXBsZTE"),
Deleted: gr4vygo.Pointer(true),
})
if err != nil {
log.Fatal(err)
}
if res != nil {
for {
// handle items

res, err = res.Next()

if err != nil {
// handle error
}

if res == nil {
break
}
}
}
}
package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.ListPaymentServicesRequest;
import com.gr4vy.sdk.models.operations.ListPaymentServicesResponse;
import java.lang.Exception;

public class Application {

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

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

ListPaymentServicesRequest req = ListPaymentServicesRequest.builder()
.cursor("ZXhhbXBsZTE")
.deleted(true)
.build();


sdk.paymentServices().list()
.callAsStream()
.forEach((ListPaymentServicesResponse item) -> {
// handle page
});

}
}
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();

$request = new Gr4vy\ListPaymentServicesRequest(
method: 'card',
cursor: 'ZXhhbXBsZTE',
deleted: true,
);

$responses = $sdk->paymentServices->list(
request: $request
);


foreach ($responses as $response) {
if ($response->statusCode === 200) {
// 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.list(cursor="ZXhhbXBsZTE", limit=20, deleted=True)

while res is not None:
# Handle items

res = res.next()
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.list();

for await (const page of result) {
console.log(page);
}
}

run();
curl --request GET \
--url https://api.sandbox.{id}.gr4vy.app/payment-services \
--header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "merchant_account_id": "<string>",
      "payment_service_definition_id": "<string>",
      "display_name": "<string>",
      "position": 123,
      "accepted_currencies": [
        "<string>"
      ],
      "accepted_countries": [
        "<string>"
      ],
      "payment_method_tokenization_enabled": true,
      "network_tokens_enabled": true,
      "open_loop": true,
      "settlement_reporting_enabled": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "type": "payment-service",
      "id": "The ID of the payment service",
      "active": true,
      "status": "The current status of this service.",
      "three_d_secure_enabled": true,
      "merchant_profile": {},
      "webhook_url": "<string>",
      "fields": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "reporting_fields": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "is_deleted": false
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}
{
"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 API is different from the list connections because it only returns payment services and not anti-fraud and gift card services. This endpoint requires the payment-services.read 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"

Query Parameters

method
enum<string> | null

Return any payment service for this method.

Available options:
abitab,
affirm,
afterpay,
alipay,
alipayhk,
applepay,
arcuspaynetwork,
bacs,
bancontact,
bank,
bcp,
becs,
bitpay,
blik,
ach,
boleto,
boost,
breb,
capitec,
card,
cashapp,
cashappafterpay,
chaseorbital,
clearpay,
click-to-pay,
custom_push,
custom_redirect,
custom_tokenize,
dana,
dcb,
dlocal,
ebanx,
eckoh,
efecty,
eps,
everydaypay,
gcash,
gem,
gemds,
gift-card,
giropay,
givingblock,
gocardless,
googlepay,
googlepay_pan_only,
gopay,
grabpay,
ideal,
interac,
kakaopay,
kcp,
khipu,
klarna,
konbini,
latitude,
latitudeds,
laybuy,
linepay,
linkaja,
maybankqrpay,
mercadopago,
multibanco,
multipago,
nequi,
netbanking,
network-token,
nupay,
oney_10x,
oney_12x,
oney_3x,
oney_4x,
oney_6x,
onlinebankingcz,
onelink,
ovo,
oxxo,
p24,
pagoefectivo,
paybybank,
payid,
paymaya,
paysquad,
paypal,
paypalpaylater,
paypay,
payto,
payvalida,
paze,
picpay,
pix,
plaid,
pse,
rabbitlinepay,
razorpay,
rapipago,
redpagos,
scalapay,
sepa,
servipag,
seveneleven,
shopeepay,
singteldash,
smartpay,
sofort,
spei,
stitch,
swish,
stripe,
stripedd,
stripetoken,
tapi,
tapifintechs,
thaiqr,
touchngo,
truemoney,
trustly,
trustlyeurope,
upi,
venmo,
vipps,
waave,
webpay,
wechat,
wero,
yape,
zippay
Example:

"card"

cursor
string | null

A pointer to the page of results to return.

Example:

"ZXhhbXBsZTE"

limit
integer
default:20

The maximum number of items that are at returned.

Required range: 1 <= x <= 100
Example:

20

deleted
boolean | null
default:false

Return any deleted payment service.

Example:

true

Response

Successful Response

items
PaymentService · object[]
required

A list of items returned for this request.

limit
integer
default:20

The number of items for this page.

Required range: 1 <= x <= 100
Example:

20

next_cursor
string | null

The cursor pointing at the next page of items.

Required string length: 1 - 1000
Example:

"ZXhhbXBsZTE"

previous_cursor
string | null

The cursor pointing at the previous page of items.

Required string length: 1 - 1000
Example:

"Xkjss7asS"