curl --request POST \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId}/clear-pause \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"effectiveAt": "2026-08-29T12:00:00Z"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({effectiveAt: '2026-08-29T12:00:00Z'})
};
fetch('https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId}/clear-pause', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId}/clear-pause"
payload = { "effectiveAt": "2026-08-29T12:00:00Z" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId}/clear-pause"
payload := strings.NewReader("{\n \"effectiveAt\": \"2026-08-29T12:00:00Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId}/clear-pause")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"effectiveAt\": \"2026-08-29T12:00:00Z\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId}/clear-pause");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"effectiveAt\": \"2026-08-29T12:00:00Z\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
{
"financialType": "loan_balance",
"sourceRevision": 1,
"balanceBreakdown": {
"costs": {
"amount": "0.00",
"currency": "EUR"
},
"fees": {
"amount": "50.00",
"currency": "EUR"
},
"interest": {
"amount": "200.00",
"currency": "EUR"
},
"principal": {
"amount": "1000.00",
"currency": "EUR"
}
},
"creditUnion": {
"arrearsAmount": {
"amount": "1250.00",
"currency": "EUR"
},
"contractualInstalment": {
"amount": {
"amount": "125.00",
"currency": "EUR"
},
"frequency": "monthly"
},
"defaultDate": "2026-07-01",
"loanAccountReference": "loan-ref-example",
"loanType": "personal_loan",
"totalOutstandingAmount": {
"amount": "4000.00",
"currency": "EUR"
}
},
"dueDate": "2026-08-01",
"recoverableAmount": {
"amount": "1250.00",
"currency": "EUR"
},
"responsibleCustomers": [
{
"externalCustomerId": "CUS_123",
"role": "primary"
}
],
"sourceReference": "receivable-ref-example",
"financialPosition": {
"confirmedUnreconciledAmount": {
"amount": "0.00",
"currency": "EUR"
},
"receiptAcknowledgedAmount": {
"amount": "0.00",
"currency": "EUR"
},
"sourceAmount": {
"amount": "1250.00",
"currency": "EUR"
},
"workingAmount": {
"amount": "1250.00",
"currency": "EUR"
}
},
"externalReceivableId": "REC_123",
"status": "active",
"updatedAt": "2026-08-29T12:00:00Z"
}{
"detail": "Request body is not valid JSON.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 400,
"title": "Request body is not valid JSON.",
"type": "https://docs.paypathiq.com/problems/malformed_json"
}{
"detail": "API key is invalid, inactive, revoked, or for another environment.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 401,
"title": "API key is invalid, inactive, revoked, or for another environment.",
"type": "https://docs.paypathiq.com/problems/invalid_api_key"
}{
"detail": "The Client code is unknown, the grant lacks the required scope, or the calling address is outside the grant's IP allowlist.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 403,
"title": "The Client code is unknown, the grant lacks the required scope, or the calling address is outside the grant's IP allowlist.",
"type": "https://docs.paypathiq.com/problems/client_scope_denied"
}{
"detail": "Receivable was not found within the authorized scope.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 404,
"title": "Receivable was not found within the authorized scope.",
"type": "https://docs.paypathiq.com/problems/receivable_not_found"
}{
"detail": "No active source pause exists to clear.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 409,
"title": "No active source pause exists to clear.",
"type": "https://docs.paypathiq.com/problems/pause_not_active"
}{
"detail": "Request body exceeds the 256 KiB resource limit.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 413,
"title": "Request body exceeds the 256 KiB resource limit.",
"type": "https://docs.paypathiq.com/problems/request_too_large"
}{
"detail": "Media type or content encoding is unsupported. Send uncompressed application/json for PUT and POST, and application/merge-patch+json for PATCH.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 415,
"title": "Media type or content encoding is unsupported. Send uncompressed application/json for PUT and POST, and application/merge-patch+json for PATCH.",
"type": "https://docs.paypathiq.com/problems/unsupported_media_type"
}{
"detail": "Route parameters or the representation are invalid. Route parameters are checked before authentication. Field errors carry a code such as invalid_format, unrecognized_keys, custom, sensitive_external_id, or sensitive_source_reference.",
"errors": [
{
"code": "invalid_format",
"detail": "Invalid ISO date",
"pointer": "/dueDate"
}
],
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 422,
"title": "Route parameters or the representation are invalid. Route parameters are checked before authentication. Field errors carry a code such as invalid_format, unrecognized_keys, custom, sensitive_external_id, or sensitive_source_reference.",
"type": "https://docs.paypathiq.com/problems/validation_error"
}{
"detail": "Each API key may send 60 requests per minute and run 1 request at a time. In sandbox, the same limits also apply per Client across all of its keys. Every request, including GET, counts.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 429,
"title": "Each API key may send 60 requests per minute and run 1 request at a time. In sandbox, the same limits also apply per Client across all of its keys. Every request, including GET, counts.",
"type": "https://docs.paypathiq.com/problems/rate_limit_exceeded"
}{
"detail": "An unexpected error prevented a safe commit, and nothing was saved. Retry with backoff.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 503,
"title": "An unexpected error prevented a safe commit, and nothing was saved. Retry with backoff.",
"type": "https://docs.paypathiq.com/problems/projection_unavailable"
}Clear a Receivable pause
Lift a pause your integration placed on a Receivable. Requires receivables:write. Clears only the calling Integration’s active pause and never resumes recovery automatically. If the response is lost, GET the Receivable before deciding whether another command is needed.
curl --request POST \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId}/clear-pause \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"effectiveAt": "2026-08-29T12:00:00Z"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({effectiveAt: '2026-08-29T12:00:00Z'})
};
fetch('https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId}/clear-pause', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId}/clear-pause"
payload = { "effectiveAt": "2026-08-29T12:00:00Z" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId}/clear-pause"
payload := strings.NewReader("{\n \"effectiveAt\": \"2026-08-29T12:00:00Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId}/clear-pause")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"effectiveAt\": \"2026-08-29T12:00:00Z\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId}/clear-pause");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"effectiveAt\": \"2026-08-29T12:00:00Z\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
{
"financialType": "loan_balance",
"sourceRevision": 1,
"balanceBreakdown": {
"costs": {
"amount": "0.00",
"currency": "EUR"
},
"fees": {
"amount": "50.00",
"currency": "EUR"
},
"interest": {
"amount": "200.00",
"currency": "EUR"
},
"principal": {
"amount": "1000.00",
"currency": "EUR"
}
},
"creditUnion": {
"arrearsAmount": {
"amount": "1250.00",
"currency": "EUR"
},
"contractualInstalment": {
"amount": {
"amount": "125.00",
"currency": "EUR"
},
"frequency": "monthly"
},
"defaultDate": "2026-07-01",
"loanAccountReference": "loan-ref-example",
"loanType": "personal_loan",
"totalOutstandingAmount": {
"amount": "4000.00",
"currency": "EUR"
}
},
"dueDate": "2026-08-01",
"recoverableAmount": {
"amount": "1250.00",
"currency": "EUR"
},
"responsibleCustomers": [
{
"externalCustomerId": "CUS_123",
"role": "primary"
}
],
"sourceReference": "receivable-ref-example",
"financialPosition": {
"confirmedUnreconciledAmount": {
"amount": "0.00",
"currency": "EUR"
},
"receiptAcknowledgedAmount": {
"amount": "0.00",
"currency": "EUR"
},
"sourceAmount": {
"amount": "1250.00",
"currency": "EUR"
},
"workingAmount": {
"amount": "1250.00",
"currency": "EUR"
}
},
"externalReceivableId": "REC_123",
"status": "active",
"updatedAt": "2026-08-29T12:00:00Z"
}{
"detail": "Request body is not valid JSON.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 400,
"title": "Request body is not valid JSON.",
"type": "https://docs.paypathiq.com/problems/malformed_json"
}{
"detail": "API key is invalid, inactive, revoked, or for another environment.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 401,
"title": "API key is invalid, inactive, revoked, or for another environment.",
"type": "https://docs.paypathiq.com/problems/invalid_api_key"
}{
"detail": "The Client code is unknown, the grant lacks the required scope, or the calling address is outside the grant's IP allowlist.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 403,
"title": "The Client code is unknown, the grant lacks the required scope, or the calling address is outside the grant's IP allowlist.",
"type": "https://docs.paypathiq.com/problems/client_scope_denied"
}{
"detail": "Receivable was not found within the authorized scope.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 404,
"title": "Receivable was not found within the authorized scope.",
"type": "https://docs.paypathiq.com/problems/receivable_not_found"
}{
"detail": "No active source pause exists to clear.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 409,
"title": "No active source pause exists to clear.",
"type": "https://docs.paypathiq.com/problems/pause_not_active"
}{
"detail": "Request body exceeds the 256 KiB resource limit.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 413,
"title": "Request body exceeds the 256 KiB resource limit.",
"type": "https://docs.paypathiq.com/problems/request_too_large"
}{
"detail": "Media type or content encoding is unsupported. Send uncompressed application/json for PUT and POST, and application/merge-patch+json for PATCH.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 415,
"title": "Media type or content encoding is unsupported. Send uncompressed application/json for PUT and POST, and application/merge-patch+json for PATCH.",
"type": "https://docs.paypathiq.com/problems/unsupported_media_type"
}{
"detail": "Route parameters or the representation are invalid. Route parameters are checked before authentication. Field errors carry a code such as invalid_format, unrecognized_keys, custom, sensitive_external_id, or sensitive_source_reference.",
"errors": [
{
"code": "invalid_format",
"detail": "Invalid ISO date",
"pointer": "/dueDate"
}
],
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 422,
"title": "Route parameters or the representation are invalid. Route parameters are checked before authentication. Field errors carry a code such as invalid_format, unrecognized_keys, custom, sensitive_external_id, or sensitive_source_reference.",
"type": "https://docs.paypathiq.com/problems/validation_error"
}{
"detail": "Each API key may send 60 requests per minute and run 1 request at a time. In sandbox, the same limits also apply per Client across all of its keys. Every request, including GET, counts.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 429,
"title": "Each API key may send 60 requests per minute and run 1 request at a time. In sandbox, the same limits also apply per Client across all of its keys. Every request, including GET, counts.",
"type": "https://docs.paypathiq.com/problems/rate_limit_exceeded"
}{
"detail": "An unexpected error prevented a safe commit, and nothing was saved. Retry with backoff.",
"requestId": "29400000-0000-4000-8000-000000000001",
"status": 503,
"title": "An unexpected error prevented a safe commit, and nothing was saved. Retry with backoff.",
"type": "https://docs.paypathiq.com/problems/projection_unavailable"
}Authorizations
Integration-owned environment-specific API key. Never paste a production key into documentation tools.
Path Parameters
Stable non-sensitive Client code authorized by the Integration grant.
^[A-Za-z0-9_-]{1,128}$Opaque Receivable identifier supplied by the Integration; capitalization must match.
^[A-Za-z0-9_-]{1,128}$Body
One uncompressed resource representation, limited to 256 KiB.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Response
Lifecycle command applied. If the response is lost, read the Receivable before deciding whether to send another lifecycle command.
- Option 1
- Option 2
Each financial type requires exactly its industry context. The balance breakdown must sum exactly to recoverableAmount.
Show child attributes
Show child attributes
loan_instalment, accelerated_balance, loan_balance x <= 9007199254740991^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Show child attributes
Show child attributes
Customer identifiers must be unique and exactly one role must be primary.
1 - 8 elementsShow child attributes
Show child attributes
1 - 200^[A-Za-z0-9_-]{1,128}$active, paused, closed ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$All four amounts are required when a breakdown is supplied; use 0.00 where needed.
Show child attributes
Show child attributes
At most one assertion per type; ordering is semantically irrelevant.
3Show child attributes
Show child attributes
Present on reads. sourceAmount is the declared accounting authority's position, workingAmount is the safe collection balance after confirmed allocated Payments, and confirmedUnreconciledAmount is the allocated confirmed amount the Source has not yet acknowledged. Unapplied funds appear in none of them.
Show child attributes
Show child attributes