Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.routing.addProcessor({
provider: "tagada",
});
<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->routing->addProcessor([
'provider' => 'tagada',
]);
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.routing.addProcessor(provider="tagada")
curl --request POST \
--url https://api.shoply.gg/v1/stores/{storeId}/payment-routing/processors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"provider": "tagada"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/payment-routing/processors"
payload := strings.NewReader("{\n \"provider\": \"tagada\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.shoply.gg/v1/stores/{storeId}/payment-routing/processors")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"tagada\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/payment-routing/processors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider\": \"tagada\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": null,
"code": null,
"data": {
"set": true,
"settings": {
"enabled": false,
"mode": "share",
"retry": true,
"sticky": true,
"guard": true,
"guardDeclines": 8,
"guardWindow": 20,
"disputeAlert": 0.75
},
"processors": [
{
"provider": "nmi",
"name": "NMI",
"share": 100,
"capMonth": null,
"capDay": null,
"minOrder": null,
"maxOrder": null,
"state": "rotation",
"pausedReason": "",
"pausedAt": null,
"month": 0,
"day": 0,
"approved": null,
"disputes": null,
"fee": null
}
],
"rules": [],
"available": [
{
"provider": "tagada",
"name": "Tagada",
"usable": true
}
],
"figures": {
"routed": {
"orders": 0,
"volume": 0
},
"approved": null,
"saved": {
"orders": 0,
"volume": 0
},
"disputes": null
},
"limits": {
"rules": 50,
"countries": 100,
"guardWindowMin": 5,
"guardWindowMax": 200
}
}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}Payment Routing
Add a processor
Puts one of the store’s connected card methods into the routing, last. The shares are made even again. Answers the whole of Payment Routing again, as “Get Payment Routing” does.
Needs the routing.write permission (Change Payment Routing).
POST
/
stores
/
{storeId}
/
payment-routing
/
processors
Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.routing.addProcessor({
provider: "tagada",
});
<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->routing->addProcessor([
'provider' => 'tagada',
]);
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.routing.addProcessor(provider="tagada")
curl --request POST \
--url https://api.shoply.gg/v1/stores/{storeId}/payment-routing/processors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"provider": "tagada"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/payment-routing/processors"
payload := strings.NewReader("{\n \"provider\": \"tagada\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.shoply.gg/v1/stores/{storeId}/payment-routing/processors")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"tagada\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/payment-routing/processors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider\": \"tagada\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": null,
"code": null,
"data": {
"set": true,
"settings": {
"enabled": false,
"mode": "share",
"retry": true,
"sticky": true,
"guard": true,
"guardDeclines": 8,
"guardWindow": 20,
"disputeAlert": 0.75
},
"processors": [
{
"provider": "nmi",
"name": "NMI",
"share": 100,
"capMonth": null,
"capDay": null,
"minOrder": null,
"maxOrder": null,
"state": "rotation",
"pausedReason": "",
"pausedAt": null,
"month": 0,
"day": 0,
"approved": null,
"disputes": null,
"fee": null
}
],
"rules": [],
"available": [
{
"provider": "tagada",
"name": "Tagada",
"usable": true
}
],
"figures": {
"routed": {
"orders": 0,
"volume": 0
},
"approved": null,
"saved": {
"orders": 0,
"volume": 0
},
"disputes": null
},
"limits": {
"rules": 50,
"countries": 100,
"guardWindowMin": 5,
"guardWindowMax": 200
}
}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}Authorizations
A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...
Headers
A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with Idempotent-Replay: true.
Path Parameters
The store's ID. A key reaches the store it was made in: GET /key answers which.
Body
application/json
The card method, by its name in "List payment methods".
Example:
"tagada"

