SellApp
ApiResourcesPayment methods

Manage custom payment methods

Create, retrieve, update, and delete instruction or redirect payment methods.

GET
/v2/payment-methods/custom

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/custom"
{
  "data": [
    {
      "id": "string",
      "type": "instructions",
      "name": "string",
      "description": "string",
      "instructions": "string",
      "steps": [
        "string"
      ],
      "redirect_url": "http://example.com",
      "skip_interstitial_page": true,
      "show_processing_status_page": true,
      "require_proof_of_payment": true,
      "enabled": true,
      "sort_order": 0,
      "icon_url": "http://example.com",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
POST
/v2/payment-methods/custom

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://sell.app/api/v2/payment-methods/custom" \  -H "Content-Type: application/json" \  -d '{    "type": "instructions",    "name": "string"  }'
{
  "data": {
    "id": "string",
    "type": "instructions",
    "name": "string",
    "description": "string",
    "instructions": "string",
    "steps": [
      "string"
    ],
    "redirect_url": "http://example.com",
    "skip_interstitial_page": true,
    "show_processing_status_page": true,
    "require_proof_of_payment": true,
    "enabled": true,
    "sort_order": 0,
    "icon_url": "http://example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
GET
/v2/payment-methods/custom/{customPaymentMethod}

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

customPaymentMethod*string

Store-scoped custom payment method ULID.

Match^[0-9A-HJKMNP-TV-Z]{26}$

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://sell.app/api/v2/payment-methods/custom/string"
{
  "data": {
    "id": "string",
    "type": "instructions",
    "name": "string",
    "description": "string",
    "instructions": "string",
    "steps": [
      "string"
    ],
    "redirect_url": "http://example.com",
    "skip_interstitial_page": true,
    "show_processing_status_page": true,
    "require_proof_of_payment": true,
    "enabled": true,
    "sort_order": 0,
    "icon_url": "http://example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_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."
    ]
  }
}
PATCH
/v2/payment-methods/custom/{customPaymentMethod}

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

customPaymentMethod*string

Store-scoped custom payment method ULID.

Match^[0-9A-HJKMNP-TV-Z]{26}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://sell.app/api/v2/payment-methods/custom/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "id": "string",
    "type": "instructions",
    "name": "string",
    "description": "string",
    "instructions": "string",
    "steps": [
      "string"
    ],
    "redirect_url": "http://example.com",
    "skip_interstitial_page": true,
    "show_processing_status_page": true,
    "require_proof_of_payment": true,
    "enabled": true,
    "sort_order": 0,
    "icon_url": "http://example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_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."
    ]
  }
}
PUT
/v2/payment-methods/custom/{customPaymentMethod}

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

customPaymentMethod*string

Store-scoped custom payment method ULID.

Match^[0-9A-HJKMNP-TV-Z]{26}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://sell.app/api/v2/payment-methods/custom/string" \  -H "Content-Type: application/json" \  -d '{    "type": "instructions",    "name": "string"  }'
{
  "data": {
    "id": "string",
    "type": "instructions",
    "name": "string",
    "description": "string",
    "instructions": "string",
    "steps": [
      "string"
    ],
    "redirect_url": "http://example.com",
    "skip_interstitial_page": true,
    "show_processing_status_page": true,
    "require_proof_of_payment": true,
    "enabled": true,
    "sort_order": 0,
    "icon_url": "http://example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_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."
    ]
  }
}
DELETE
/v2/payment-methods/custom/{customPaymentMethod}

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

customPaymentMethod*string

Store-scoped custom payment method ULID.

Match^[0-9A-HJKMNP-TV-Z]{26}$

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://sell.app/api/v2/payment-methods/custom/string"
{
  "data": {
    "id": "string",
    "type": "instructions",
    "name": "string",
    "description": "string",
    "instructions": "string",
    "steps": [
      "string"
    ],
    "redirect_url": "http://example.com",
    "skip_interstitial_page": true,
    "show_processing_status_page": true,
    "require_proof_of_payment": true,
    "enabled": true,
    "sort_order": 0,
    "icon_url": "http://example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_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."
    ]
  }
}