diff --git a/source/includes/_timeout.md b/source/includes/_timeout.md new file mode 100644 index 00000000..94d8cd22 --- /dev/null +++ b/source/includes/_timeout.md @@ -0,0 +1,28 @@ +# Timeout + +Timeouts can be set by partners when making requests to our API. This allows partners to control the maximum duration for which they are willing to wait for a response from our server. + +## Timeout Durations for OY's API + +Below is the list of timeout durations for OY's API: + +API | Timeout in seconds +---------- | ------- +E-Wallet Aggregator | 60 + +## Setting Timeout + +Partners can set the timeout by including the `timeout` parameter in the request headers. The value of the `timeout` parameter should be specified in seconds. + +## Example + +```http +POST https://partner.oyindonesia.com/api/e-wallet-aggregator/create-transaction +Host: partner.oyindonesia.com +Content-Type: application/json +X-Oy-Username: yourusername +X-Api-Key: yourapikey +Timeout: 60 +``` + +In this example, the partner is setting a timeout of 60 seconds for the request to POST /api/e-wallet-aggregator/create-transaction. Please note that OY's server will respond within this specified timeout duration. \ No newline at end of file diff --git a/source/index.html.md.erb b/source/index.html.md.erb index 6a33fe6b..993cb3e8 100644 --- a/source/index.html.md.erb +++ b/source/index.html.md.erb @@ -34,6 +34,7 @@ includes: - biller_api - api_account_linking - transaction_detail + - timeout - docs_changelog search: true