PUT
/
payment-services
/
{payment_service_id}
curl --request PUT \
  --url https://api.{gr4vy_id}.gr4vy.app/payment-services/{payment_service_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "display_name": "Stripe (Main)",
  "fields": [
    {
      "key": "private_key",
      "value": "sk_test_26PHem9AhJZvU623DfE1x4sd"
    }
  ],
  "reporting_fields": [
    {
      "key": "ssh_username",
      "value": "test_ssh_user"
    }
  ],
  "accepted_countries": [
    "US",
    "GB",
    "DE"
  ],
  "accepted_currencies": [
    "EUR",
    "USD",
    "GBP"
  ],
  "three_d_secure_enabled": true,
  "merchant_profile": {
    "amex": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>"
    },
    "dankort": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>"
    },
    "discover": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>"
    },
    "jcb": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>"
    },
    "mastercard": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>"
    },
    "unionpay": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>"
    },
    "visa": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>"
    }
  },
  "active": true,
  "open_loop": true,
  "payment_method_tokenization_enabled": true,
  "network_tokens_enabled": true,
  "settlement_reporting_enabled": true
}'
{
  "type": "payment-service",
  "id": "faaad066-30b4-4997-a438-242b0752d7e1",
  "accepted_countries": [
    "DE"
  ],
  "accepted_currencies": [
    "EUR"
  ],
  "active": true,
  "created_at": "2012-12-12T10:53:43+00:00",
  "display_name": "Stripe (Main)",
  "fields": [
    {
      "key": "secret_key",
      "value": "sk_test_26PHem9AhJZvU623DfE1x4sd"
    }
  ],
  "reporting_fields": [
    {
      "key": "ssh_username",
      "value": "test_ssh_username"
    }
  ],
  "merchant_account_id": "default",
  "merchant_profile": {
    "amex": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>",
      "created_at": "2023-07-26T19:23:00.000+00:00"
    },
    "dankort": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>",
      "created_at": "2023-07-26T19:23:00.000+00:00"
    },
    "discover": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>",
      "created_at": "2023-07-26T19:23:00.000+00:00"
    },
    "jcb": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>",
      "created_at": "2023-07-26T19:23:00.000+00:00"
    },
    "mastercard": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>",
      "created_at": "2023-07-26T19:23:00.000+00:00"
    },
    "unionpay": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>",
      "created_at": "2023-07-26T19:23:00.000+00:00"
    },
    "visa": {
      "merchant_acquirer_bin": "<string>",
      "merchant_url": "<string>",
      "merchant_acquirer_id": "<string>",
      "merchant_name": "<string>",
      "merchant_country_code": "<string>",
      "merchant_category_code": "<string>",
      "created_at": "2023-07-26T19:23:00.000+00:00"
    }
  },
  "method": "card",
  "network_tokens_enabled": true,
  "open_loop": true,
  "payment_method_tokenization_enabled": true,
  "payment_service_definition_id": "stripe-card",
  "settlement_reporting_enabled": true,
  "status": "pending",
  "three_d_secure_enabled": true,
  "updated_at": "2012-12-12T10:53:43+00:00",
  "webhook_url": "https://api.example.app.gr4vy.com/i/ViYUjDkUSoiQ0ColeigGwnN0..."
}

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.

Path Parameters

​
payment_service_id
string
required

The ID of the payment service.

Example:

"46973e9d-88a7-44a6-abfe-be4ff0134ff4"

Body

application/json

Request body for updating an active payment service.

Response

201
application/json

Returns the updated payment service.

An active, configured payment service.