Sign in

v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB
Procedures

Process a subscription payment

Manually process an outstanding subscription payment. The target payment must be declined.

post/procedures/process-payment

Headers

api-tokenstring required

Your API access token for authentication and access to the Helcim API

idempotency-keystring required

A unique 25 character alphanumeric key to ensure the request is idempotent. Requests containing keys used in previously successful requests will be rejected.

Request body

subscriptionIdinteger required

The id of the subscription to process the declined payment for.

paymentNumberinteger required

The recurring payment number quantifying when the subscription was billed. For example a subscription's third billing has payment number 3.

Example request

{
  "subscriptionId": 12345,
  "paymentNumber": 5
}

Response

Successful payment processing. The response body contains the data representation of the subscription and its processed payment. If data querying after processing failed an error message will instead be returned.

OR

Example response

{
  "timestamp": "2024-06-25T18:07:34.608Z",
  "status": "error",
  "errors": {
    "example": {
      "ERR_VALIDATION_FAILED": {
        "code": "ERR_VALIDATION_FAILED",
        "message": "Field fails validation"
      },
      "ERR_BAD_REQUEST": {
        "code": "ERR_BAD_REQUEST",
        "message": "One or more properties failed validation"
      }
    }
  }
}