Create Payment

Request

This endpoint expects an object.

serviceIdstringRequired

paidAtdatetimeRequired

transactionIdstringRequired

Unique transaction ID associated with this payment, this must be unique. Use for deduplication, a 409 will be returned if trying to create another Payment with same transactionId.

typeenumRequired

Denotes the type of Payment being registered, use PATIENT for any actual transaction being collected or refunded. Reserve ADJUSTMENT for manual/operational adjustments to balances, error corrections etc..

Allowed values:

amountintegerRequired

Payment amount, in USD cents. Positive values are payments paid by the Patient, negative values are refunds given back to the Patient.

externalIdstringOptional

Associate with any External ID value, should also be unique

memostringOptional

Response

This endpoint returns an object.

idstring

createdAtdatetime

serviceIdstring

paidAtdatetime

transactionIdstring

typeenum

Allowed values:

amountinteger

externalIdstring or null

memostring or null

1	curl -X POST https://app.usebridge.com/api/payments \
2	-H "X-API-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"serviceId": "serviceId",
6	"paidAt": "2024-01-15T09:30:00Z",
7	"transactionId": "transactionId",
8	"type": "PATIENT",
9	"amount": 1
10	}'

1	{
2	"id": "id",
3	"createdAt": "2024-01-15T09:30:00Z",
4	"serviceId": "serviceId",
5	"paidAt": "2024-01-15T09:30:00Z",
6	"transactionId": "transactionId",
7	"type": "PATIENT",
8	"amount": 1,
9	"externalId": "externalId",
10	"memo": "memo"
11	}

Headers

Request

Response