new IdPayDriver()
Class that provides methods to interact with the IdPay API.
- Source
Methods
(async) request(dataInput) → {Promise.<TransactionCreateResponseIdPay>}
Request method to create a transaction.
Parameters:
| Name | Type | Description |
|---|---|---|
dataInput | TransactionCreateInputIdPay | Input data for creating the transaction. |
- Source
Returns:
Response from the IdPay API for creating a transaction.
- Type:
- Promise.<TransactionCreateResponseIdPay>
(async) request(dataInput) → {Promise.<TransactionCreateResponseIdPay>}
Request method to create a transaction.
Parameters:
| Name | Type | Description |
|---|---|---|
dataInput | TransactionCreateInputIdPay | Input data for creating the transaction. |
- Source
Returns:
Response from the IdPay API for creating a transaction.
- Type:
- Promise.<TransactionCreateResponseIdPay>
setSandBox(sandBox) → {this}
Set whether to use the sandbox environment or not.
Parameters:
| Name | Type | Description |
|---|---|---|
sandBox | boolean | True to use sandbox, false otherwise. |
- Source
Returns:
Instance of IdPayDriver.
- Type:
- this
setSandBox(sandBox) → {this}
Set whether to use the sandbox environment or not.
Parameters:
| Name | Type | Description |
|---|---|---|
sandBox | boolean | True to use sandbox, false otherwise. |
- Source
Returns:
Instance of IdPayDriver.
- Type:
- this
setToken(token) → {this}
Set the API token for authentication.
Parameters:
| Name | Type | Description |
|---|---|---|
token | string | The API token. |
- Source
Returns:
Instance of IdPayDriver.
- Type:
- this
setToken(token) → {this}
Set the API token for authentication.
Parameters:
| Name | Type | Description |
|---|---|---|
token | string | The API token. |
- Source
Returns:
Instance of IdPayDriver.
- Type:
- this
(async) verify(dataInput) → {Promise.<TransactionVerifyResponseIdPay>}
Verify method to verify a transaction.
Parameters:
| Name | Type | Description |
|---|---|---|
dataInput | TransactionVerifyInputIdPay | Input data for verifying the transaction. |
- Source
Returns:
Response from the IdPay API for verifying a transaction.
- Type:
- Promise.<TransactionVerifyResponseIdPay>
(async) verify(dataInput) → {Promise.<TransactionVerifyResponseIdPay>}
Verify method to verify a transaction.
Parameters:
| Name | Type | Description |
|---|---|---|
dataInput | TransactionVerifyInputIdPay | Input data for verifying the transaction. |
- Source
Returns:
Response from the IdPay API for verifying a transaction.
- Type:
- Promise.<TransactionVerifyResponseIdPay>