Collections API - Resubmission

Base URL

This tutorial uses the test URL:

https://api.paygateservicedemo.com/collections_public/api/

When a collection fails (for example, due to insufficient funds) it may be eligible to be presented again. The Resubmission endpoints list these pending representations and allow them to be resubmitted.

Step 1 - Getting pending representations

All Groups

Call type: GET

Url: https://api.paygateservicedemo.com/collections_public/api/Resubmission

A single Group

Call type: GET

Url: https://api.paygateservicedemo.com/collections_public/api/Resubmission/{groupId}

Response:

[
  {
    "historyId": "1f6e4c2a-8d3b-4a7e-9c05-6b2d8e1f3a47",
    "payerReference": "SMITH0001",
    "planReference": "PLAN0001",
    "amount": 10.00,
    "generationDate": "2026-12-04T09:30:00Z",
    "groupId": "3d8ac4aa-4610-48a7-8d74-a5a3e192a42c",
    "groupName": "My Collections Group"
  }
]

Step 2 - Resubmitting

All resubmission calls accept the optional “X-Idempotency-Key” header, and return HTTP 200 on success or a 400 ProblemDetails on failure.

Resubmit a single Payer

Call type: POST

Url: https://api.paygateservicedemo.com/collections_public/api/Resubmission/single

Request:

{
  "payerReference": "SMITH0001",
  "groupId": "3d8ac4aa-4610-48a7-8d74-a5a3e192a42c"
}

Resubmit selected Payers

Call type: POST

Url: https://api.paygateservicedemo.com/collections_public/api/Resubmission

Request:

{
  "payerReferences": [
    {
      "payerReference": "SMITH0001",
      "groupId": "3d8ac4aa-4610-48a7-8d74-a5a3e192a42c"
    },
    {
      "payerReference": "JONES0002",
      "groupId": "3d8ac4aa-4610-48a7-8d74-a5a3e192a42c"
    }
  ]
}

Resubmit all pending representations for a Group

Call type: POST

Url: https://api.paygateservicedemo.com/collections_public/api/Resubmission/{groupId}/all

There is no request body.

Resubmit all pending representations

Call type: POST

Url: https://api.paygateservicedemo.com/collections_public/api/Resubmission/all

There is no request body. This resubmits across every Group available to the caller, so use it with care.

Step 3 - Confirming

After resubmitting, the Plan schedule shows the representation. In the schedule the original item will have “isRepresented” set to true.

Resubmitted collections are then included in the next submission - see Collections API - Submissions.