Payments Bridge

Payments Bridge operations

Add new Subscription

Role Requirements

tenant-bridge-write or tenant-admin

Description

Creates a new Payments Bridge Subscription with the subscription name subscriptionName.

Securitybearer

Request

path Parameters

subscriptionName

required

string (SubscriptionName) ^[a-zA-Z0-9-]{3,50}$

The unique name for this subscription (3-50 chars, alphanumeric with hyphens)

header Parameters

x-account-id required	string <uuid> = 36 characters The Account Id (lowercase and hyphenated). Example: 1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id required	string <uuid> = 36 characters The Tenant Id (lowercase and hyphenated). Example: ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id	string Correlation Id for the request.

Request Body schema: application/json

required

WebhookEventDeliveryConfiguration (object)

Specifies how events are made available to the registered service.

Responses

202

Accepted

400

Bad Request

409

Conflict - An enabled subscription with the same name already exists

post/v2/payments-bridge/service/registration/{subscriptionName}

Request samples

application/json

{"eventDeliveryConfiguration": {"type": "Webhook",
"destinationUrl": "https://duckcreek.com/webhook"
}
}

Response samples

400
409

application/json

{"timestamp": "2021-01-30T08:30:00Z",
"correlationId": "string",
"status": 202,
"type": "about:blank",
"title": "Accepted",
"detail": "Command was accepted.",
"instance": "http://example.com",
"traceId": "string",
"errors": [{"timestamp": "2021-01-30T08:30:00Z",
"correlationId": "string",
"status": 202,
"type": "about:blank",
"title": "Accepted",
"detail": "Command was accepted.",
"instance": "http://example.com",
"traceId": "string",
"metadata": {"property1": "string",
"property2": "string"
}
}
],
"metadata": {"property1": "string",
"property2": "string"
}
}

Update Subscription

Role Requirements

tenant-bridge-write or tenant-admin

Description

Creates a new Payments Bridge Subscription with the subscription name subscriptionName.

Securitybearer

Request

path Parameters

subscriptionName

required

string (SubscriptionName) ^[a-zA-Z0-9-]{3,50}$

The unique name for this subscription (3-50 chars, alphanumeric with hyphens)

header Parameters

x-account-id required	string <uuid> = 36 characters The Account Id (lowercase and hyphenated). Example: 1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id required	string <uuid> = 36 characters The Tenant Id (lowercase and hyphenated). Example: ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id	string Correlation Id for the request.

Request Body schema: application/json

required

WebhookEventDeliveryConfiguration (object)

Specifies how events are made available to the registered service.

Responses

202

Accepted

400

Bad Request

put/v2/payments-bridge/service/registration/{subscriptionName}

Request samples

application/json

{"eventDeliveryConfiguration": {"type": "Webhook",
"destinationUrl": "https://duckcreek.com/webhook",
"maximumEventsPerBatch": 100
}
}

Response samples

400

application/json

{"timestamp": "2021-01-30T08:30:00Z",
"correlationId": "string",
"status": 202,
"type": "about:blank",
"title": "Accepted",
"detail": "Command was accepted.",
"instance": "http://example.com",
"traceId": "string",
"errors": [{"timestamp": "2021-01-30T08:30:00Z",
"correlationId": "string",
"status": 202,
"type": "about:blank",
"title": "Accepted",
"detail": "Command was accepted.",
"instance": "http://example.com",
"traceId": "string",
"metadata": {"property1": "string",
"property2": "string"
}
}
],
"metadata": {"property1": "string",
"property2": "string"
}
}

Delete Subscription

Role Requirements

tenant-bridge-write or tenant-admin

Description

Deletes the Payments Bridge Subscription with the subscription name subscriptionName.

Securitybearer

Request

path Parameters

subscriptionName

required

string (SubscriptionName) ^[a-zA-Z0-9-]{3,50}$

The unique name for this subscription (3-50 chars, alphanumeric with hyphens)

header Parameters

x-account-id required	string <uuid> = 36 characters The Account Id (lowercase and hyphenated). Example: 1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id required	string <uuid> = 36 characters The Tenant Id (lowercase and hyphenated). Example: ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id	string Correlation Id for the request.

Responses

204

No Content

400

Bad Request

404

No active registration found for the tenant with the specified name

delete/v2/payments-bridge/service/registration/{subscriptionName}

Request samples

Response samples

400
404

application/json

{"timestamp": "2021-01-30T08:30:00Z",
"correlationId": "string",
"status": 202,
"type": "about:blank",
"title": "Accepted",
"detail": "Command was accepted.",
"instance": "http://example.com",
"traceId": "string",
"errors": [{"timestamp": "2021-01-30T08:30:00Z",
"correlationId": "string",
"status": 202,
"type": "about:blank",
"title": "Accepted",
"detail": "Command was accepted.",
"instance": "http://example.com",
"traceId": "string",
"metadata": {"property1": "string",
"property2": "string"
}
}
],
"metadata": {"property1": "string",
"property2": "string"
}
}

Get Subscription Details

Role Requirements

tenant-bridge-read or tenant-admin

Description

Retrieve the details for the Payments Bridge Subscription with the subscription name subscriptionName.

Securitybearer

Request

path Parameters

subscriptionName

required

string (SubscriptionName) ^[a-zA-Z0-9-]{3,50}$

The unique name for this subscription (3-50 chars, alphanumeric with hyphens)

header Parameters

x-account-id required	string <uuid> = 36 characters The Account Id (lowercase and hyphenated). Example: 1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id required	string <uuid> = 36 characters The Tenant Id (lowercase and hyphenated). Example: ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id	string Correlation Id for the request.

Responses

200

The current service registration details

404

No active registration found for the tenant

get/v2/payments-bridge/service/registration/{subscriptionName}

Request samples

Response samples

200
404

application/json

{"subscriptionName": "string",
"eventDeliveryConfiguration": {"type": "Webhook",
"destinationUrl": "http://example.com",
"maximumEventsPerBatch": 1,
"authentication": {"type": "OAuth2ClientCredentials",
"tokenUrl": "http://example.com",
"clientId": "s6BhdRkqt3",
"clientSecret": "7Fjfp0ZBr1KtDRbnfVdmIw",
"scope": "Webhook.Deliver"
},
"customHeaders": [{"name": "Ocp-Apim-Subscription-Key",
"value": "subscription-key-value"
}
]
}
}

List Subscriptions

Role Requirements

tenant-bridge-read or tenant-admin

Description

List all Payments Bridge Subscriptions under the Tenant.

Securitybearer

Request

header Parameters

x-account-id required	string <uuid> = 36 characters The Account Id (lowercase and hyphenated). Example: 1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id required	string <uuid> = 36 characters The Tenant Id (lowercase and hyphenated). Example: ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id	string Correlation Id for the request.

Responses

200

The current service registration details for the tenant

404

No active service registrations found for the tenant

get/v2/payments-bridge/service/subscriptions

Request samples

Response samples

200
404

application/json

{"subscriptions": [{"subscriptionName": "string",
"destinationUrl": "http://example.com",
"authentication": true,
"customHeaders": true
}
]
}

Test all Subscriptions

Role Requirements

tenant-bridge-write or tenant-admin

Description

Triggers a test event to be sent for all a tenant's configured subscriptions.

Securitybearer

Request

header Parameters

x-account-id required	string <uuid> = 36 characters The Account Id (lowercase and hyphenated). Example: 1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id required	string <uuid> = 36 characters The Tenant Id (lowercase and hyphenated). Example: ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id	string Correlation Id for the request.

Responses

202

Accepted

400

Bad Request

post/v2/payments-bridge/service/test

Request samples

Response samples

202
400

application/json

{"eventId": "123e4567-e89b-12d3-a456-426614174000"
}

Upsert service registration (legacy endpoint without subscription name)Deprecated

Role Requirements

bridge-writer

Description

Upsert a service registration for the Payments Bridge. This endpoint is used to register a service that will receive payment events.

Securitybearer

Request

header Parameters

x-account-id required	string <uuid> = 36 characters The Account Id (lowercase and hyphenated). Example: 1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id required	string <uuid> = 36 characters The Tenant Id (lowercase and hyphenated). Example: ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id	string Correlation Id for the request.

Request Body schema: application/json

required

WebhookEventDeliveryConfiguration (object)

Specifies how events are made available to the registered service.

Responses

202

Accepted

400

Bad Request

put/v2/payments-bridge/service/registration

Request samples

application/json

{"eventDeliveryConfiguration": {"type": "Webhook",
"destinationUrl": "https://duckcreek.com/webhook",
"maximumEventsPerBatch": 100
}
}

Response samples

400

application/json

{"timestamp": "2021-01-30T08:30:00Z",
"correlationId": "string",
"status": 202,
"type": "about:blank",
"title": "Accepted",
"detail": "Command was accepted.",
"instance": "http://example.com",
"traceId": "string",
"errors": [{"timestamp": "2021-01-30T08:30:00Z",
"correlationId": "string",
"status": 202,
"type": "about:blank",
"title": "Accepted",
"detail": "Command was accepted.",
"instance": "http://example.com",
"traceId": "string",
"metadata": {"property1": "string",
"property2": "string"
}
}
],
"metadata": {"property1": "string",
"property2": "string"
}
}

Delete default service registrationDeprecated

Securitybearer

Request

header Parameters

x-account-id required	string <uuid> = 36 characters The Account Id (lowercase and hyphenated). Example: 1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id required	string <uuid> = 36 characters The Tenant Id (lowercase and hyphenated). Example: ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id	string Correlation Id for the request.

Responses

204

No Content

400

Bad Request

404

No active registration found for the tenant

delete/v2/payments-bridge/service/registration

Request samples

Response samples

400
404

application/json

{"timestamp": "2021-01-30T08:30:00Z",
"correlationId": "string",
"status": 202,
"type": "about:blank",
"title": "Accepted",
"detail": "Command was accepted.",
"instance": "http://example.com",
"traceId": "string",
"errors": [{"timestamp": "2021-01-30T08:30:00Z",
"correlationId": "string",
"status": 202,
"type": "about:blank",
"title": "Accepted",
"detail": "Command was accepted.",
"instance": "http://example.com",
"traceId": "string",
"metadata": {"property1": "string",
"property2": "string"
}
}
],
"metadata": {"property1": "string",
"property2": "string"
}
}

Get service registration detailsDeprecated

Role Requirements

bridge-reader

Description

Retrieve the current service registration details for the Payments Bridge.

Securitybearer

Request

header Parameters

x-account-id required	string <uuid> = 36 characters The Account Id (lowercase and hyphenated). Example: 1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id required	string <uuid> = 36 characters The Tenant Id (lowercase and hyphenated). Example: ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id	string Correlation Id for the request.

Responses

200

The current service registration details

404

No active registration found for the tenant

get/v2/payments-bridge/service/registration

Request samples

Response samples

200
404

application/json

{"subscriptionName": "string",
"eventDeliveryConfiguration": {"type": "Webhook",
"destinationUrl": "http://example.com",
"maximumEventsPerBatch": 1,
"authentication": {"type": "OAuth2ClientCredentials",
"tokenUrl": "http://example.com",
"clientId": "s6BhdRkqt3",
"clientSecret": "7Fjfp0ZBr1KtDRbnfVdmIw",
"scope": "Webhook.Deliver"
},
"customHeaders": [{"name": "Ocp-Apim-Subscription-Key",
"value": "subscription-key-value"
}
]
}
}