SpareSpare Docs
GuidesAPI Reference

Consents

Create, list, and retrieve payment consents.

POST
/api/v1.0/pis/Consent/Create
Authorization
Header

Json web signature (JWS: RFC7519) of the payment initiation consent request payload in detached mode. <see href="https://datatracker.ietf.org/doc/html/rfc7519" />

Body
*object
object
object

Request Body

application/json

Payment initiation consent request model.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1.0/pis/Consent/Create" \  -H "x-signature: string" \  -H "Content-Type: application/json" \  -d '{    "providerId": "00000000-0000-0000-0000-000000000000",    "amount": "string",    "currency": "BHD",    "paymentConsentType": "SingleInstantPayment",    "purpose": "SELF",    "creditorAccount": {      "scheme": "IBAN",      "identification": "string"    }  }'
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "paymentId": "00000000-0000-0000-0000-000000000000",    "consentId": "00000000-0000-0000-0000-000000000000",    "externalReference": "string",    "scope": "Accounts",    "paymentConsentType": "SingleInstantPayment",    "executionDateTime": "2025-01-01T00:00:00Z",    "authorizationLink": "string",    "amount": {      "value": 0,      "currency": {        "id": "00000000-0000-0000-0000-000000000000",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      }    },    "createdAt": "2025-01-01T00:00:00Z",    "status": "AwaitingAuthorization",    "creditorAccount": {      "id": "00000000-0000-0000-0000-000000000000",      "scheme": "IBAN",      "identification": "string",      "name": "string"    },    "debtorAccount": {      "id": "00000000-0000-0000-0000-000000000000",      "scheme": "IBAN",      "identification": "string",      "name": "string"    },    "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",            "englishName": "string",            "arabicName": "string",            "iso4117Code": "str",            "iso4117Number": "stri"          },          "englishName": "string",          "arabicName": "string",          "iso3166Code": "st",          "timeZone": "string"        },        "address": "string",        "phone": "string",        "isEnable": true,        "arabicName": "string",        "englishName": "string",        "status": "Active",        "logo": "https://example.com"      },      "id": "00000000-0000-0000-0000-000000000000",      "status": "ACTIVE",      "createdAt": "2025-01-01T00:00:00Z",      "updatedAt": "2025-01-01T00:00:00Z"    },    "purpose": "string",    "note": "string"  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
"INVALID_DATA"
Empty
GET
/api/v1.0/pis/Consent/List
Authorization
Query

Page number

Number of items per page maximum allow is 100 per page

Provider id (Optional)

Connection id (Optional)

External reference (Optional)

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1.0/pis/Consent/List"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": [    {      "paymentId": "00000000-0000-0000-0000-000000000000",      "consentId": "00000000-0000-0000-0000-000000000000",      "externalReference": "string",      "scope": "Accounts",      "paymentConsentType": "SingleInstantPayment",      "executionDateTime": "2025-01-01T00:00:00Z",      "authorizationLink": "string",      "amount": {        "value": 0,        "currency": {          "id": "00000000-0000-0000-0000-000000000000",          "englishName": "string",          "arabicName": "string",          "iso4117Code": "str",          "iso4117Number": "stri"        }      },      "createdAt": "2025-01-01T00:00:00Z",      "status": "AwaitingAuthorization",      "creditorAccount": {        "id": "00000000-0000-0000-0000-000000000000",        "scheme": "IBAN",        "identification": "string",        "name": "string"      },      "debtorAccount": {        "id": "00000000-0000-0000-0000-000000000000",        "scheme": "IBAN",        "identification": "string",        "name": "string"      },      "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",              "englishName": "string",              "arabicName": "string",              "iso4117Code": "str",              "iso4117Number": "stri"            },            "englishName": "string",            "arabicName": "string",            "iso3166Code": "st",            "timeZone": "string"          },          "address": "string",          "phone": "string",          "isEnable": true,          "arabicName": "string",          "englishName": "string",          "status": "Active",          "logo": "https://example.com"        },        "id": "00000000-0000-0000-0000-000000000000",        "status": "ACTIVE",        "createdAt": "2025-01-01T00:00:00Z",        "updatedAt": "2025-01-01T00:00:00Z"      },      "purpose": "string",      "note": "string"    }  ],  "meta": {    "currentPageNumber": 0,    "pageSize": 0,    "totalNumberOfPages": 0  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
"INVALID_DATA"
Empty
GET
/api/v1.0/pis/Consent/Get
Authorization
Query

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1.0/pis/Consent/Get?consentId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": {    "paymentId": "00000000-0000-0000-0000-000000000000",    "consentId": "00000000-0000-0000-0000-000000000000",    "externalReference": "string",    "scope": "Accounts",    "paymentConsentType": "SingleInstantPayment",    "executionDateTime": "2025-01-01T00:00:00Z",    "authorizationLink": "string",    "amount": {      "value": 0,      "currency": {        "id": "00000000-0000-0000-0000-000000000000",        "englishName": "string",        "arabicName": "string",        "iso4117Code": "str",        "iso4117Number": "stri"      }    },    "createdAt": "2025-01-01T00:00:00Z",    "status": "AwaitingAuthorization",    "creditorAccount": {      "id": "00000000-0000-0000-0000-000000000000",      "scheme": "IBAN",      "identification": "string",      "name": "string"    },    "debtorAccount": {      "id": "00000000-0000-0000-0000-000000000000",      "scheme": "IBAN",      "identification": "string",      "name": "string"    },    "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",            "englishName": "string",            "arabicName": "string",            "iso4117Code": "str",            "iso4117Number": "stri"          },          "englishName": "string",          "arabicName": "string",          "iso3166Code": "st",          "timeZone": "string"        },        "address": "string",        "phone": "string",        "isEnable": true,        "arabicName": "string",        "englishName": "string",        "status": "Active",        "logo": "https://example.com"      },      "id": "00000000-0000-0000-0000-000000000000",      "status": "ACTIVE",      "createdAt": "2025-01-01T00:00:00Z",      "updatedAt": "2025-01-01T00:00:00Z"    },    "purpose": "string",    "note": "string"  }}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
"INVALID_DATA"
Empty