Create credit account

post

http://<host-url>/account

Creates a credit account record in Banking.Live and PayCredit. When repayment_type_id is F or T, provide repayment_fixed_amount as the base fixed repayment amount.

Body Params

ac_bill_ccy

string

required

Billing currency (Three digit ISO_4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).

ac_ext_ref

string

length between 0 and 50

Optional client provided reference

ac_parent_id

int64

required

Parent account identifier provided by Paymentology. Can be used to create parent child hierarchy. Discuss with Paymentology.

ac_set_ccy

string

required

Settlement currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).

account_name

string

required

Credit account holder name

balance_limit

number

The credit limit for the account

customer_id

int64

required

Customer identifier returned during customer creation process

delinquency_config_id

int32

≥ 1

Optional delinquency configuration identifier.

product_id

int32

required

Credit product identifier

repayment_fixed_amount

number

Fixed repayment amount used when repayment_type_id is F or T.

repayment_type_id

string

enum

[CFHOT]

Repayment type: C - Calculated minimum, F - Fixed amount, H - Higher of product minimum or calculated, O - Outstanding balance, T - Fixed amount plus total interest and total fees.

Allowed:

statement_cycle_parameter

int32

≥ 1

Optional override of Product default. Sets Statement Day for the account, the day in month when Statement is released, e.g. 5th of month. Accepted values 1-28.

Headers

unique-request-id

string

Unique identifier of a request.

Responses

400

Validation error/Bad Request

500

Server Error

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Account created in Banking.Live; PayCredit creation queued

201Accounts were successfully created