Credit Accounts API

This API allows managing Credit Accounts in the system. It provides endpoints to retrieve, update, and manage reservations in customers' credit accounts.

The Credit Account Object

The Credit Account object represents a credit account associated with a customer and a specific product type.

{
    "clientId": "e732bc5f-5b84-4a0a-81b4-5354d4625a8b",
    "partnerId": "6457c3ce-3887-45d6-92ca-299219ea96db",
    "creditLine": {
        "assigned": {
            "amount": "100000.00",
            "currency": "ARS",
            "display": "$100,000.00"
        },
        "available": {
            "amount": "90000.00",
            "currency": "ARS",
            "display": "$90,000.00"
        },
        "consumed": {
            "amount": "10000.00",
            "currency": "ARS",
            "display": "$10,000.00"
        },
        "reservations": [
            {
                "productFamily": "bnpl",
                "sourceId": "a3a424c6-e34c-4519-933a-7e44fb016c40",
                "sourceType": "flow",
                "amount": {
                    "amount": "10000.00",
                    "currency": "ARS"
                },
                "status": "confirmed",
                "createdAt": "2021-01-01T00:00:00Z"
            }
        ]
    },
    "productFamily": "bnpl",
    "status": "enabled",
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z"
}

Attributes

Attribute	Description	Type
`clientId`	ID of the customer associated with the account	String (UUID)
`partnerId`	ID of the partner associated with the account	String (UUID)
`creditLine`	Details of the credit line	Object
`productFamily`	Type of financial product	String
`status`	Status of the credit account	String
`createdAt`	Date and time of account creation	String (ISO 8601)
`updatedAt`	Date and time of last account update	String (ISO 8601)

The Credit Line Details Object

The Credit Line Details object provides detailed information about a credit line of an account.

{
    "assigned": {
        "amount": "100000.00",
        "currency": "ARS",
        "display": "$100,000.00"
    },
    "available": {
        "amount": "90000.00",
        "currency": "ARS",
        "display": "$90,000.00"
    },
    "consumed": {
        "amount": "10000.00",
        "currency": "ARS",
        "display": "$10,000.00"
    },
    "reservations": [
        {
            "productFamily": "bnpl",
            "sourceId": "a3a424c6-e34c-4519-933a-7e44fb016c40",
            "sourceType": "flow",
            "amount": {
                "amount": "10000.00",
                "currency": "ARS"
            },
            "status": "confirmed",
            "createdAt": "2021-01-01T00:00:00Z"
        }
    ]
}

Attributes

Attribute	Description	Type
`assigned`	Total amount assigned to the credit line	Object (Money)
`available`	Available amount in the credit line	Object (Money)
`consumed`	Consumed amount of the credit line	Object (Money)
`reservations`	List of reservations in the credit line	Array of Object

The Reservation Object

The Reservation object represents a credit reservation in an account.

{
    "productFamily": "bnpl",
    "sourceId": "a3a424c6-e34c-4519-933a-7e44fb016c40",
    "sourceType": "flow",
    "amount": {
        "amount": "10000.00",
        "currency": "ARS"
    },
    "status": "confirmed",
    "createdAt": "2021-01-01T00:00:00Z"
}

Attributes

Attribute	Description	Type
`productFamily`	Type of financial product	String
`sourceId`	ID of the reservation source	String (UUID)
`sourceType`	Type of reservation source	String
`amount`	Amount of the reservation	Object (Money)
`status`	Status of the reservation	String
`createdAt`	Date and time of reservation creation	String (ISO 8601)

Endpoints

Get a Customer's Credit Account

Retrieves the credit account information of a customer for a specific product type.

GET /v2/clients/:client_id/credit-accounts/:product_family

Path Parameters:

Parameter	Description
`client_id`	Customer ID
`product_family`	Type of financial product

Query Parameters:

Parameter	Description	Type	Required
`include`	Additional fields to include	String	No

Successful Response:

The response will be a Credit Account object.

List Credit Accounts of Multiple Customers

Retrieves the credit account information of different customers for a specific product type.

GET /v2/clients/credit-accounts/:product_family

Path Parameters:

Parameter	Description
`product_family`	Type of financial product

Query Parameters:

Parameter	Description	Type
`include`	Additional fields to include (history or reservations)	String
`partner`	Filter by partner ID	String
`status`	Filter by customer status	String
`sort-by`	Field to sort by	String
`sort-direction`	Sorting direction (asc or desc)	String
`page`	Page number	Integer
`per-page`	Items per page	Integer

Successful Response:

The response will be a list of Credit Account.

Update a Customer's Credit Account

Updates the assigned credit line for a customer for a specific product type.

PATCH /v2/clients/:client_id/credit-accounts/:product_family

Path Parameters:

Parameter	Description
`client_id`	Customer ID
`product_family`	Type of financial product

Request Body:

{
    "assigned": {
        "amount": "150000.00",
        "currency": "ARS"
    },
    "reason": "Increase due to good behaviour"
}

Input Parameters:

Parameter	Description	Type	Required
`assigned`	New assigned amount	Object (Money)	Yes
`reason`	Reason for the credit line change	String	No

Successful Response:

The response will be the updated Credit Account object.

List Reservations of a Credit Account

Retrieves a list of reservations in a customer's credit account.

GET /v2/clients/:client_id/credit-accounts/:product_family/reservations

Path Parameters:

Parameter	Description
`client_id`	Customer ID
`product_family`	Type of financial product

Successful Response:

[
    {
        "productFamily": "bnpl",
        "sourceId": "a3a424c6-e34c-4519-933a-7e44fb016c40",
        "sourceType": "flow",
        "amount": {
            "amount": "10000.00",
            "currency": "ARS"
        },
        "status": "confirmed",
        "createdAt": "2021-01-01T00:00:00Z"
    }
]

Add a Reservation to a Credit Account

Adds a new reservation to a customer's credit account.

POST /v2/clients/:client_id/credit-accounts/:product_family/reservations

Path Parameters:

Parameter	Description
`client_id`	Customer ID
`product_family`	Type of financial product

Request Body:

{
    "amount": {
        "amount": "5000.00",
        "currency": "ARS"
    },
    "sourceType": "flow",
    "sourceId": "b4b424c6-e34c-4519-933a-7e44fb016c41"
}

Input Parameters:

Parameter	Description	Type	Required
`amount`	Amount of the reservation	Object (Money)	Yes
`sourceType`	Type of reservation source	String	Yes
`sourceId`	ID of the reservation source	String (UUID)	Yes

Successful Response:

Status code 204 (No Content) if the reservation was successfully added.

Delete a Reservation from a Credit Account

Deletes an existing reservation from a customer's credit account.

DELETE /v2/clients/:client_id/credit-accounts/:product_family/reservations/:source_id

Path Parameters:

Parameter	Description
`client_id`	Customer ID
`product_family`	Type of financial product
`source_id`	ID of the reservation source

Successful Response:

Status code 204 (No Content) if the reservation was successfully deleted.

Update a Reservation in a Credit Account

Updates an existing reservation in a customer's credit account.

PUT /v2/clients/:client_id/credit-accounts/:product_family/reservations/:source_id

Path Parameters:

Parameter	Description
`client_id`	Customer ID
`product_family`	Type of financial product
`source_id`	ID of the reservation source

Request Body:

{
    "amount": {
        "amount": "7500.00",
        "currency": "ARS"
    },
    "sourceType": "flow"
}

Input Parameters:

Parameter	Description	Type	Required
`amount`	New amount of the reservation	Object (Money)	Yes
`sourceType`	Type of reservation source	String	Yes

Successful Response:

Status code 204 (No Content) if the reservation was successfully updated.

Confirm a Reservation in a Credit Account

Confirms a pending reservation in a customer's credit account.

PUT /v2/clients/:client_id/credit-accounts/:product_family/reservations/:source_id/commit

Path Parameters:

Parameter	Description
`client_id`	Customer ID
`product_family`	Type of financial product
`source_id`	ID of the reservation source

Successful Response:

Status code 204 (No Content) if the reservation was successfully confirmed.

Error Handling

The API may return the following error codes:

Code	Description
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Errors will include a descriptive message in the response body.

On this page