TCL / DocuSign eSignature REST API / Gets payment information for one or more payments.
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "from_date" "{{from_date}}"
CkJsonObject_UpdateString $queryParams "to_date" "{{to_date}}"
# Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_put_AuthToken $http "{{accessToken}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://domain.com/v2.1/accounts/{{accountId}}/billing_payments" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
Curl Command
curl -G -d "from_date=%7B%7Bfrom_date%7D%7D"
-d "to_date=%7B%7Bto_date%7D%7D"
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/billing_payments
Postman Collection Item JSON
{
"name": "Gets payment information for one or more payments.",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/billing_payments?from_date={{from_date}}&to_date={{to_date}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"billing_payments"
],
"query": [
{
"key": "from_date",
"value": "{{from_date}}"
},
{
"key": "to_date",
"value": "{{to_date}}"
}
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}",
"type": "string"
}
]
},
"description": "Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. \n\nPrivileges required: account administrator "
},
"response": [
]
}