AstroPay

Overview

Introduction

AstroPay is a payment method which allows to process payments in different countries by using e-wallets of the AstroPay service. This method supports purchases and payouts. In addition, by using the AstroPay service, payouts can be made to AstroPay and PIX accounts.

Additionally, while working with the AstroPay method, it is possible to configure the display of a separate button on Payment Page for purchases via the PIX service, which is built-in into the AstroPay service. The PIX service is available only in Brazil. Refer to your ecommpay key account manager for more information.

This article provides information about working with the AstroPay method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Payment method type digital wallet payments
Payment instruments digital wallets
Countries and regions most countries in the world
Payment currencies most currencies in the world
Currency conversion on the ecommpay side
One-time purchases +
Credential-on-file purchases –
Full refunds –
Partial refunds –
Payouts +
Chargebacks –
Notes payouts can be made to AstroPay and PIX accounts
Onboarding and access fee refer to your ecommpay account manager

Interaction diagram

Payment processing by using the AstroPay method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the AstroPay service.

Operations support

Various platform interfaces can be used to process payments and perform operations using the AstroPay method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), payouts—by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

When working with the AstroPay the following amount limits are applicable.

Times ¹
base threshold
Purchases 2 minutes 25 hours
Payouts within 1 minute 25 hours
Note:
  1. The base and threshold times are defined as follows:
    • The base time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the web service. The base time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from the customer is required). Use the base time to estimate when to react to the absence of payment result callbacks or when to check payment status (details).
    • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the web service receives the callback with the payment result. A payment is automatically assigned the decline status if it wasn't processed within the threshold time. For individual customisation of the threshold time limit, contact ecommpay technical support.

Processing scenarios

To perform a purchase by using the AstroPay method, you need to redirect customer to the AstroPay service, while to initiate a payout, you need to notify the customer via the web service.

Figure 1. Purchase by using Payment Page
Figure 2. Purchase by using Gate
Figure 3. Payout by using Gate

Scenarios for performing operations via the main interfaces of the payment platform correspond to those presented in the diagrams. Similarly, when additional features (such as payment links) are used, scenarios for performing operations also correspond to the specifics of those features.

Purchases by using Payment Page

General information

To process a purchase through Payment Page by using the AstroPay method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.

Figure 4. Purchase processing by using Payment Page: step-by-step description
  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the AstroPay method.
  8. The payment platform receives the request for processing the payment by using the AstroPay method.
  9. The payment platform processes the request and sends it to the AstroPay service.
  10. The request is processed on the AstroPay service side.
  11. The data for redirecting the customer to the AstroPay service is sent from the AstroPay service to the payment platform.
  12. The data for redirecting the customer is sent from the payment platform to Payment Page.
  13. The customer is redirected to the AstroPay service.
  14. The customer completes all required payment steps. If the customer does not have sufficient funds on the AstroPay account, the customer can deposit the needed amount using the methods offered in the AstroPay service.
  15. The purchase is processed on the in the AstroPay service.
  16. The result information is displayed to the customer in the AstroPay service.
  17. The customer is redirected to Payment Page.
  18. The AstroPay service sends a notification about the result to the payment platform.
  19. The payment platform sends the payment result callback to the web service.
  20. The payment platform sends the result information to Payment Page.
  21. The result information is displayed to the customer on Payment Page.
Warning: It is important to take into account that when working with the AstroPay method, among the method selection buttons on Payment Page, the PIX button can be displayed for processing a purchase by using the PIX service (available only in Brazil). If Brazil is not specified as the customer country in the request parameters, and the customer clicked the PIX button, then such a payment is declined.

Information about the formats of requests and callbacks used for processing payments by using the AstroPay method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the AstroPay method:

  1. The following parameters required for any payment must be specified:
    • project_id—project identifier obtained from ecommpay during integration
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project
  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. Additionally, it is necessary to specify the customer country code in accordance with ISO 3166-1 alpha-2 in the customer_country parameter.
  4. If you need to have the payment form displayed with the AstroPay method selected, set the force_payment_method parameter to astropay.
  5. If you need to have the payment form displayed with the PIX via AstroPay method selected, set the force_payment_method parameter to astropay and specify the "{\"submethod_code\": \"IX\}" value in the payment_methods_options parameter:
    "payment_methods_options": "{\"submethod_code\": \"IX\"}"

    In this case, the value BR must be specified in the customer_country parameter, otherwise the payment is declined.

  6. Additionally, any other parameters available for working with Payment Page can be used (details).
  7. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the AstroPay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and country code, as well as signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "BRL",
   "customer_id": "customer1",
   "customer_country": "BR",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}
Figure 5. Example of sufficient data in a purchase request
{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "BRL",
   "customer_id": "customer1",
   "customer_country": "BR",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The AstroPay method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with information about a 2.00 USD purchase made in the 8181 project.

Figure 6. Example of callback data indicating that the purchase has been processed
{
        "provider_extra_fields": {
            "account_id": "ETlGnD42Pdhx"
        },
        "customer": {
            "id": "test-user123"
        },
        "project_id": 8181,
        "payment": {
            "id": "EPaffa-8a12",
            "type": "purchase",
            "status": "success",
            "date": "2023-06-23T08:14:20+0000",
            "method": "astropay",
            "sum": {
                "amount": 200,
                "currency": "USD"
            },
            "description": ""
        },
        "operation": {
            "id": 308,
            "type": "sale",
            "status": "success",
            "date": "2023-06-23T08:14:20+0000",
            "created_date": "2023-06-23T08:13:09+0000",
            "request_id": "ae236fbaaf62b18f66b70461f5d7-00000001",
            "sum_initial": {
                "amount": 200,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 200,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 20852,
                "payment_id": "NWsZT1GCMPeUSs5IclfIyoWgFs3UtCp7ydav9yb",
                "auth_code": ""
            }
        },
        "signature": "SxLFUcKLROs+lOPKKi4cDfnYjwMHSDgqeD+Jt1LYOg=="
    }

The following is the example of a callback with information about a declined purchase.

Figure 7. Example of callback data indicating that the purchase has been declined
{
        "customer": {
            "id": "test-user123"
        },
        "project_id": 8181,
        "payment": {
            "id": "EP7952-f1b2",
            "type": "purchase",
            "status": "decline",
            "date": "2023-06-23T08:18:54+0000",
            "method": "astropay",
            "sum": {
                "amount": 200,
                "currency": "USD"
            },
            "description": ""
        },
        "operation": {
            "id": 309,
            "type": "sale",
            "status": "decline",
            "date": "2023-06-23T08:18:54+0000",
            "created_date": "2023-06-23T08:18:43+0000",
            "request_id": "520e094cf38510184b1800da4aecd-00000001",
            "sum_initial": {
                "amount": 200,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 200,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 20852,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "G57/QXMRTqt7TiqEcX5YXliTwqTplA9MIut6101ZNkA=="
    }

Useful links

The following articles can be useful when implementing purchases via Payment Page:

Purchases by using Gate

General information

To process a purchase through Gate by using the AstroPay method, the merchant's web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Receive an intermediate callback from the payment platform and redirect the customer to the AstroPay service.
  3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.

Figure 8. Purchase processing by using Gate: step-by-step description
  1. A customer initiates a purchase by using the AstroPay method in the web service.
  2. The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the AstroPay service.
  7. The request is processed on the AstroPay service side.
  8. The AstroPay service sends the redirection data to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected to the AstroPay service.
  11. The customer completes all required payment steps. If the customer does not have sufficient funds on the AstroPay account, the customer can deposit the needed amount using the methods offered in the AstroPay service.
  12. The purchase is processed on the side of the AstroPay service.
  13. The result is displayed to the customer.
  14. The customer is redirected to the web service.
  15. The AstroPay service sends the payment result notification to the payment platform.
  16. The payment platform sends the payment result callback to the web service.
  17. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the AstroPay method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the AstroPay method:

  1. To initiate each purchase, send a separate POST request to the /v2/payment/wallet/astropay/sale endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/sale.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payment
      • country—customer country code in accordance with ISO 3166-1 alpha-2
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the AstroPay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "BRL"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "country": "BR"
  }
}
Figure 9. Example of sufficient data in a purchase request
{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "BRL"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "country": "BR"
  }
}

Formats of intermediate callbacks for customer redirection

Each payment made with the AstroPay method requires redirection of customers from the merchant's web service to the AstroPay service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

  • body—object with data to be sent in the request body
  • method—parameter specifying the HTTP method for sending the request (GET or POST)
  • url—parameter containing a link for redirection
Figure 10. redirect_data example
  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

Final callback format

The AstroPay method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with information about a 2.00 USD purchase made in the 8181 project.

Figure 11. Example of callback data indicating that the purchase has been processed
{
        "provider_extra_fields": {
            "account_id": "ETlGnD42Pdhx"
        },
        "customer": {
            "id": "test-user123"
        },
        "project_id": 8181,
        "payment": {
            "id": "EPaffa-8a12",
            "type": "purchase",
            "status": "success",
            "date": "2023-06-23T08:14:20+0000",
            "method": "astropay",
            "sum": {
                "amount": 200,
                "currency": "USD"
            },
            "description": ""
        },
        "operation": {
            "id": 308,
            "type": "sale",
            "status": "success",
            "date": "2023-06-23T08:14:20+0000",
            "created_date": "2023-06-23T08:13:09+0000",
            "request_id": "ae236fbaaf62b18f66b70461f5d7-00000001",
            "sum_initial": {
                "amount": 200,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 200,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 20852,
                "payment_id": "NWsZT1GCMPeUSs5IclfIyoWgFs3UtCp7ydav9yb",
                "auth_code": ""
            }
        },
        "signature": "SxLFUcKLROs+lOPKKi4cDfnYjwMHSDgqeD+Jt1LYOg=="
    }

The following is the example of a callback with information about a declined purchase.

Figure 12. Example of callback data indicating that the purchase has been declined
{
        "customer": {
            "id": "test-user123"
        },
        "project_id": 8181,
        "payment": {
            "id": "EP7952-f1b2",
            "type": "purchase",
            "status": "decline",
            "date": "2023-06-23T08:18:54+0000",
            "method": "astropay",
            "sum": {
                "amount": 200,
                "currency": "USD"
            },
            "description": ""
        },
        "operation": {
            "id": 309,
            "type": "sale",
            "status": "decline",
            "date": "2023-06-23T08:18:54+0000",
            "created_date": "2023-06-23T08:18:43+0000",
            "request_id": "520e094cf38510184b1800da4aecd-00000001",
            "sum_initial": {
                "amount": 200,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 200,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 20852,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "G57/QXMRTqt7TiqEcX5YXliTwqTplA9MIut6101ZNkA=="
    }

Useful links

The following articles can be useful when implementing purchases via Gate:

Payouts to AstroPay accounts by using Gate

General information

To process a payout through Gate by using the AstroPay method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of payout processing are provided below.

Figure 13. Payout processing by using Gate: step-by-step description
  1. A customer initiates a payout by using the AstroPay method in the web service.
  2. The web service sends the request for processing the payout by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the AstroPay service.
  7. The payout is processed on the side of the AstroPay service.
  8. The AstroPay service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the payout result information from the web service.

Information about the formats of requests and callbacks used for processing payouts by using the AstroPay method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending payout requests by using the AstroPay method:

  1. To initiate each payout send a separate POST request to the /v2/payment/wallet/astropay/payout endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/payout.
  2. Each request must include the following objects and parameters:
    • Object general—general payout information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) details
    • Object payment—payment information:
      • amount—payout amount in the smallest currency unit
      • currency—payout currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payout
      • country—customer country code in accordance with ISO 3166-1 alpha-2
  3. Additionally, it is necessary to specify the one of the following parameters of the customer object:
    • phone—customer phone number associated with the AstroPay account; must be specified using a country code and without punctuation or special characters, for example 11231234567, you can read more about the format in the FAQ section. If this parameter is used in the request and the customer doesn't have an AstroPay account, the customer receives a message to the specified phone number with an offer to create an account. The payout can be completed if the customer creates the account
    • account_id—identifier of the customer account in the AstroPay service. A select account_id value can only be used in conjunction with two or less different values of the customer.id parameter

      The account_id parameter is included in the result callback in the following cases:

      • A purchase is processed
      • A payout which was initiated by using the customer.phone parameter is processed
  4. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the AstroPay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "BRL"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "country": "BR",
    "phone": "11231234567"
  }
}
Figure 14. Example of sufficient data in a purchase request
{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "BRL"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "country": "BR",
    "phone": "11231234567"
  }
}

Callback format

The AstroPay method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks.

The following is the example of a callback with information about a 2.00 USD payout made in the 8181 project.

Figure 15. Example of callback data indicating that the payout has been processed
{
        "provider_extra_fields": {
            "account_id": "XQhJpQa40sh8"
        },
        "customer": {
            "id": "test-user1",
            "phone": "34738383999"
        },
        "project_id": 8181,
        "payment": {
            "id": "astro_96",
            "type": "payout",
            "status": "success",
            "date": "2023-06-23T08:48:47+0000",
            "method": "astropay",
            "sum": {
                "amount": 200,
                "currency": "USD"
            },
            "description": ""
        },
        "operation": {
            "id": 319,
            "type": "payout",
            "status": "success",
            "date": "2023-06-23T08:48:47+0000",
            "created_date": "2023-06-23T08:48:36+0000",
            "request_id": "0977017ea90de7e80b8452f063dfbd467a-00000001",
            "sum_initial": {
                "amount": 200,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 956,
                "currency": "BRL"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 20852,
                "payment_id": "23780",
                "auth_code": ""
            }
        },
        "signature": "VWuCTeoc4IIhFNg6Ij0NerHwuDQCTUCyQARscw=="
    }

The following is the example of a callback with information about a declined payout.

Figure 16. Example of callback data indicating that the payout has been declined
{
        "customer": {
            "id": "test-user1",
            "phone": "55949499483833"
        },
        "project_id": 8181,
        "payment": {
            "id": "astro_97",
            "type": "payout",
            "status": "decline",
            "date": "2023-06-23T08:49:18+0000",
            "method": "astropay",
            "sum": {
                "amount": 200,
                "currency": "USD"
            },
            "description": ""
        },
        "operation": {
            "id": 320,
            "type": "payout",
            "status": "decline",
            "date": "2023-06-23T08:49:18+0000",
            "created_date": "2023-06-23T08:48:59+0000",
            "request_id": "cf13537bc421fee54f651fb6a3fe6a3c7d-00000001",
            "sum_initial": {
                "amount": 200,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 956,
                "currency": "BRL"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 20852,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "ns1NbhOPyWuwbBLaNtzAJsqALW3b33lmE+CHAPxXw=="
    }

Useful links

The following articles can be useful when implementing payouts via Gate:

Payouts to PIX accounts by using Gate

General information

To process a payout through Gate by using the AstroPay method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of payout processing are provided below.

Figure 17. Payout processing by using Gate: step-by-step description
  1. A customer initiates a payout by using the AstroPay method in the web service.
  2. The web service sends the request for processing the payout by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the AstroPay service.
  7. The payout is processed on the side of the AstroPay service.
  8. The AstroPay service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the payout result information from the web service.

Information about the formats of requests and callbacks used for processing payouts by using the AstroPay method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending payout requests by using the AstroPay method:

  1. To initiate each payout send a separate POST request to the /v2/payment/pix/payout endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general payout information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) details
    • Object payment—payment information:
      • amount—payout amount in the smallest currency unit
      • currency—payout currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payout
  3. Additionally, it is recommended to specify the following objects and parameters:
    • Object customer—customer information:
      • first_name—first name
      • last_name—last name
      • country—customer country code in accordance with ISO 3166-1 alpha-2
      • identify—information about the document which establishes identity:
        • doc_type—type of the document, it is required to specify the value CPF (Brazilian tax identification number of customer, must consist of 11 digits)
        • doc_number—number of the document
    • Object account—PIX account information:
      • number—account number
    • One of the following parameters of the customer object:
      • email—customer email address
      • phone—customer phone number; must be specified using a country code and without punctuation or special characters, for example 11231234567, you can read more about the format in the FAQ section

    If any of these parameters are missing, the payment platform may send the list of missing parameters in a callback requesting additional information submission (details are available in Submission of additional payment information).

  4. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the AstroPay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer and account information, as well as signature.

{
    "general": {
        "project_id": 312,
        "payment_id": "f8827",
        "signature": "3zjYFq8JuRey87Q4OyuWs1Kaa+K4SAyamNnFVg=="
    },
    "payment": {
        "amount": 10000,
        "currency": "BRL"
    },
    "customer": {
        "ip_address": "192.0.2.0",
        "first_name": "John",
        "last_name": "Doe",
        "email": "example@example.com",
        "id": "customer_123",
        "country": "BR",
        "identify": {
            "doc_number": "12345678901",
            "doc_type": "CPF"
        }
    },
    "account": {
        "number": "12345"
}
Figure 18. Example of sufficient data in a purchase request
{
    "general": {
        "project_id": 312,
        "payment_id": "f8827",
        "signature": "3zjYFq8JuRey87Q4OyuWs1Kaa+K4SAyamNnFVg=="
    },
    "payment": {
        "amount": 10000,
        "currency": "BRL"
    },
    "customer": {
        "ip_address": "192.0.2.0",
        "first_name": "John",
        "last_name": "Doe",
        "email": "example@example.com",
        "id": "customer_123",
        "country": "BR",
        "identify": {
            "doc_number": "12345678901",
            "doc_type": "CPF"
        }
    },
    "account": {
        "number": "12345"
}

Callback format

The AstroPay method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks.

The following is the example of a callback with information about a 2.00 USD payout made in the 8181 project.

Figure 19. Example of callback data indicating that the payout has been processed
{
        "project_id": 8181,
        "payment": {
            "id": "astro_100",
            "type": "payout",
            "status": "success",
            "date": "2023-06-23T09:01:50+0000",
            "method": "pix",
            "sum": {
                "amount": 200,
                "currency": "USD"
            },
            "description": ""
        },
        "account": {
            "number": "12345678910"
        },
        "customer": {
            "id": "test-user1",
            "phone": "34738383999"
        },
        "provider_extra_fields": {
            "account_id": "XQhJpQa40sh8"
        },
        "operation": {
            "id": 323,
            "type": "payout",
            "status": "success",
            "date": "2023-06-23T09:01:50+0000",
            "created_date": "2023-06-23T09:01:33+0000",
            "request_id": "61788f10d1fea1787aa9652ca64f-00000001",
            "sum_initial": {
                "amount": 200,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 200,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 20853,
                "payment_id": "23782",
                "auth_code": ""
            }
        },
        "signature": "xne92PHCCHfgwnMdrgn52zDANIu0pj1YREWsEeQQ=="
    }

The following is the example of a callback with information about a declined payout.

Figure 20. Example of callback data indicating that the payout has been declined
{
        "project_id": 8181,
        "payment": {
            "id": "astro_101",
            "type": "payout",
            "status": "decline",
            "date": "2023-06-23T09:41:08+0000",
            "method": "pix",
            "sum": {
                "amount": 200,
                "currency": "USD"
            },
            "description": ""
        },
        "account": {
            "number": "12345678910"
        },
        "customer": {
            "id": "test-user1",
            "phone": "34738383999"
        },
        "operation": {
            "id": 325,
            "type": "payout",
            "status": "decline",
            "date": "2023-06-23T09:41:08+0000",
            "created_date": "2023-06-23T09:40:57+0000",
            "request_id": "5a4ebdc305fe57d51a98820793f04d-00000001",
            "sum_initial": {
                "amount": 200,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 200,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 20853,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "Lc0RMow6EOSKT6rGs6shTGL7FH7oNkF2u4AQ=="
    }

Useful links

The following articles can be useful when implementing payouts via Gate:

Payouts by using Dashboard

When working with Dashboard, you can process single and mass payouts by using the AstroPay method.

  • To process a single payout, open the payout form, specify all required parameters (including the payment method), send a request and verify that the payout has been processed.

  • To process a mass payout, prepare and upload a file with information about all target payouts, send a batch request, and verify that the payouts have been processed.

    Use a CSV file structured according to the requirements presented in the Mass payments data section. The payout parameters must comply with the requirements (you do not have to generate a signature because it is specified by Dashboard).

More information about processing payouts by using Dashboard is presented in a separate section.

Analysis of payments results

To analyse information about payments made with the AstroPay method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.