Scenario 2. Purchase with payment instructions

When performing a purchase, the customer follows the payment instructions displayed on the checkout page or in your system (when performing the purchase by using Gate).

Countries and regions Argentina
Payment currencies ARS
Payment amount limits Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time Contact your key account manager at Monetix for details.
Currency conversion On the Monetix side
Refund
Onboarding and access fee Contact your key account manager at Monetix for details.
Special considerations

If the customer enters an amount which is different from the amount specified in the purchase request, the purchase will be assigned an intermediate status until the conflict is resolved manually by the Monetix technical support.

Operations support

Interfaces
Payment Page Gate Dashboard
Purchase

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section, and then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Purchase by using Gate

General information

To perform a purchase by using Gate with the Bank transfers in Argentina payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Show the screen with payment instructions to the customer.
  3. Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the Bank transfers in Argentina payment method.

Figure 1. Purchase processing flow when performing a purchase by using Gate
  1. The customer initiates a purchase in your system.
  2. Your system sends the purchase request to the Monetix payment platform.
  3. The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
  4. The payment platform processes the request and forwards it to the provider service.
  5. The provider service generates the payment instructions to show to the customer and sends them to the payment platform.
  6. The payment platform forwards the instructions to your system in the display_data array.
  7. Your system displays the payment instructions to the customer.
  8. The customer completes the purchase.
  9. The provider service informs the payment platform about the purchase result.
  10. The payment platform sends the callback with the payment result to your system.
  11. Your system sends the payment result to the customer.

Request

This section provides the instructions on how to build the request for purchase with the Bank transfers in Argentina payment method.

HTTP request method POST
Request body format JSON
API endpoint/v2/payment/bank-transfer/argentina/sale
Full API endpoint specification /v2/payment/bank-transfer/{payment_method}/sale
Table 1. Basic parameters of a purchase request

strictly required—the parameter must be in the initial request.

required—the parameter is required for purchase processing but using it in the initial request is optional. If you omit this parameter from the request, the payment platform will request the parameter by sending your system a callback with the list of all the missing parameters you are required to submit. For more information on how to act in such cases, see Submission of additional payment information.
ObjectObject/Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

identify
object
required

doc_number
string
required

Argentinean tax identifier of the customer, 11 digits without dashes.

Example: 12345678901

doc_type
string
required

Type of the customer tax identifier.

Possible values:

  • CUIT—Clave única de identificación tributaria-unique taxpayer number
  • CUIL—Clave unica de identificacion laboral—unique labor identification number

Example: CUIT

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: ARS

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 10,000.00 ARS must be sent as 1000000

You can also add any other optional parameters to the purchase request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a purchase with the Bank transfers in Argentina payment method:

Figure 2. Example of the purchase request body
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com",
        "identify": {
            "doc_number": "12345678901",
            "doc_type": "CUIT"
        }
    },
    "payment": {
        "currency": "ARS",
        "amount": 1000000
    }
}

Displaying the payment instructions to the customer

After receiving and processing your purchase request, the payment platform sends you the callback with the data for displaying the payment instructions to the customer.

Use the data from the display_data array to display the payment instructions to the customer.

Table 2. Description of the display_data array
Element Description 
{
	"type": "add_info",
	"title": "amount",
	"data": "4000000"
}
 Purchase amount in minor currency units.

Sometimes it is impossible to perform purchase for the amount specified in the request due to technical issues on the provider side. In such cases, the Monetix payment platform can send you several available amounts in the display_data array instead of declining the payment. The available amounts are separated by a semicolon.

{
	"type": "add_info",
	"title": "amount",
	"data": "4000100;3999900"
}

To enable this behavior, refer to your key account manager at Monetix.

This element is always presented in display_data array.

Example: 4000000

 
{
	"type": "add_info",
	"title": "currency",
	"data": "ARS"
}
 Code of the payment currency in the ISO-4217 alpha-3 format.

This element is always presented in display_data array.

Example: ARS

 
{
	"type": "add_info",
	"title": "bank_name",
	"data": "MercadoPago"
}
 Name of the payment recipient's bank.

This element is always presented in display_data array.

Example: MercadoPago

 
{
	"type": "add_info",
	"title": "receiver_name",
	"data": "John Doe"
}
 Full name of the payment recipient.

This element is always presented in display_data array.

Example: John Doe

 
{
	"type": "add_info",
	"title": "receiver_account",
	"data": "1234567887654321"
}
 Account number of the payment recipient.

This element is always presented in display_data array.

Example: 1234567887654321

 
{
	"type": "add_info",
	"title": "lifetime",
	"data": "899"
}
 Payment details expiration time in seconds.

This element is always presented in display_data array.

Example: 899

 
{
	"type": "add_info",
	"title": "alias",
	"data": "MiCuentaBancaria"
}
 The letter code used in the Argentine banking system to identify an account instead of an account number (Alias CBU or Alias CVU).

This element may be not presented in display_data array.

Example: MiCuentaBancaria

Here is an example of the callback snippet with the data for displaying the payment instructions to the customer.

"display_data": [
	{
		"type": "add_info",
		"title": "amount",
		"data": "4000000"
	},
	{
		"type": "add_info",
		"title": "currency",
		"data": "ARS"
	},
	{
		"type": "add_info",
		"title": "bank_name",
		"data": "MercadoPago"
	},
	{
		"type": "add_info",
		"title": "receiver_name",
		"data": "John Doe"
	},
	{
		"type": "add_info",
		"title": "receiver_account",
		"data": "1234567887654321"
	},
	{
		"type": "add_info",
		"title": "lifetime",
		"data": "899"
	},
	{
		"type": "add_info",
		"title": "alias",
		"data": "MiCuentaBancaria"
	}
]

Callback

In the Bank transfers in Argentina payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed purchase.

Figure 3. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "argentina",
        "sum": {
            "amount": 1000000,
            "currency": "ARS"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 1000000,
            "currency": "ARS"
        },
        "sum_converted": {
            "amount": 1000000,
            "currency": "ARS"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 4. Example of the data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "argentina",
        "sum": {
            "amount": 1000000,
            "currency": "ARS"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 1000000,
            "currency": "ARS"
        },
        "sum_converted": {
            "amount": 1000000,
            "currency": "ARS"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics