Integration

A collection of endpoints for managing some settings on an integration

Copy link Fetch Payment Session Timeout

Fetch the session timeout of a transaction

Response

200
statusrequiredboolean
messagerequiredstring
datarequiredobject
1 object property
payment_session_timeoutrequiredinteger
GET/integration/payment_session_timeout
curl https://api.paystack.co/integration/payment_session_timeout \
  -H "Authorization: Bearer YOUR_SECRET_KEY"
import { Paystack } from "@paystack/paystack-sdk";

const paystack = new Paystack({ secretKey: process.env.PAYSTACK_SECRET_KEY! });

const response = await paystack.integration.fetchPaymentSessionTimeout();
console.log(response.data);
require "paystack"

paystack = Paystack::Client.new(ENV.fetch("PAYSTACK_SECRET_KEY"))

response = paystack.integration.fetch_payment_session_timeout()
puts response.data
Response
{
  "status": true,
  "message": "Payment session timeout retrieved",
  "data": {
    "payment_session_timeout": 30
  }
}
{
  "status": false,
  "message": "An error occurred",
  "meta": {
    "nextStep": "string"
  },
  "type": "string",
  "code": "validation_error",
  "errorCodeMappingNotFound": true
}
{
  "status": false,
  "message": "An error occurred",
  "meta": {
    "nextStep": "string"
  },
  "type": "string",
  "code": "validation_error",
  "errorCodeMappingNotFound": true
}

Copy link Update Payment Session Timeout

Update the session timeout of a transaction

Request Body

timeoutrequiredinteger
Time in seconds before a transaction becomes invalid

Response

200
statusrequiredboolean
messagerequiredstring
datarequiredobject
1 object property
payment_session_timeoutrequiredinteger
PUT/integration/payment_session_timeout
curl https://api.paystack.co/integration/payment_session_timeout \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeout": 30
  }' \
  -X PUT
import { Paystack } from "@paystack/paystack-sdk";

const paystack = new Paystack({ secretKey: process.env.PAYSTACK_SECRET_KEY! });

const response = await paystack.integration.updatePaymentSessionTimeout({
  timeout: 30
});
console.log(response.data);
require "paystack"

paystack = Paystack::Client.new(ENV.fetch("PAYSTACK_SECRET_KEY"))

response = paystack.integration.update_payment_session_timeout({
  timeout: 30
})
puts response.data
Response
{
  "status": true,
  "message": "Payment session timeout updated",
  "data": {
    "payment_session_timeout": 30
  }
}
{
  "status": false,
  "message": "An error occurred",
  "meta": {
    "nextStep": "string"
  },
  "type": "string",
  "code": "validation_error",
  "errorCodeMappingNotFound": true
}
{
  "status": false,
  "message": "An error occurred",
  "meta": {
    "nextStep": "string"
  },
  "type": "string",
  "code": "validation_error",
  "errorCodeMappingNotFound": true
}