SmartGare
API referenceEndpoints

List beneficiary history

Returns every recorded version, newest effective date first.

GET/referential/v1/carriers/{id}/beneficiaries

Returns every recorded version, newest effective date first.

Authorization

oauth2
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

*/*

curl -X GET "https://example.com/referential/v1/carriers/string/beneficiaries"
[  {    "id": "string",    "carrierId": "string",    "beneficiaryName": "string",    "bankName": "string",    "iban": "string",    "swiftBic": "string",    "reference": "string",    "effectiveFrom": "2019-08-24",    "recordedBy": "string",    "recordedAt": "2019-08-24T14:15:22Z"  }]

Reactivate a suspended carrier

Puts a suspended carrier back into service.

Record beneficiary details

Appends a version of the carrier's payout beneficiary details, in force from an effective date.