customers

Operations addressed under /customers — 17 operations.

aurax-bnpl-bff-get-bnpl-virtual-card-by-customer-id

GET

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

/api/customers/bnpl-virtual-cards

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

Read from the caller's token, not from the request: customerId.

aurax-bnpl-bff-get-bnpl-virtual-card-by-customer-id › Responses

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

No data returned

aurax-bnpl-bff-get-bnpl-virtual-card-by-token

GET

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

/api/customers/bnpl-virtual-cards/by-card-token/{cardToken}

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-bnpl-virtual-card-by-token; this entry declares none of its own.

aurax-bnpl-bff-get-bnpl-virtual-card-by-token › path Parameters

cardToken

string · required

aurax-bnpl-bff-get-bnpl-virtual-card-by-token › 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.

cardToken

string

customerId

string · uuid

encryptedCardNumber

string

encryptedCvv

string

expiryDate

string

id

string · uuid

maskedCardNumber

string

status

integer · enum · int32

Permitted values (8):

1 — N (en: N; tr: N; ar: ن)
2 — T (en: T; tr: T; ar: ت)
3 — L (en: L; tr: L; ar: ل)
4 — S (en: S; tr: S; ar: س)
5 — C (en: C; tr: C; ar: ج)
6 — F (en: F; tr: F; ar: ف)
7 — D (en: D; tr: D; ar: د)
8 — B (en: B; tr: B; ar: ب)

Enum values:

aurax-bnpl-bff-dynamic-update-bnpl-virtual-card-by-token

PUT

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

/api/customers/bnpl-virtual-cards/by-card-token/{cardToken}

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 update-bnpl-virtual-card-by-token; this entry declares none of its own.

aurax-bnpl-bff-dynamic-update-bnpl-virtual-card-by-token › path Parameters

cardToken

string · required

aurax-bnpl-bff-dynamic-update-bnpl-virtual-card-by-token › Request Body

status

string · required

aurax-bnpl-bff-dynamic-update-bnpl-virtual-card-by-token › Responses

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

No data returned

aurax-bnpl-bff-service-dynamic-is-customer-exist-by-citizen-id

GET

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

/api/customers/by-citizenid/exist

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 is-customer-exist-by-citizen-id; this entry declares none of its own.

Declared as Route-bound but absent from the route template, so not sendable: citizenid, customerType.

aurax-bnpl-bff-service-dynamic-is-customer-exist-by-citizen-id › Responses

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

No data returned

aurax-bnpl-bff-dynamic-get-customer-information-by-citizen-id

GET

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

/api/customers/by-citizenid/{citizenId}/information

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-information-by-citizen-id; this entry declares none of its own.

aurax-bnpl-bff-dynamic-get-customer-information-by-citizen-id › path Parameters

citizenId

string · required

aurax-bnpl-bff-dynamic-get-customer-information-by-citizen-id › Responses

object

birthDate

string · date

birthPlace

string

citizenId

string

citizenIdType

string

object

customerId

string · uuid

customerNumber

string

customerType

string

emails

string

fullName

string

genderName

string

isActive

boolean

loans

string

maritalStatus

string

motherMaidenSurname

string

phones

string

GET/api/customers/by-citizenid/{citizenId}/information

curl https://dg-sandbox.dgpays.com/aurax-bnpl-bff-service/api/customers/by-citizenid/:citizenId/information

Example Responses

{
  "addresses": {
    "addressName": "addressName",
    "addressType": "addressType",
    "isDefault": true
  },
  "birthDate": "2024-08-25",
  "birthPlace": "birthPlace",
  "citizenId": "citizenId",
  "citizenIdType": "citizenIdType",
  "consents": {
    "consentItemCode": "consentItemCode",
    "consentItemDescription": "consentItemDescription",
    "consentItemIsActive": true,
    "consentItemName": "consentItemName",
    "contactPoint": "contactPoint",
    "context": "context",
    "isActive": true,
    "isApproved": true,
    "transactionType": "transactionType"
  },
  "customerId": "00000000-0000-0000-0000-000000000000",
  "customerNumber": "customerNumber",
  "customerType": "customerType",
  "emails": "emails",
  "fullName": "fullName",
  "genderName": "genderName",
  "isActive": true,
  "loans": "loans",
  "maritalStatus": "maritalStatus",
  "motherMaidenSurname": "motherMaidenSurname",
  "phones": "phones"
}

json

application/json

aurax-bnpl-bff-service-dynamic-create-customer-and-available-limit

POST

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

/api/customers/by-citizenid/{citizenid}/available-limit

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-and-available-limit; this entry declares none of its own.

Response body, read from the service source

The route declares its response as CustomerAndAvailableLimitDto.

Field	Declared type	Nullable
`availableLimit`	`AvailableLimitDto`	no

Member names are the service's declaration names.

aurax-bnpl-bff-service-dynamic-create-customer-and-available-limit › path Parameters

citizenid

string · required

aurax-bnpl-bff-service-dynamic-create-customer-and-available-limit › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

aurax-bnpl-bff-service-dynamic-get-customer-number-by-citizenid

GET

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

/api/customers/by-citizenid/{citizenid}/customernumber

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-number-by-citizenid; this entry declares none of its own.

aurax-bnpl-bff-service-dynamic-get-customer-number-by-citizenid › path Parameters

citizenid

string · required

aurax-bnpl-bff-service-dynamic-get-customer-number-by-citizenid › Responses

object[]

customerNumber

string

customerSubType

integer · int32

customerType

integer · int32

id

string · uuid

isCustomer

boolean

isDefault

boolean

aurax-bnpl-bff-redirect-get-customer-summary-by-id

GET

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

/api/customers/summary

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

Read from the caller's token, not from the request: id.

aurax-bnpl-bff-redirect-get-customer-summary-by-id › Responses

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

No data returned

aurax-bnpl-bff-service-dynamic-create-verified-customer-bpm-bff

POST

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

/api/customers/verified/create

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-verified-customer-bff; this entry declares none of its own.

Response body, read from the service source

The route declares its response as CreateVerifiedCustomerDto.

Field	Declared type	Nullable
`CustomerId`	`Guid`	no
`CustomerNumber`	`string`	no

Member names are the service's declaration names.

aurax-bnpl-bff-service-dynamic-create-verified-customer-bpm-bff › Headers

partnerCode

string

aurax-bnpl-bff-service-dynamic-create-verified-customer-bpm-bff › Request Body

citizenid

string · required

customerSubType

integer · int32 · required

object[] · required

phoneNumber

string · required

object[]

email

string

kycStatus

integer · int32

object[]

workingType

integer · int32

aurax-bnpl-bff-service-dynamic-create-verified-customer-bpm-bff › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

POST/api/customers/verified/create

curl https://dg-sandbox.dgpays.com/aurax-bnpl-bff-service/api/customers/verified/create \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "citizenid": "",
  "consents": [
    {}
  ],
  "customerSubType": 0,
  "email": "",
  "incomes": [
    {
      "currencyNumber": "",
      "estimatedTransactionVolume": 0,
      "monthlyAmount": 0,
      "sourceOfIncome": 0,
      "transactionCount": 0
    }
  ],
  "kycStatus": 0,
  "occupations": [
    {}
  ],
  "phoneNumber": "",
  "workingType": 0
}'

Example Request Body

{
  "citizenid": "",
  "consents": [
    {}
  ],
  "customerSubType": 0,
  "email": "",
  "incomes": [
    {
      "currencyNumber": "",
      "estimatedTransactionVolume": 0,
      "monthlyAmount": 0,
      "sourceOfIncome": 0,
      "transactionCount": 0
    }
  ],
  "kycStatus": 0,
  "occupations": [
    {}
  ],
  "phoneNumber": "",
  "workingType": 0
}

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-bnpl-bff-redirect-aml-control

POST

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

/customers/aml-control

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 aml-control; this entry declares none of its own.

Response body, read from the service source

The route returns int, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON number, a 32-bit integer. This is a complete answer read from the declaration, not a gap.

aurax-bnpl-bff-redirect-aml-control › Request Body

citizenid

string · required

aurax-bnpl-bff-redirect-aml-control › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.

No data returned

aurax-bff-redirect-get-bnpl-virtual-iban-list

GET

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

/customers/bnpl-virtual-ibans

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-bnpl-virtual-iban-list; this entry declares none of its own.

aurax-bff-redirect-get-bnpl-virtual-iban-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

aurax-bff-redirect-get-bnpl-virtual-iban-list › 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.

closeDate

string · date

customerId

string · uuid

fec

integer · int32

id

string · uuid

virtualIban

string

aurax-bnpl-bff-redirect-is-customer-exist-by-citizen-id

GET

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

/customers/by-citizenid/exist

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

aurax-bnpl-bff-redirect-is-customer-exist-by-citizen-id › Responses

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

No data returned

aurax-bnpl-bff-get-customer-by-id

GET

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

/customers/by-customer-id

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

Read from the caller's token, not from the request: id.

Response body, read from the service source

The route declares its response as CustomerDetailDto.

Field	Declared type	Nullable
`Occupation`	`OccupationItemUI`	no
`Addresses`	`List<AddressItem>` (collection)	no
`AddressesUI`	`List<AddressItemUI>` (collection)	no
`IdentitiesUI`	`List<IdentitiyUI>` (collection)	no
`Emails`	`List<EmailAddressItem>` (collection)	no
`Identities`	`List<IdentityCardItem>` (collection)	no
`Nationalities`	`List<NationalityItem>` (collection)	no
`Occupations`	`List<OccupationItem>` (collection)	no
`Phones`	`List<PhoneItem>` (collection)	no
`Residentials`	`List<ResidentialItem>` (collection)	no
`ConsentItemIds`	`List<Guid>` (collection)	no

Member names are the service's declaration names.

aurax-bnpl-bff-get-customer-by-id › Responses

No data returned

aurax-bnpl-bff-redirect-decrypt-customer-data

GET

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

/customers/decrypt

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 decrypt-customer-data; this entry declares none of its own.

aurax-bnpl-bff-redirect-decrypt-customer-data › query Parameters

encryptedValue

string · required

aurax-bnpl-bff-redirect-decrypt-customer-data › Responses

customerValue

string

aurax-bnpl-bff-redirect-create-verified-customer-bnpl-bpm

POST

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

/customers/verified-customer

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

aurax-bnpl-bff-redirect-create-verified-customer-bnpl-bpm › Responses

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

No data returned

aurax-bnpl-bff-redirect-verify-customer-bpm

POST

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

/customers/verify

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

Response body, read from the service source

The route declares its response as VerifyCustomerDto.

Field	Declared type	Nullable
`VerifyResult`	`bool`	no
`AmlVerifyResult`	`bool`	no
`ReferenceId`	`Guid`	no
`MatchStatusId`	`int`	no
`Citizenid`	`string`	no
`BirthDate`	`DateOnly?`	yes
`AddressType`	`int?`	yes
`AddressSource`	`int?`	yes
`AddressOpenText`	`string`	no
`ForeignAddress`	`string`	no
`CountryId`	`int?`	yes
`Country`	`string`	no
`RegionCode`	`string`	no
`Region`	`string`	no
`CityCode`	`string`	no
`City`	`string`	no
`DistrictCode`	`string`	no
`District`	`string`	no
`NeihgbourhoodCode`	`string`	no
`Neihgbourhood`	`string`	no
`StreetCode`	`string`	no
`Street`	`string`	no
`BuildingCode`	`string`	no
`Building`	`string`	no
`SectionCode`	`string`	no
`Section`	`string`	no
`AddressNumber`	`string`	no
`CreatedDate`	`DateTime`	no
`RegistrationType`	`int?`	yes
`Name`	`string`	no
`Surname`	`string`	no
`MotherName`	`string`	no
`FatherName`	`string`	no
`Gender`	`int?`	yes
`MaritalStatus`	`int?`	yes
`PreviousSurname`	`string`	no
`BirthPlace`	`string`	no
`MotherCitizenid`	`string`	no
`FatherCitizenid`	`string`	no
`SpouseCitizenid`	`string`	no
`Status`	`int?`	yes
`PreviousCitizenid`	`string`	no
`DeathDate`	`DateOnly?`	yes
`Nationality`	`int?`	yes
`IdentityCardType`	`int?`	yes
`IsTemporary`	`bool?`	yes
`RegistrationNumber`	`string`	no
`SerialNumber`	`string`	no
`IssueReason`	`string`	no
`IssueDate`	`DateOnly?`	yes
`IssueOffice`	`string`	no
`ValidityDate`	`DateOnly?`	yes
`ForeignPermissionStartDate`	`DateOnly?`	yes
`ForeignPermissionEndDate`	`DateOnly?`	yes
`ForeignPermissionNumber`	`string`	no
`ForeignPermissionCity`	`string`	no
`Unit`	`string`	no
`FamilyRecordNo`	`string`	no
`PersonRecordNo`	`string`	no
`Binder`	`string`	no
`RegisterCity`	`string`	no
`RegisterDistrict`	`string`	no
`HasGuardian`	`bool?`	yes
`GuardianshipType`	`int?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_BNPL_4`	400	`CITIZEN_NOT_FOUND`	not published in this snapshot
`ERR_BNPL_6`	400	`BIRTHDATE_MUST_NOT_EMPTY`	not published in this snapshot
`ERR_BNPL_7`	400	`PHONE_NUMBER_IN_USE`	not published in this snapshot
`ERR_BPMCUS_18`	400	—	not published in this snapshot
`ERR_BPMCUS_20`	400	—	Otp verification failed
`ERR_BPMCUS_21`	400	—	not published in this snapshot
`ERR_BPMCUS_22`	400	—	not published in this snapshot
`ERR_BPM_106`	400	—	not published in this snapshot

aurax-bnpl-bff-redirect-verify-customer-bpm › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

aurax-bnpl-bff-redirect-get-bnpl-virtual-iban-by-customer-id

GET

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

/customers/{id}/bnpl-virtual-ibans

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

Read from the caller's token, not from the request: id.

aurax-bnpl-bff-redirect-get-bnpl-virtual-iban-by-customer-id › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bnpl-bff-redirect-get-bnpl-virtual-iban-by-customer-id › Responses

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

No data returned

customer-verify deneme-from-bpm-to-bnpl-bpmn