Financial communication configuration API (1.0.0)

Download OpenAPI specification:Download

Use this API to configure notifications and financial communications that are sent from the NewStore platform to customers in your business. This may include receipts and other similar financial documents.

Note: Financial documents and notifications can be sent to the customer via email or through push notifications. Emails contain the relevant financial documents as attachments.

Financial communication configuration

Use this resource to manage the financial communication configuration for your business.

Get financial communication configuration

Retrieves the complete financial communication configuration for your business.

The response payload contains the current version of the configuration, the timestamp when it was last updated, and who updated it.

Authorizations:

newStoreAccessToken

header Parameters

request_id	string ID of the request. Generated automatically.
tenant required	string Tenant name. Substituted automatically from the path.
user-id	string ID of the user. Substituted automatically from the auth token.

Responses

Response samples

200
404
500

Content type

application/json

{"value": {"notification_options": {"push_notification_channel_type": "customer_uuid",
"options": {"gift_card.issued": ["email"
],
"invoice_created": ["email"
],
"refund_note_created": ["email"
]
}
}
},
"version": "string",
"updated_at": "2021-12-31T23:59:59Z",
"updated_by": "string"
}

Update financial communication configuration

Updates the current financial communication configuration for your business.

Authorizations:

newStoreAccessToken

query Parameters

version

required

string

Current version of the financial communication configuration. Use the Get financial communication configuration method to retrieve the current configuration.

header Parameters

request_id	string ID of the request. Generated automatically.
tenant required	string Tenant name. Substituted automatically from the path.
user-id	string ID of the user. Substituted automatically from the auth token.

Request Body schema: application/json

The updated config value

required

object

Notification options related to financial documents.

push_notification_channel_type required	string Enum: "customer_uuid" "email" Push notification need a channel (type of addressing) for where to send notifications. That can be the internal customer identifier or their email.
required	object A map of enabled notifications and their respective channels.

Responses

Request samples

Payload

Content type

application/json

{"notification_options": {"push_notification_channel_type": "customer_uuid",
"options": {"gift_card.issued": ["email"
],
"invoice_created": ["email"
],
"refund_note_created": ["email"
]
}
}
}

Response samples

200
400
404
409
500

Content type

application/json

{"value": {"notification_options": {"push_notification_channel_type": "customer_uuid",
"options": {"gift_card.issued": ["email"
],
"invoice_created": ["email"
],
"refund_note_created": ["email"
]
}
}
},
"version": "string",
"updated_at": "2021-12-31T23:59:59Z",
"updated_by": "string"
}

Create financial communication configuration

Use this method to create a new financial communication configuration and completely replace the current configuration for your business.

Authorizations:

newStoreAccessToken

query Parameters

version

required

string

Current version of the financial communication configuration. Use the Get financial communication configuration method to retrieve the current configuration.

header Parameters

request_id	string ID of the request. Generated automatically.
tenant required	string Tenant name. Substituted automatically from the path.
user-id	string ID of the user. Substituted automatically from the auth token.

Request Body schema: application/json

The updated config value

required

object

Notification options related to financial documents.

push_notification_channel_type required	string Enum: "customer_uuid" "email" Push notification need a channel (type of addressing) for where to send notifications. That can be the internal customer identifier or their email.
required	object A map of enabled notifications and their respective channels.

Responses

Request samples

Payload

Content type

application/json

{"notification_options": {"push_notification_channel_type": "customer_uuid",
"options": {"gift_card.issued": ["email"
],
"invoice_created": ["email"
],
"refund_note_created": ["email"
]
}
}
}

Response samples

200
400
404
409
500

Content type

application/json

{"value": {"notification_options": {"push_notification_channel_type": "customer_uuid",
"options": {"gift_card.issued": ["email"
],
"invoice_created": ["email"
],
"refund_note_created": ["email"
]
}
}
},
"version": "string",
"updated_at": "2021-12-31T23:59:59Z",
"updated_by": "string"
}