Skip to main content
GET
/
api
/
payments-received
/
state
Retrieves the payment received state.
curl --request GET \
  --url https://api.example.com/api/payments-received/state \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'
{
  "defaultTemplateId": 1
}

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Response

200 - application/json

The payment received state has been successfully retrieved.

​
defaultTemplateId
number | null
required

The ID of the default PDF template for payment received

Example:

1