Outbound Message

Outbound Message records hold the details of Emails or Webhooks sent out from the system.

Method	Purpose
GET (Singular)	Return Outbound Message details
GET (List)	Return Outbound Message details in a list
Resend Outbound Message	Resend Outbound Message

GET (Singular)

Action: Return Outbound Message details.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/outboundmessage/{ID}

{ID} denotes ID of record.

Response Parameters

Property	Description
id	ID of the record
idempotency_key	Idempotency key of the Outbound Message
sent_at	Date and time the Outbound Message was sent
status	Status of the Webhook
record_type	Record type of the Outbound Message
subscription_id	ID of the Subscription
webhook	Object containing the Webhook data

Response Sample

{
    "OutboundMessage": {
        "id": "OM01ZQ05833RVM9986KN",
        "idempotency_key": "561d2df4-f812-4af6-b6d0-d4395e9372c9",
        "sent_at": "2022-11-22T13:02:42Z",
        "status": "successful",
        "record_type": "webhook",
        "subscription_id": "SU013MQ0KN8X6JOXZG71",
        "webhook": {
            "response_code": "200 OK",
            "webhook_body": "{\"id\":\"OM01ZQ05833RVM9986KN\",\"idempotency_key\":\"561d2df4-f812-4af6-b6d0-d4395e9372c9\",\"sent_at\":\"2022-11-22T11:56:37Z\",\"client\":{\"id\":\"CL01LG420EJ9DP1VQWR9\"},\"events\":[{\"id\":\"M01WLOKJYNRYNM8RX5Q\",\"reference\":\"F05AR22M00002633\",\"created_at\":\"2022-11-22T10:28:47Z\",\"edited_at\":\"2022-11-22T10:28:47Z\",\"status\":\"ongoing collection\",\"i_am_the_only_account_holder\":true,\"bacs_reason_code\":null,\"bacs_description\":null,\"event_type\":\"mandate.create\",\"event_source\":\"DDMS Service\",\"bacs_reference\":null,\"bacs_filename\":null,\"client\":{\"id\":\"CL01LG420EJ9DP1VQWR9\"},\"created_by\":{\"id\":\"CU01LG420EJ9VWP1VQWR\"},\"edited_by\":{\"id\":\"CU01LG420EJ9VWP1VQWR\"},\"customer_account\":null,\"bank_account\":{\"id\":\"BA01YZ96J11YWR7JNEWD\",\"legacy_id\":null,\"account_name\":\"Jeremiah Alexander\",\"account_number\":\"*****709\",\"sort_code\":\"****08\",\"bank_name\":\"CITIBANK NA\"},\"originating_bank_account\":{\"id\":\"OB01O6YQRDJZWJVL359M\",\"legacy_id\":null,\"account_name\":\"CBA - FTB - 01\",\"account_number\":\"10020645\",\"sort_code\":\"834600\"},\"service_user_number\":{\"id\":\"SN019LVZMGJ2KD8K46WE\",\"sun_number\":\"100263\",\"sun_name\":\"Smarterpay Test\"}}]}"
        }
    }
}

GET (List)

Action: Return Outbound Message details in a list.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/outboundmessages

Optional Parameters and filters are available, please see below.

Response Parameters

Property	Description
id	ID of the record
idempotency_key	Idempotency key of the Outbound Message
sent_at	Date and time the Outbound Message was sent
status	Status of the Webhook
record_type	Record type of the Outbound Message
subscription_id	ID of the Subscription
webhook	Object containing the Webhook data

Response Sample

{
    "OutboundMessages": [
        {
            "id": "OM01ZQ05833RVM9986KN",
            "idempotency_key": "561d2df4-f812-4af6-b6d0-d4395e9372c9",
            "sent_at": "2022-11-22T13:02:42Z",
            "status": "successful",
            "record_type": "webhook",
            "subscription_id": "SU013MQ0KN8X6JOXZG71",
            "webhook": {
                "response_code": "200 OK",
                "webhook_body": "{\"id\":\"OM01ZQ05833RVM9986KN\",\"idempotency_key\":\"561d2df4-f812-4af6-b6d0-d4395e9372c9\",\"sent_at\":\"2022-11-22T11:56:37Z\",\"client\":{\"id\":\"CL01LG420EJ9DP1VQWR9\"},\"events\":[{\"id\":\"M01WLOKJYNRYNM8RX5Q\",\"reference\":\"F05AR22M00002633\",\"created_at\":\"2022-11-22T10:28:47Z\",\"edited_at\":\"2022-11-22T10:28:47Z\",\"status\":\"ongoing collection\",\"i_am_the_only_account_holder\":true,\"bacs_reason_code\":null,\"bacs_description\":null,\"event_type\":\"mandate.create\",\"event_source\":\"DDMS Service\",\"bacs_reference\":null,\"bacs_filename\":null,\"client\":{\"id\":\"CL01LG420EJ9DP1VQWR9\"},\"created_by\":{\"id\":\"CU01LG420EJ9VWP1VQWR\"},\"edited_by\":{\"id\":\"CU01LG420EJ9VWP1VQWR\"},\"customer_account\":null,\"bank_account\":{\"id\":\"BA01YZ96J11YWR7JNEWD\",\"legacy_id\":null,\"account_name\":\"Jeremiah Alexander\",\"account_number\":\"*****709\",\"sort_code\":\"****08\",\"bank_name\":\"CITIBANK NA\"},\"originating_bank_account\":{\"id\":\"OB01O6YQRDJZWJVL359M\",\"legacy_id\":null,\"account_name\":\"CBA - FTB - 01\",\"account_number\":\"10020645\",\"sort_code\":\"834600\"},\"service_user_number\":{\"id\":\"SN019LVZMGJ2KD8K46WE\",\"sun_number\":\"100263\",\"sun_name\":\"Smarterpay Test\"}}]}"
            }
        },
        {
            "id": "OM01NZWLJRVZGX6D8GQ9",
            "idempotency_key": "c9ce2998-b2f3-4152-b571-13f64f944183",
            "sent_at": "2022-11-22T13:02:41Z",
            "status": "successful",
            "record_type": "webhook",
            "subscription_id": "SU013MQ0KN8X6JOXZG71",
            "webhook": {
                "response_code": "200 OK",
                "webhook_body": "{\"id\":\"OM01NZWLJRVZGX6D8GQ9\",\"idempotency_key\":\"c9ce2998-b2f3-4152-b571-13f64f944183\",\"sent_at\":\"2022-11-22T11:56:37Z\",\"client\":{\"id\":\"CL01LG420EJ9DP1VQWR9\"},\"events\":[{\"id\":\"M01137EJ7RLOR7J4QOM\",\"reference\":\"F05AR22M00002631\",\"created_at\":\"2022-11-22T10:28:47Z\",\"edited_at\":\"2022-11-22T10:28:47Z\",\"status\":\"ongoing collection\",\"i_am_the_only_account_holder\":true,\"bacs_reason_code\":null,\"bacs_description\":null,\"event_type\":\"mandate.create\",\"event_source\":\"DDMS Service\",\"bacs_reference\":null,\"bacs_filename\":null,\"client\":{\"id\":\"CL01LG420EJ9DP1VQWR9\"},\"created_by\":{\"id\":\"CU01LG420EJ9VWP1VQWR\"},\"edited_by\":{\"id\":\"CU01LG420EJ9VWP1VQWR\"},\"customer_account\":null,\"bank_account\":{\"id\":\"BA01YZ96J11YWR7JNEWD\",\"legacy_id\":null,\"account_name\":\"Jeremiah Alexander\",\"account_number\":\"*****709\",\"sort_code\":\"****08\",\"bank_name\":\"CITIBANK NA\"},\"originating_bank_account\":{\"id\":\"OB01O6YQRDJZWJVL359M\",\"legacy_id\":null,\"account_name\":\"CBA - FTB - 01\",\"account_number\":\"10020645\",\"sort_code\":\"834600\"},\"service_user_number\":{\"id\":\"SN019LVZMGJ2KD8K46WE\",\"sun_number\":\"100263\",\"sun_name\":\"Smarterpay Test\"}}]}"
            }
        }
    ]
}

Optional Parameters and filters
Optional parameters can be added to the GET URL by using a “?” in front of the first parameter and “&” in front of subsequent parameters, for example https://api.smarterpaycloud.com/Service.svc/BankAccounts?limit=2&page_no=1

Parameter	Description
limit	Limits the number of records returned by the request. Default=40 when not specified. Minimum=1. Maximum=500.
page_no	Specifies which page of records are returned by the request. Default=1 when not specified.
sort_field	specifies which field to sort on. Options are: “id”,“sun”,“created_at” (Default when not specified).
sort_order	Specifies which order to sort on. Options are asc (ascending. Default when not specified) or desc (descending).

Filter	Description
created_from	Filter the list with records created after the datetime supplied. Format is YYYY-MM-DD HH:MM:SS (2022-05-13 10:15:00).
created_to	Filter the list with records created before the datetime supplied. Format is YYYY-MM-DD HH:MM:SS (2022-05-13 10:15:00).
id	Filter the list using the id. Matches will exactly match the provided value.
record_type	Filter the list using the Record Type. Can be a comma seperated list of required values. Options are “email”,“webhook”
sent_from	Filter the list with records sent after the datetime supplied. Format is YYYY-MM-DD HH:MM:SS (2022-05-13 10:15:00).
sent_to	Filter the list with records sent before the datetime supplied. Format is YYYY-MM-DD HH:MM:SS (2022-05-13 10:15:00).
status	Filter the list using the status of the record. Can be a comma seperated list of required values. Options are “pending”,“successful”,“resend”,“retry”,“failed”.

Resend Outbound Message

Action: Resend Outbound Message.
Method: POST
URL: https://api.smarterpaycloud.com/service.svc/resendoutboundmessage/{ID}

{ID} denotes ID of record.

Request Parameters

No parameters needed.

Response Parameters

Property	Description
id	ID of the record
idempotency_key	Idempotency key of the Outbound Message
sent_at	Date and time the Outbound Message was sent
status	Status of the Webhook
record_type	Record type of the Outbound Message
subscription_id	ID of the Subscription
webhook	Object containing the Webhook data

Response Sample

{
    "OutboundMessage": {
        "id": "OM01ZQ05833RVM9986KN",
        "idempotency_key": "561d2df4-f812-4af6-b6d0-d4395e9372c9",
        "sent_at": "2022-11-22T13:02:42Z",
        "status": "successful",
        "record_type": "webhook",
        "subscription_id": "SU013MQ0KN8X6JOXZG71",
        "webhook": {
            "response_code": "200 OK",
            "webhook_body": "{\"id\":\"OM01ZQ05833RVM9986KN\",\"idempotency_key\":\"561d2df4-f812-4af6-b6d0-d4395e9372c9\",\"sent_at\":\"2022-11-22T11:56:37Z\",\"client\":{\"id\":\"CL01LG420EJ9DP1VQWR9\"},\"events\":[{\"id\":\"M01WLOKJYNRYNM8RX5Q\",\"reference\":\"F05AR22M00002633\",\"created_at\":\"2022-11-22T10:28:47Z\",\"edited_at\":\"2022-11-22T10:28:47Z\",\"status\":\"ongoing collection\",\"i_am_the_only_account_holder\":true,\"bacs_reason_code\":null,\"bacs_description\":null,\"event_type\":\"mandate.create\",\"event_source\":\"DDMS Service\",\"bacs_reference\":null,\"bacs_filename\":null,\"client\":{\"id\":\"CL01LG420EJ9DP1VQWR9\"},\"created_by\":{\"id\":\"CU01LG420EJ9VWP1VQWR\"},\"edited_by\":{\"id\":\"CU01LG420EJ9VWP1VQWR\"},\"customer_account\":null,\"bank_account\":{\"id\":\"BA01YZ96J11YWR7JNEWD\",\"legacy_id\":null,\"account_name\":\"Jeremiah Alexander\",\"account_number\":\"*****709\",\"sort_code\":\"****08\",\"bank_name\":\"CITIBANK NA\"},\"originating_bank_account\":{\"id\":\"OB01O6YQRDJZWJVL359M\",\"legacy_id\":null,\"account_name\":\"CBA - FTB - 01\",\"account_number\":\"10020645\",\"sort_code\":\"834600\"},\"service_user_number\":{\"id\":\"SN019LVZMGJ2KD8K46WE\",\"sun_number\":\"100263\",\"sun_name\":\"Smarterpay Test\"}}]}"
        }
    }
}