customer-blockeds

Operations addressed under /customer-blockeds — 6 operations.

aurax-bff-service-dynamic-get-blocked-account-list-by-account-id

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/api/customer-blockeds/by-account-id/{accountId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Request and response fields are declared on the routing target get-blocked-account-list-by-account-id; this entry declares none of its own.

Response body, read from the service source

The route declares its response as IEnumerable<CustomerBlockedDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`BlockedItemId`	`Guid`	no
`CustomerId`	`Guid`	no
`BlockedAmount`	`decimal?`	yes
`BlockedCurrencyNumber`	`string`	no
`BlockedType`	`int`	no
`BlockedDate`	`DateOnly`	no
`BlockedDueDate`	`DateOnly?`	yes
`UnblockedDate`	`DateOnly?`	yes
`UnblockedReason`	`string`	no
`IsActive`	`bool`	no
`Direction`	`int`	no
`Description`	`string`	no
`AccountBlockeds`	`List<BlockedAccountItem>` (collection)	no

Member names are the service's declaration names.

aurax-bff-service-dynamic-get-blocked-account-list-by-account-id › path Parameters

accountId

string · uuid · required

aurax-bff-service-dynamic-get-blocked-account-list-by-account-id › query Parameters

object

orderBy

string

orderSort

string

aurax-bff-service-dynamic-get-blocked-account-list-by-account-id › Responses

Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.

object[]

Array of catalog-declared response records.

object[]

blockedAmount

number · decimal

blockedCurrencyNumber

string

blockedDate

string · date

blockedDueDate

string · date

blockedItemId

string · uuid

blockedType

integer · int32

customerId

string · uuid

description

string

direction

string

id

string · uuid

isActive

boolean

unblockedDate

string · date-time

unblockedReason

string

GET/api/customer-blockeds/by-account-id/{accountId}

curl https://dg-sandbox.dgpays.com/aurax-bff-service/api/customer-blockeds/by-account-id/:accountId

Example Responses

[
  {
    "accountBlockeds": [
      {
        "accountBlockedId": "00000000-0000-0000-0000-000000000000",
        "accountId": "00000000-0000-0000-0000-000000000000",
        "amount": 0,
        "amountBlockedCurrency": 0,
        "blockedSubType": 0,
        "exchangeRate": 0
      }
    ],
    "blockedAmount": 0,
    "blockedCurrencyNumber": "blockedCurrencyNumber",
    "blockedDate": "2024-08-25",
    "blockedDueDate": "2024-08-25",
    "blockedItemId": "00000000-0000-0000-0000-000000000000",
    "blockedType": 0,
    "customerId": "00000000-0000-0000-0000-000000000000",
    "description": "description",
    "direction": "direction",
    "id": "00000000-0000-0000-0000-000000000000",
    "isActive": true,
    "unblockedDate": "2024-08-25T15:00:00Z",
    "unblockedReason": "unblockedReason"
  }
]

json

application/json

aurax-bff-service-dynamic-get-customer-blocked-list-by-customer-id

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/api/customer-blockeds/by-customer-id/{customerId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Request and response fields are declared on the routing target get-customer-blocked-list-by-customer-id; this entry declares none of its own.

Response body, read from the service source

The route declares its response as IEnumerable<CustomerBlockedDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`BlockedItemId`	`Guid`	no
`CustomerId`	`Guid`	no
`BlockedAmount`	`decimal?`	yes
`BlockedCurrencyNumber`	`string`	no
`BlockedType`	`int`	no
`BlockedDate`	`DateOnly`	no
`BlockedDueDate`	`DateOnly?`	yes
`UnblockedDate`	`DateOnly?`	yes
`UnblockedReason`	`string`	no
`IsActive`	`bool`	no
`Direction`	`int`	no
`Description`	`string`	no
`AccountBlockeds`	`List<BlockedAccountItem>` (collection)	no

Member names are the service's declaration names.

aurax-bff-service-dynamic-get-customer-blocked-list-by-customer-id › path Parameters

customerId

string · uuid · required

aurax-bff-service-dynamic-get-customer-blocked-list-by-customer-id › query Parameters

object

orderBy

string

orderSort

string

aurax-bff-service-dynamic-get-customer-blocked-list-by-customer-id › Responses

object[]

Array of catalog-declared response records.

object[]

blockedAmount

number · decimal

blockedCurrencyNumber

string

blockedDate

string · date

blockedDueDate

string · date

blockedItemId

string · uuid

blockedSubType

integer · int32

blockedType

integer · int32

customerBlockedId

string · uuid

customerId

string · uuid

description

string

direction

string

isActive

boolean

unblockedDate

string · date-time

unblockedReason

string

GET/api/customer-blockeds/by-customer-id/{customerId}

curl https://dg-sandbox.dgpays.com/aurax-bff-service/api/customer-blockeds/by-customer-id/:customerId

Example Responses

[
  {
    "accountBlockeds": [
      {
        "accountBlockedId": "00000000-0000-0000-0000-000000000000",
        "accountId": "00000000-0000-0000-0000-000000000000",
        "amount": 0,
        "amountBlockedCurrency": 0,
        "exchangeRate": 0
      }
    ],
    "blockedAmount": 0,
    "blockedCurrencyNumber": "blockedCurrencyNumber",
    "blockedDate": "2024-08-25",
    "blockedDueDate": "2024-08-25",
    "blockedItemId": "00000000-0000-0000-0000-000000000000",
    "blockedSubType": 0,
    "blockedType": 0,
    "customerBlockedId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "description": "description",
    "direction": "direction",
    "isActive": true,
    "unblockedDate": "2024-08-25T15:00:00Z",
    "unblockedReason": "unblockedReason"
  }
]

json

application/json

aurax-bff-dynamic-get-blocked-customer-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/customer-blockeds

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Request and response fields are declared on the routing target get-blocked-customer-list; this entry declares none of its own.

Response body, read from the service source

The route declares its response as IEnumerable<CustomerBlockedDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`BlockedItemId`	`Guid`	no
`CustomerId`	`Guid`	no
`BlockedAmount`	`decimal?`	yes
`BlockedCurrencyNumber`	`string`	no
`BlockedType`	`int`	no
`BlockedDate`	`DateOnly`	no
`BlockedDueDate`	`DateOnly?`	yes
`UnblockedDate`	`DateOnly?`	yes
`UnblockedReason`	`string`	no
`IsActive`	`bool`	no
`Direction`	`int`	no
`Description`	`string`	no
`AccountBlockeds`	`List<BlockedAccountItem>` (collection)	no

Member names are the service's declaration names.

aurax-bff-dynamic-get-blocked-customer-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

aurax-bff-dynamic-get-blocked-customer-list › Responses

Success. Returns a page of records: the collection under data, with total carrying the unpaged count.

Paged response envelope observed on the BFF response path.

object[] · required

Response records carried by this page.

total

integer · int64

Total matching records, ignoring paging.

GET/customer-blockeds

curl https://dg-sandbox.dgpays.com/aurax-bff-service/customer-blockeds

Example Responses

{
  "data": [
    {
      "accountBlockeds": [
        {
          "accountBlockedId": "00000000-0000-0000-0000-000000000000",
          "accountId": "00000000-0000-0000-0000-000000000000",
          "amount": 0,
          "amountBlockedCurrency": 0,
          "exchangeRate": 0
        }
      ],
      "blockedAmount": 0,
      "blockedCurrencyNumber": "blockedCurrencyNumber",
      "blockedDate": "2024-08-25",
      "blockedDueDate": "2024-08-25",
      "blockedItemId": "00000000-0000-0000-0000-000000000000",
      "blockedSubType": 0,
      "blockedType": 0,
      "customerId": "00000000-0000-0000-0000-000000000000",
      "description": "description",
      "direction": "direction",
      "id": "00000000-0000-0000-0000-000000000000",
      "isActive": true,
      "unblockedDate": "2024-08-25T15:00:00Z",
      "unblockedReason": "unblockedReason"
    }
  ],
  "total": 0
}

json

application/json

aurax-bff-dynamic-create-customer-blocked-ui-bpmn

POST

https://dg-sandbox.dgpays.com/aurax-bff-service

/customer-blockeds

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Request and response fields are declared on the routing target create-customer-blocked-ui-bpmn; this entry declares none of its own.

aurax-bff-dynamic-create-customer-blocked-ui-bpmn › Request Body

blockedItemId

string · uuid · required

blockedType

integer · int32 · required

customerId

string · uuid · required

description

string · required

object[]

blockedCurrencyNumber

string

blockedDueDate

string · date

direction

string

aurax-bff-dynamic-create-customer-blocked-ui-bpmn › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

POST/customer-blockeds

curl https://dg-sandbox.dgpays.com/aurax-bff-service/customer-blockeds \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "blockedAccounts": [
    {
      "accountId": "",
      "amount": 0,
      "available": 0,
      "blockedSubType": 0
    }
  ],
  "blockedCurrencyNumber": "",
  "blockedDueDate": "",
  "blockedItemId": "",
  "blockedType": 0,
  "customerId": "",
  "description": "",
  "direction": ""
}'

Example Request Body

{
  "blockedAccounts": [
    {
      "accountId": "",
      "amount": 0,
      "available": 0,
      "blockedSubType": 0
    }
  ],
  "blockedCurrencyNumber": "",
  "blockedDueDate": "",
  "blockedItemId": "",
  "blockedType": 0,
  "customerId": "",
  "description": "",
  "direction": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

aurax-bff-dynamic-get-blocked-customer-by-id

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/customer-blockeds/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Request and response fields are declared on the routing target get-blocked-customer-by-id; this entry declares none of its own.

Response body, read from the service source

The route declares its response as CustomerBlockedDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`BlockedItemId`	`Guid`	no
`CustomerId`	`Guid`	no
`BlockedAmount`	`decimal?`	yes
`BlockedCurrencyNumber`	`string`	no
`BlockedType`	`int`	no
`BlockedDate`	`DateOnly`	no
`BlockedDueDate`	`DateOnly?`	yes
`UnblockedDate`	`DateOnly?`	yes
`UnblockedReason`	`string`	no
`IsActive`	`bool`	no
`Direction`	`int`	no
`Description`	`string`	no
`AccountBlockeds`	`List<BlockedAccountItem>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCNT_128`	400	`CUSTOMER_BLOCKED_NOT_FOUND`	Customer blocked not found.

aurax-bff-dynamic-get-blocked-customer-by-id › path Parameters

id

string · uuid · required

aurax-bff-dynamic-get-blocked-customer-by-id › Responses

Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.

object[]

blockedAmount

number · decimal

blockedCurrencyNumber

string

blockedDate

string · date

blockedDueDate

string · date

blockedItemId

string · uuid

blockedType

integer · int32

customerId

string · uuid

description

direction

id

isActive

boolean

unblockedDate

unblockedReason

string

GET/customer-blockeds/{id}

curl https://dg-sandbox.dgpays.com/aurax-bff-service/customer-blockeds/:id

Example Responses

{
  "accountBlockeds": [
    {
      "accountBlockedId": "00000000-0000-0000-0000-000000000000",
      "accountId": "00000000-0000-0000-0000-000000000000",
      "amount": 0,
      "amountBlockedCurrency": {},
      "blockedSubType": 0,
      "exchangeRate": 0
    }
  ],
  "blockedAmount": 0,
  "blockedCurrencyNumber": "blockedCurrencyNumber",
  "blockedDate": "2024-08-25",
  "blockedDueDate": "2024-08-25",
  "blockedItemId": "00000000-0000-0000-0000-000000000000",
  "blockedType": 0,
  "customerId": "00000000-0000-0000-0000-000000000000",
  "description": {},
  "direction": {},
  "id": {},
  "isActive": true,
  "unblockedDate": {},
  "unblockedReason": "unblockedReason"
}

json

application/json

aurax-bff-dynamic-edit-customer-blocked-ui-bpmn

PUT

https://dg-sandbox.dgpays.com/aurax-bff-service

/customer-blockeds/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Request and response fields are declared on the routing target edit-customer-blocked-ui-bpmn; this entry declares none of its own.

aurax-bff-dynamic-edit-customer-blocked-ui-bpmn › path Parameters

id

string · uuid · required

aurax-bff-dynamic-edit-customer-blocked-ui-bpmn › Request Body

blockedType

integer · int32 · required

description

string · required

unblockedReason

string · required

object[]

blockedCurrencyNumber

string

blockedDueDate

string · date

blockedItemId

string · uuid

customerId

string · uuid

direction

string

aurax-bff-dynamic-edit-customer-blocked-ui-bpmn › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

PUT/customer-blockeds/{id}

curl https://dg-sandbox.dgpays.com/aurax-bff-service/customer-blockeds/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "accountBlockeds": [
    {
      "accountBlockedId": "",
      "accountId": "",
      "amount": 0,
      "available": 0,
      "blockedSubType": 0,
      "unBlockAccount": false,
      "unBlockamount": 0
    }
  ],
  "blockedAccounts": [
    {}
  ],
  "blockedCurrencyNumber": "",
  "blockedDueDate": "",
  "blockedItemId": "",
  "blockedType": 0,
  "customerId": "",
  "description": "",
  "direction": "",
  "unblockedReason": ""
}'

Example Request Body

{
  "accountBlockeds": [
    {
      "accountBlockedId": "",
      "accountId": "",
      "amount": 0,
      "available": 0,
      "blockedSubType": 0,
      "unBlockAccount": false,
      "unBlockamount": 0
    }
  ],
  "blockedAccounts": [
    {}
  ],
  "blockedCurrencyNumber": "",
  "blockedDueDate": "",
  "blockedItemId": "",
  "blockedType": 0,
  "customerId": "",
  "description": "",
  "direction": "",
  "unblockedReason": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

customer-applications customer-groups