Consent

List consent

get/api/v1.0/pis/Consent/List

Request

  • Base URL: https://sandbox.tryspare.com
  • URL: https://sandbox.tryspare.com/api/v1.0/pis/Consent/List
  • Auth: API key in header Authorization

Query parameters

pageinteger

Page number

perPageinteger

Number of items per page maximum allow is 100 per page

providerIdstring uuid

Provider id (Optional)

connectionIdstring uuid

Connection id (Optional)

externalReferencestring

External reference (Optional)

Response

error'INVALID_DATA' | 'INVALID_SIGNATURE' | 'RESOURCE_LOCKED' | 'COUNTRY_NOT_FOUND' | 'CURRENCY_NOT_FOUND' | 'PROVIDER_NOT_FOUND' | 'CONNECTION_NOT_FOUND' | 'INSUFFICIENT_CONSENT_PERMISSIONS' | 'CONSENT_EXPIRED' | 'CONSENT_REVOKED' | 'CONSENT_UNAUTHORIZED' | 'CONSENT_NOT_FOUND' | 'RISK_REPORT_NOT_FOUND' | 'ACCOUNT_INFORMATION_REPORT_NOT_FOUND' | 'MULTIPLE_CURRENCY_NOT_ALLOWED' | 'MULTIPLE_CONSENT_DATE_NOT_ALLOWED' | 'PAYMENT_NOT_FOUND' | 'CONSENT_REJECTED' | 'PAYMENT_REQUEST_NOT_FOUND' | 'CUSTOMER_NOT_FOUND' | 'CUSTOMER_ALREADY_EXISTS' | 'BANK_ACCOUNT_NOT_FOUND' | 'SERVER_ERROR' | 'PROVIDER_CONNECTION_FAILURE' | 'TRANSACTION_NOT_FOUND' | 'ACCOUNT_INFORMATION_ACCESS_REQUEST_NOT_FOUND' | 'CONSENT_REVOCATION_FAILED' | 'CONSENT_REVOKED_OR_EXPIRED' | 'SUBSCRIPTION_EXPIRED' | 'NOT_SUBSCRIBED_TO_SERVICE' | 'BENEFICIARY_NOT_FOUND' | 'PARTIES_NOT_FOUND' | 'DIRECT_DEBIT_NOT_FOUND' | 'SCHEDULED_PAYMENT_NOT_FOUND' | 'DEBTOR_ACCOUNT_NOT_FOUND' | 'CREDITOR_ACCOUNT_NOT_FOUND' | 'UNAUTHORIZED_IP_ADDRESS'
errorDescriptionobject nullable

Example response

{
  "data": [
    {
      "paymentId": "00000000-0000-0000-0000-000000000000",
      "consentId": "00000000-0000-0000-0000-000000000000",
      "executionDateTime": "2025-01-01T00:00:00Z",
      "amount": {
        "currency": {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      },
      "createdAt": "2025-01-01T00:00:00Z",
      "creditorAccount": {
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "debtorAccount": {
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "connection": {
        "provider": {
          "id": "00000000-0000-0000-0000-000000000000",
          "country": {
            "id": "00000000-0000-0000-0000-000000000000",
            "createdAt": "2025-01-01T00:00:00Z",
            "updatedAt": "2025-01-01T00:00:00Z",
            "currency": {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          },
          "logo": "https://example.com"
        },
        "id": "00000000-0000-0000-0000-000000000000",
        "createdAt": "2025-01-01T00:00:00Z",
        "updatedAt": "2025-01-01T00:00:00Z"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.