Skip to main content
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>'
{}

​
Request

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

​
Path parameters

ParameterTypeDescription
providerstringThe ShopPayment id (from GET /payments), not a provider name such as "paystack".

​
Query parameters

ParameterTypeDescription
orderIdstringRequired. The order the payment is initialized for.
currencystringOptional. 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.