SmartGare
API referenceEndpoints

Record beneficiary details

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

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

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

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

*/*

*/*

*/*

curl -X POST "https://example.com/referential/v1/carriers/string/beneficiaries" \  -H "Content-Type: application/json" \  -d '{    "beneficiaryName": "string",    "bankName": "string",    "iban": "string",    "swiftBic": "string",    "effectiveFrom": "2019-08-24"  }'
{  "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"}