Tpaga Cashin API 0.0.1¶

This service should be requested only once per user. Typically, you will use this endpoint when the user is created in your system, giving them a lifelong deposit reference. If the given `reference` already existed when calling this service, it will be marked as enabled, regardless its previous state.

Request¶

Body¶

Name	Required	Type	Properties	Description
agreement	No	string		The agreement (code) that the user will have to show to the agent of the tpaga’s Cashin Provider each time that they want to make a deposit.
description	Yes	string		Some details about the permanent deposit reference.
enabled	No	boolean		Tells whether the permanent reference can be used (enabled) or not (disabled).
reference	No	string		The reference (code) that the user will have to show to the agent of the tpaga’s Cashin Provider each time that they want to make a deposit. When making a request, send a 10-chars long string, which may contain both numbers and letters. The output value will be prefixed with a two-chars string which identifies you in tpaga’s system. Therefore, in the provided example, the output will be TSREYSANTANA, where TS is the prefix which represents the (T)e(S)t API user who makes the request. You will have to provide the prefixed reference whenever you want to get details from it or whenever you want to enable/disable it.
requester_document_number	Yes	string		Document number of the user who owns the permanent deposit reference.
requester_document_type	Yes	string	{“enum”: [“CC”, “CE”]}	Document type of the user who owns the permanent deposit reference.
requester_email	Yes	string		Email of the user who owns the permanent deposit reference.
requester_first_names	Yes	string		First names of the user who owns the permanent deposit reference.
requester_last_names	Yes	string		Last names of the user who owns the permanent deposit reference.
requester_phone_number	Yes	string		Phone number of the user who owns the permanent deposit reference.

{
    "agreement": "somestring",
    "description": "somestring",
    "enabled": true,
    "reference": "somestring",
    "requester_document_number": "somestring",
    "requester_document_type": "CC",
    "requester_email": "somestring",
    "requester_first_names": "somestring",
    "requester_last_names": "somestring",
    "requester_phone_number": "somestring"
}

Responses¶

200¶

The permanent deposit reference was created successfully.

Type: PermanentDepositReference

Example:

{
    "agreement": "somestring",
    "description": "somestring",
    "enabled": true,
    "reference": "somestring",
    "requester_document_number": "somestring",
    "requester_document_type": "CC",
    "requester_email": "somestring",
    "requester_first_names": "somestring",
    "requester_last_names": "somestring",
    "requester_phone_number": "somestring"
}

401¶

Unauthorized

422¶

Client errors when making the request.

The payload will have enough info about how to solve the problem in order to re-try the request.

Type: ValidationError

Example:

{
    "error_message": "somestring",
    "field": "somestring",
    "value": "somestring"
}

POST `/references`¶

Summary¶

Create a reference which can be used only once.

Description¶

This service must be requested each time that your user wants to make a deposit. When providing the `amount`, it must be the same as the amount that your user will deposit at one of the kiosks of the **tpaga**'s Cashin Providers. The response of this service includes the `reference` and the `agreement` codes. Both of them will have to be provided by your user at the kiosk.

Request¶

Body¶

Name	Required	Type	Properties	Description
agreement	No	string		The agreement (code) that the user will have to show to the agent of the tpaga’s Cashin Provider whenever they want to make a deposit
amount	No	integer		Amount that the user creating the deposit reference wants to deposit. When this property is provided, the user will have to give that amount of money to the agent of the tpaga’s Cashin Provider.
description	Yes	string		Some details about the deposit intent.
idempotency_token	Yes	string		Idempotency token which identifies the deposit reference uniquely in order not to process the same request twice.
reference	No	string		The reference (code) that the user will have to show to the agent of the tpaga’s Cashin Provider whenever they want to make a deposit. It is a 12-chars string and may contain both number and letters.
requester_document_number	Yes	string		Document number of the user creating the deposit reference.
requester_document_type	Yes	string	{“enum”: [“CC”, “CE”]}	Document type of the user creating the deposit reference.
requester_email	Yes	string		Email of the user creating the deposit reference.
requester_first_names	Yes	string		First names of the user creating the deposit reference.
requester_last_names	Yes	string		Last names of the user creating the deposit reference.
requester_phone_number	Yes	string		Phone number of the user creating the deposit reference.

{
    "agreement": "somestring",
    "amount": 1,
    "description": "somestring",
    "idempotency_token": "somestring",
    "reference": "somestring",
    "requester_document_number": "somestring",
    "requester_document_type": "CC",
    "requester_email": "somestring",
    "requester_first_names": "somestring",
    "requester_last_names": "somestring",
    "requester_phone_number": "somestring"
}

Responses¶

200¶

The deposit reference was created successfully.

Type: DepositReference

Example:

{
    "agreement": "somestring",
    "amount": 1,
    "description": "somestring",
    "idempotency_token": "somestring",
    "reference": "somestring",
    "requester_document_number": "somestring",
    "requester_document_type": "CC",
    "requester_email": "somestring",
    "requester_first_names": "somestring",
    "requester_last_names": "somestring",
    "requester_phone_number": "somestring"
}

401¶

Unauthorized

422¶

Client errors when making the request.

The payload will have enough info about how to solve the problem in order to re-try the request.

Type: ValidationError

Example:

{
    "error_message": "somestring",
    "field": "somestring",
    "value": "somestring"
}

GET REFERENCES¶

GET `/reference-details/`¶

Summary¶

Get details from the deposit intent(s) related to a reference code.

Description¶

This service works for both permanent references and those that are meant to be used only once. When requesting this service with a reference code of unique use, the `deposit_intents` array will have only one item, because of the fact that the reference cannot be used anymore. On the other hand, when you are requesting this service with a permanent reference, then the `deposit_intents` array may contain 0 or more items. 0 means that your user has not made any deposits yet. We will give you a maximum of 20 deposit intents.

At least one of reference or idempotency_token query parameters has to be provided.

We want that all of the deposit intents from your users end up with a paid status. If they don’t, please contact us in order to check what happened.

Parameters¶

Name	Located in	Required	Type	Format	Properties	Description
reference	query	No	string			The reference code that you want get details from. Take into account that at least one of reference or idempotency_token has to be provided.
idempotency_token	query	No	string			The idempotency token of the reference that you want get details from. Take into account that at least one of reference or idempotency_token has to be provided.

Request¶

Responses¶

200¶

Successful operation

Type: DepositReferenceDetails

Example:

{
    "deposit_intents": [
        {
            "agreement": "somestring",
            "amount": 1,
            "description": "somestring",
            "idempotency_token": "somestring",
            "reference": "somestring",
            "requester_document_number": "somestring",
            "requester_document_type": "CC",
            "requester_email": "somestring",
            "requester_first_names": "somestring",
            "requester_last_names": "somestring",
            "requester_phone_number": "somestring",
            "status": "paid"
        },
        {
            "agreement": "somestring",
            "amount": 1,
            "description": "somestring",
            "idempotency_token": "somestring",
            "reference": "somestring",
            "requester_document_number": "somestring",
            "requester_document_type": "CC",
            "requester_email": "somestring",
            "requester_first_names": "somestring",
            "requester_last_names": "somestring",
            "requester_phone_number": "somestring",
            "status": "paid"
        }
    ],
    "enabled": true,
    "is_permanent": true
}

401¶

Unauthorized

422¶

Client errors when making the request.

The payload will have enough info about how to solve the problem in order to re-try the request.

Type: ValidationError

Example:

{
    "error_message": "somestring",
    "field": "somestring",
    "value": "somestring"
}

UPDATE REFERENCES¶

PATCH `/permanent_references/{reference}`¶

Summary¶

Enable / disable the permanent reference.

Description¶

This service enables or disables a permanent reference. Please note that it is **only** available for permanent references.

Parameters¶

Name	Located in	Required	Type	Format	Properties	Description
reference	path	Yes	string			The 12-chars long reference code of the object that you want to enable/disable. Take into account that you must provide the prefixed reference that you receive when creating it.

Request¶

Body¶

Name	Required	Type	Format	Properties	Description
enabled	No	boolean		{“enum”: [True, False]}	Provide false for disabling the reference and true for enabling it.

{
    "enabled": true
}

Responses¶

200¶

The permanent deposit reference was updated successfully.

Type: PermanentDepositReference

Example:

{
    "agreement": "somestring",
    "description": "somestring",
    "enabled": true,
    "reference": "somestring",
    "requester_document_number": "somestring",
    "requester_document_type": "CC",
    "requester_email": "somestring",
    "requester_first_names": "somestring",
    "requester_last_names": "somestring",
    "requester_phone_number": "somestring"
}

401¶

Unauthorized

422¶

Client errors when making the request.

The payload will have enough info about how to solve the problem in order to re-try the request.

Type: ValidationError

Example:

{
    "error_message": "somestring",
    "field": "somestring",
    "value": "somestring"
}

Data Structures¶

DepositIntent Model Structure¶

DepositReference extended inline

Inline schema:

Name	Required	Type	Properties	Description
agreement	No	string		The agreement (code) that the user will have to show to the agent of the tpaga’s Cashin Provider whenever they want to make a deposit
amount	No	integer		Amount that the user creating the deposit reference wants to deposit. When this property is provided, the user will have to give that amount of money to the agent of the tpaga’s Cashin Provider.
description	Yes	string		Some details about the deposit intent.
idempotency_token	Yes	string		Idempotency token which identifies the deposit reference uniquely in order not to process the same request twice.
reference	No	string		The reference (code) that the user will have to show to the agent of the tpaga’s Cashin Provider whenever they want to make a deposit. It is a 12-chars string and may contain both number and letters.
requester_document_number	Yes	string		Document number of the user creating the deposit reference.
requester_document_type	Yes	string	{“enum”: [“CC”, “CE”]}	Document type of the user creating the deposit reference.
requester_email	Yes	string		Email of the user creating the deposit reference.
requester_first_names	Yes	string		First names of the user creating the deposit reference.
requester_last_names	Yes	string		Last names of the user creating the deposit reference.
requester_phone_number	Yes	string		Phone number of the user creating the deposit reference.
status	Yes	string	{“enum”: [“paid”, “pending”]}	The status of the deposit intent from the given reference, after the user has deposited some money in of the kiosks from the tpaga’s Cashin Providers.

DepositReference Model Structure¶

Name	Required	Type	Properties	Description
agreement	No	string		The agreement (code) that the user will have to show to the agent of the tpaga’s Cashin Provider whenever they want to make a deposit
amount	No	integer		Amount that the user creating the deposit reference wants to deposit. When this property is provided, the user will have to give that amount of money to the agent of the tpaga’s Cashin Provider.
description	Yes	string		Some details about the deposit intent.
idempotency_token	Yes	string		Idempotency token which identifies the deposit reference uniquely in order not to process the same request twice.
reference	No	string		The reference (code) that the user will have to show to the agent of the tpaga’s Cashin Provider whenever they want to make a deposit. It is a 12-chars string and may contain both number and letters.
requester_document_number	Yes	string		Document number of the user creating the deposit reference.
requester_document_type	Yes	string	{“enum”: [“CC”, “CE”]}	Document type of the user creating the deposit reference.
requester_email	Yes	string		Email of the user creating the deposit reference.
requester_first_names	Yes	string		First names of the user creating the deposit reference.
requester_last_names	Yes	string		Last names of the user creating the deposit reference.
requester_phone_number	Yes	string		Phone number of the user creating the deposit reference.

DepositReferenceDetails Model Structure¶

Name	Required	Type	Properties	Description
deposit_intents	No	array of DepositReference extended inline		List of deposit intents related to the given reference.
enabled	No	boolean	{“enum”: [True, False]}	Tells whether the reference is enabled or not. Take into account that only permanent refereces can be enabled/disabled.
is_permanent	No	boolean	{“enum”: [True, False]}	Tells whether the reference is permanent or not.

PermanentDepositReference Model Structure¶

Name	Required	Type	Properties	Description
agreement	No	string		The agreement (code) that the user will have to show to the agent of the tpaga’s Cashin Provider each time that they want to make a deposit.
description	Yes	string		Some details about the permanent deposit reference.
enabled	No	boolean		Tells whether the permanent reference can be used (enabled) or not (disabled).
reference	No	string		The reference (code) that the user will have to show to the agent of the tpaga’s Cashin Provider each time that they want to make a deposit. When making a request, send a 10-chars long string, which may contain both numbers and letters. The output value will be prefixed with a two-chars string which identifies you in tpaga’s system. Therefore, in the provided example, the output will be TSREYSANTANA, where TS is the prefix which represents the (T)e(S)t API user who makes the request. You will have to provide the prefixed reference whenever you want to get details from it or whenever you want to enable/disable it.
requester_document_number	Yes	string		Document number of the user who owns the permanent deposit reference.
requester_document_type	Yes	string	{“enum”: [“CC”, “CE”]}	Document type of the user who owns the permanent deposit reference.
requester_email	Yes	string		Email of the user who owns the permanent deposit reference.
requester_first_names	Yes	string		First names of the user who owns the permanent deposit reference.
requester_last_names	Yes	string		Last names of the user who owns the permanent deposit reference.
requester_phone_number	Yes	string		Phone number of the user who owns the permanent deposit reference.

ValidationError Model Structure¶

Name	Required	Type	Description
error_message	Yes	string	Human-friendly description of the error.
field	No	string	Name of the field with the wrong piece of data, if it applies.
value	No	string	value that caused the validation error in the specified field, if it applies

Tpaga Cashin API 0.0.1¶

Description¶

Contact Information¶

License¶

Base URL¶

Security¶

api_key (HTTP Basic Authentication)¶

CREATE REFERENCES¶

POST /permanent_references¶

Summary¶

Description¶

Request¶

Body¶

Responses¶

200¶

401¶

422¶

POST /references¶

Summary¶

Description¶

Request¶

Body¶

Responses¶

200¶

401¶

422¶

GET REFERENCES¶

GET /reference-details/¶

Summary¶

Description¶

Parameters¶

Request¶

Responses¶

200¶

401¶

422¶

UPDATE REFERENCES¶

PATCH /permanent_references/{reference}¶

Summary¶

Description¶

Parameters¶

Request¶

Body¶

Responses¶

200¶

401¶

422¶

Data Structures¶

DepositIntent Model Structure¶

DepositReference Model Structure¶

DepositReferenceDetails Model Structure¶

PermanentDepositReference Model Structure¶

ValidationError Model Structure¶

POST `/permanent_references`¶

POST `/references`¶

GET `/reference-details/`¶

PATCH `/permanent_references/{reference}`¶