All URIs are relative to https://cert.api.firstdata.com/gateway/v2
| Method | HTTP request | Description |
|---|---|---|
| cancel_payment_schedule | DELETE /payment-schedules/{order-id} | Cancel a gateway payment schedule. |
| create_payment_schedule | POST /payment-schedules | Create gateway payment schedule. |
| inquiry_payment_schedule | GET /payment-schedules/{order-id} | View a gateway payment schedule. |
| update_payment_schedule | PATCH /payment-schedules/{order-id} | Update a gateway payment schedule. |
PaymentSchedulesResponse cancel_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, message_signature=message_signature, region=region, store_id=store_id)
Cancel a gateway payment schedule.
Use this to cancel an existing gateway payment schedule.
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = openapi_client.PaymentSchedulesApi()
content_type = 'application/json' # str | Content type. (default to 'application/json')
client_request_id = 'client_request_id_example' # str | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
api_key = 'api_key_example' # str | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp = 56 # int | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
order_id = 'order_id_example' # str | Gateway order identifier as returned in the parameter orderId.
message_signature = 'message_signature_example' # str | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
region = 'region_example' # str | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
store_id = 'store_id_example' # str | An optional outlet ID for clients that support multiple stores in the same developer app. (optional)
try:
# Cancel a gateway payment schedule.
api_response = api_instance.cancel_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, message_signature=message_signature, region=region, store_id=store_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling PaymentSchedulesApi->cancel_payment_schedule: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| content_type | str | Content type. | [default to 'application/json'] |
| client_request_id | str | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. | |
| api_key | str | Key given to merchant after boarding associating their requests with the appropriate app in Apigee. | |
| timestamp | int | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | |
| order_id | str | Gateway order identifier as returned in the parameter orderId. | |
| message_signature | str | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional] |
| region | str | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional] |
| store_id | str | An optional outlet ID for clients that support multiple stores in the same developer app. | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success response. | - |
| 400 | The request cannot be validated. | - |
| 401 | The request was unauthorized. | - |
| 404 | The requested resource doesn't exist. | - |
| 409 | There was a problem communicating with the endpoint. | - |
| 415 | Format that is not supported by the server for the HTTP method. | - |
| 422 | There was a problem communicating with the endpoint. | - |
| 500 | An unexpected internal server error occurred. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaymentSchedulesResponse create_payment_schedule(content_type, client_request_id, api_key, timestamp, payment_schedules_request, message_signature=message_signature, region=region)
Create gateway payment schedule.
Use this to create a gateway payment schedule.
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = openapi_client.PaymentSchedulesApi()
content_type = 'application/json' # str | Content type. (default to 'application/json')
client_request_id = 'client_request_id_example' # str | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
api_key = 'api_key_example' # str | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp = 56 # int | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
payment_schedules_request = openapi_client.PaymentSchedulesRequest() # PaymentSchedulesRequest | Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest.
message_signature = 'message_signature_example' # str | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
region = 'region_example' # str | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
try:
# Create gateway payment schedule.
api_response = api_instance.create_payment_schedule(content_type, client_request_id, api_key, timestamp, payment_schedules_request, message_signature=message_signature, region=region)
pprint(api_response)
except ApiException as e:
print("Exception when calling PaymentSchedulesApi->create_payment_schedule: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| content_type | str | Content type. | [default to 'application/json'] |
| client_request_id | str | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. | |
| api_key | str | Key given to merchant after boarding associating their requests with the appropriate app in Apigee. | |
| timestamp | int | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | |
| payment_schedules_request | PaymentSchedulesRequest | Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest. | |
| message_signature | str | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional] |
| region | str | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success response. | - |
| 400 | The request cannot be validated. | - |
| 401 | The request was unauthorized. | - |
| 404 | The requested resource doesn't exist. | - |
| 409 | The attempted action is not valid according to gateway rules. | - |
| 415 | Format that is not supported by the server for the HTTP method. | - |
| 422 | The endpoint declined the transaction. | - |
| 500 | An unexpected internal server error occurred. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RecurringPaymentDetailsResponse inquiry_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, message_signature=message_signature, region=region, store_id=store_id)
View a gateway payment schedule.
Use this to view an existing gateway payment schedule.
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = openapi_client.PaymentSchedulesApi()
content_type = 'application/json' # str | Content type. (default to 'application/json')
client_request_id = 'client_request_id_example' # str | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
api_key = 'api_key_example' # str | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp = 56 # int | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
order_id = 'order_id_example' # str | Gateway order identifier as returned in the parameter orderId.
message_signature = 'message_signature_example' # str | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
region = 'region_example' # str | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
store_id = 'store_id_example' # str | An optional outlet ID for clients that support multiple stores in the same developer app. (optional)
try:
# View a gateway payment schedule.
api_response = api_instance.inquiry_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, message_signature=message_signature, region=region, store_id=store_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling PaymentSchedulesApi->inquiry_payment_schedule: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| content_type | str | Content type. | [default to 'application/json'] |
| client_request_id | str | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. | |
| api_key | str | Key given to merchant after boarding associating their requests with the appropriate app in Apigee. | |
| timestamp | int | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | |
| order_id | str | Gateway order identifier as returned in the parameter orderId. | |
| message_signature | str | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional] |
| region | str | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional] |
| store_id | str | An optional outlet ID for clients that support multiple stores in the same developer app. | [optional] |
RecurringPaymentDetailsResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success response. | - |
| 400 | The request cannot be validated. | - |
| 401 | The request was unauthorized. | - |
| 404 | The requested resource doesn't exist. | - |
| 415 | Format that is not supported by the server for the HTTP method. | - |
| 500 | An unexpected internal server error occurred. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PaymentSchedulesResponse update_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, payment_schedules_request, message_signature=message_signature, region=region)
Update a gateway payment schedule.
Use this to update a gateway payment schedule.
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = openapi_client.PaymentSchedulesApi()
content_type = 'application/json' # str | Content type. (default to 'application/json')
client_request_id = 'client_request_id_example' # str | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
api_key = 'api_key_example' # str | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp = 56 # int | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
order_id = 'order_id_example' # str | Gateway order identifier as returned in the parameter orderId.
payment_schedules_request = openapi_client.PaymentSchedulesRequest() # PaymentSchedulesRequest | Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest.
message_signature = 'message_signature_example' # str | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. (optional)
region = 'region_example' # str | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. (optional)
try:
# Update a gateway payment schedule.
api_response = api_instance.update_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, payment_schedules_request, message_signature=message_signature, region=region)
pprint(api_response)
except ApiException as e:
print("Exception when calling PaymentSchedulesApi->update_payment_schedule: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| content_type | str | Content type. | [default to 'application/json'] |
| client_request_id | str | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. | |
| api_key | str | Key given to merchant after boarding associating their requests with the appropriate app in Apigee. | |
| timestamp | int | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | |
| order_id | str | Gateway order identifier as returned in the parameter orderId. | |
| payment_schedules_request | PaymentSchedulesRequest | Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest. | |
| message_signature | str | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional] |
| region | str | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success response. | - |
| 400 | The request cannot be validated. | - |
| 401 | The request was unauthorized. | - |
| 404 | The requested resource doesn't exist. | - |
| 409 | There was a problem communicating with the endpoint. | - |
| 422 | There was a problem communicating with the endpoint. | - |
| 500 | An unexpected internal server error occurred. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]