Get payment config

Get payment config for a provider

curl --request GET \
  --url https://store.salesive.com/api/v1/payments/config/{provider} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'

import requests

url = "https://store.salesive.com/api/v1/payments/config/{provider}"

headers = {
    "Authorization": "Bearer <token>",
    "x-shop-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'x-shop-id': '<api-key>'}
};

fetch('https://store.salesive.com/api/v1/payments/config/{provider}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://store.salesive.com/api/v1/payments/config/{provider}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-shop-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://store.salesive.com/api/v1/payments/config/{provider}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-shop-id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://store.salesive.com/api/v1/payments/config/{provider}")
  .header("Authorization", "Bearer <token>")
  .header("x-shop-id", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://store.salesive.com/api/v1/payments/config/{provider}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-shop-id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{}

GET

payments

config

{provider}

Get payment config for a provider

curl --request GET \
  --url https://store.salesive.com/api/v1/payments/config/{provider} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'

import requests

url = "https://store.salesive.com/api/v1/payments/config/{provider}"

headers = {
    "Authorization": "Bearer <token>",
    "x-shop-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'x-shop-id': '<api-key>'}
};

fetch('https://store.salesive.com/api/v1/payments/config/{provider}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://store.salesive.com/api/v1/payments/config/{provider}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-shop-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://store.salesive.com/api/v1/payments/config/{provider}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-shop-id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://store.salesive.com/api/v1/payments/config/{provider}")
  .header("Authorization", "Bearer <token>")
  .header("x-shop-id", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://store.salesive.com/api/v1/payments/config/{provider}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-shop-id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{}

Request

GET /payments/config/{provider}?orderId={{orderId}}
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}

Path parameters

Parameter	Type	Description
`provider`	string	The ShopPayment id (from `GET /payments`), not a provider name such as `"paystack"`.

Query parameters

Parameter	Type	Description
`orderId`	string	Required. The order the payment is initialized for.
`currency`	string	Optional. Defaults to the shop currency (e.g. `NGN`).

The provider segment must be a valid 24-character ShopPayment id. Passing a provider name (for example paystack) returns 400. List the available payment methods and their ids with GET /payments.

Successful response

The shape of data depends on the payment method type. A bank-transfer method returns account details:

{
    "status": 200,
    "success": true,
    "message": "Payment config retrieved",
    "data": {
        "accountNumber": "1234567890",
        "accountName": "Sample Store / Jane Smith",
        "bankCode": "035",
        "bankName": "Wema Bank",
        "bankId": "wema"
    }
}

A gateway method (e.g. Nomba) returns the gateway initialization payload (accountId, clientId, and an order object with the amount and metadata).

Error responses

{
    "status": 400,
    "success": false,
    "message": "\"provider\" length must be 24 characters long",
    "data": {}
}

{
    "status": 500,
    "success": false,
    "message": "This payment provider is not enabled for this store",
    "data": null
}

Authorizations

Authorization

string

header

required

JWT issued by the Salesive Store API for authenticated shoppers.

x-shop-id

string

header

required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

x-shop-id

string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Path Parameters

provider

string

required

ShopPayment id from GET /payments.

Query Parameters

orderId

string

required

currency

string

Example:

"NGN"

Response

Payment config retrieved.

The response is of type object.

Get shop payments List products

Overview

Authentication

Banners

Blogs

Cart

Comments

Country

Coupons

Newsletter

Orders

Payments

Products

Push Subscriptions

Reviews

Shipping

Shipping address

Shop

User

Wishlist

Request

Path parameters

Query parameters

Successful response

Error responses

Authorizations

Headers

Path Parameters

Query Parameters

Response

​Request

​Path parameters

​Query parameters

​Successful response

​Error responses

Authorizations

Headers

Path Parameters

Query Parameters

Response

Request

Path parameters

Query parameters

Successful response

Error responses