SellApp
ApiResourcesPayment methods

Manage payment methods

List and poll safe status, validate write-only configuration, enable or disable methods, and create provider connection handoffs.

GET
/v2/payment-methods

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://sell.app/api/v2/payment-methods"
{
  "data": [
    {
      "id": "STRIPE",
      "name": "Stripe",
      "description": "string",
      "category": "processor",
      "connection_type": "oauth",
      "status": "disconnected",
      "enabled": true,
      "health_status": "disconnected",
      "configuration_supported": true,
      "required_input": [
        {
          "name": "key_secret",
          "type": "string",
          "required": true,
          "secret": true
        }
      ],
      "connect_url": "http://example.com",
      "configuration_url": "http://example.com",
      "status_url": "http://example.com",
      "actionable_error": "string"
    }
  ]
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
GET
/v2/payment-methods/{paymentMethod}

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

paymentMethod*string

Uppercase payment method identifier returned by the collection endpoint.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://sell.app/api/v2/payment-methods/STRIPE"
{
  "data": {
    "id": "STRIPE",
    "name": "Stripe",
    "description": "string",
    "category": "processor",
    "connection_type": "oauth",
    "status": "disconnected",
    "enabled": true,
    "health_status": "disconnected",
    "configuration_supported": true,
    "required_input": [
      {
        "name": "key_secret",
        "type": "string",
        "required": true,
        "secret": true
      }
    ],
    "connect_url": "http://example.com",
    "configuration_url": "http://example.com",
    "status_url": "http://example.com",
    "actionable_error": "string"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
PATCH
/v2/payment-methods/{paymentMethod}

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

paymentMethod*string

Uppercase payment method identifier returned by the collection endpoint.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled*boolean

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://sell.app/api/v2/payment-methods/STRIPE" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'
{
  "data": {
    "id": "STRIPE",
    "name": "Stripe",
    "description": "string",
    "category": "processor",
    "connection_type": "oauth",
    "status": "disconnected",
    "enabled": true,
    "health_status": "disconnected",
    "configuration_supported": true,
    "required_input": [
      {
        "name": "key_secret",
        "type": "string",
        "required": true,
        "secret": true
      }
    ],
    "connect_url": "http://example.com",
    "configuration_url": "http://example.com",
    "status_url": "http://example.com",
    "actionable_error": "string"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
PUT
/v2/payment-methods/{paymentMethod}/configuration

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

paymentMethod*string

Uppercase payment method identifier returned by the collection endpoint.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

api_key*string

Write-only secret. SellApp never returns the stored value.

destination_gateway*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://sell.app/api/v2/payment-methods/STRIPE/configuration" \  -H "Content-Type: application/json" \  -d '{    "merchant_secure_key": "string",    "merchant_tokenization_key": "string",    "signing_key": "string",    "currencies": [      "string"    ]  }'
{
  "data": {
    "id": "STRIPE",
    "name": "Stripe",
    "description": "string",
    "category": "processor",
    "connection_type": "oauth",
    "status": "disconnected",
    "enabled": true,
    "health_status": "disconnected",
    "configuration_supported": true,
    "required_input": [
      {
        "name": "key_secret",
        "type": "string",
        "required": true,
        "secret": true
      }
    ],
    "connect_url": "http://example.com",
    "configuration_url": "http://example.com",
    "status_url": "http://example.com",
    "actionable_error": "string"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
POST
/v2/payment-methods/{paymentMethod}/connect

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

paymentMethod*string

Uppercase payment method identifier returned by the collection endpoint.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://sell.app/api/v2/payment-methods/STRIPE/connect"
{
  "data": {
    "payment_method": "string",
    "connect_url": "http://example.com",
    "status_url": "http://example.com",
    "expires_at": "2019-08-24T14:15:22Z"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}