# SPEI

## Payin by SPEI

<mark style="color:green;">`POST`</mark> `https://gateway-test.pagsmile.com/trade/pay`

This endpoint allows you to submit a payin by SPEI in Mexico.

#### Headers

| Name                                            | Type   | Description                                |
| ----------------------------------------------- | ------ | ------------------------------------------ |
| Content-Type<mark style="color:red;">\*</mark>  | string | application/json; chartset=UTF-8           |
| Authorization<mark style="color:red;">\*</mark> | string | Basic Base($app\_*id:$security\_*&#x6B;ey) |

#### Request Body

| Name                                                       | Type   | Description                                                                                                |
| ---------------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------- |
| app\_id<mark style="color:red;">\*</mark>                  | string | <p>created app's id at dashboard</p><p>- Max. 32 chars -</p>                                               |
| customer.phone                                             | string | User's phone                                                                                               |
| customer.email<mark style="color:red;">\*</mark>           | string | User's email                                                                                               |
| customer.identify.number<mark style="color:red;">\*</mark> | string | <p>User's identification number<br>- RFC: 13 chars, ex: MAMB780915969; CURP: 18 chars -</p>                |
| method<mark style="color:red;">\*</mark>                   | string | Fixed value: SPEI                                                                                          |
| out\_trade\_no<mark style="color:red;">\*</mark>           | string | <p>ID given by the merchant in their system<br>- Max. 64 chars - </p>                                      |
| notify\_url<mark style="color:red;">\*</mark>              | string | Where Pagsmile will send notification to                                                                   |
| customer.identify.type<mark style="color:red;">\*</mark>   | string | <p>User's identification type</p><p>- RFC or CURP -</p>                                                    |
| customer.name<mark style="color:red;">\*</mark>            | string | User's name                                                                                                |
| timestamp<mark style="color:red;">\*</mark>                | string | <p>yyyy-MM-dd HH:mm:ss<br>- Max. 19 chars -</p>                                                            |
| subject<mark style="color:red;">\*</mark>                  | string | <p>payment reason or item title</p><p>- Max. 128 chars -</p>                                               |
| order\_amount<mark style="color:red;">\*</mark>            | string | <p>payment amount<br>-  check <a href="../../../../payout/payment-method#mexico">here</a> for limits -</p> |
| order\_currency<mark style="color:red;">\*</mark>          | string | Fixed value: MXN                                                                                           |
| content                                                    | string | <p>payment reason detail or item detail</p><p>- Max. 255 chars -</p>                                       |
| buyer\_id<mark style="color:red;">\*</mark>                | string | merchant user's id                                                                                         |
| address.zip\_code                                          | string | <p>zip code<br>- 5 digits -</p>                                                                            |
| website\_url                                               | string | <p>merchant website URL</p><p>- Max. 128 chars -</p>                                                       |
| address.street                                             | string | street                                                                                                     |
| address.street\_number                                     | string | street number                                                                                              |
| address.city                                               | string | city                                                                                                       |
| address.state                                              | string | state                                                                                                      |
| return\_url                                                | string | Redirect to Merchant's url when user finished checkout                                                     |

{% tabs %}
{% tab title="200 submit successfully" %}

```
{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110293900084",
    "out_trade_no": "202201010354004",
    "web_url": "",
    "pay_url": "https://checkout-testv2.pagsmile.com/checkout?prepay_id=UGlRNFB4WHRQRXJPZERhcFhHNlJPRzREZ2tTaDl1RktST1JjbCtPK2V2az0=-31B82307",
    "trade_status": "PROCESSING",
    "reference": "0000000",
    "clabe": "000000000000000001",
    "bank_name": "BBVA Bancomer",
    "beneficiary_name": "Pagsmile",
    "due_date": "1770448606801"
}
```

{% endtab %}

{% tab title="400 duplicate out\_trade\_no" %}

```
{
    "code": "40002",
    "msg": "Business Failed",
    "sub_code": "duplicate-out_trade_no",
    "sub_msg": "out_trade_no is duplicate"
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**User payment tips**

* Add a Copy CLABE button. The value of **clabe** is the only information that the user needs to use to complete payment. Adding a copy button could help to improve the user's payment experience.&#x20;
* **Clabe** will be unique for each order. Payment with incorrect clabe or incorrect **amount** will not be confirmed by the bank.
  {% endhint %}

## Example

```
curl --location --request POST 'https://gateway-test.pagsmile.com/trade/pay' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "app_id": "162************38",
    * "out_trade_no": "202201010354004",
    * "method": "SPEI",
    * "order_amount": "12.01",
    * "order_currency": "MXN",
    * "subject": "trade pay test",
      "content": "trade pay test conent",
    * "notify_url": "http://merchant/callback/success",
      "return_url": "https://www.merchant.com",
    * "buyer_id": "buyer_0101_0001",
    * "timestamp": "2022-01-01 03:54:01",
      "timeout_express":"1c",
    * "customer" : {
    *     "identify": {
    *         "type": "RFC",
    *         "number": "MAMB780915969"
          },
    *     "name": "Test User Name",
    *     "email": "test@pagsmile.com"
      }
      }'
```

<figure><img src="https://4142198059-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MgOGd5QxlX-U1mkQpVU%2Fuploads%2FmCt9hgDZUgSm615tndJo%2Fimage.png?alt=media&#x26;token=210cb560-e0e8-4b37-9422-9ab461c6f9ce" alt=""><figcaption><p>Example of payment page</p></figcaption></figure>

{% hint style="info" %}
Note:  **162\*\*\*\*\*\*\*\*\*\*\*\*38** is pagsmile's test app id for sandbox, and **MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==** is authorization token associated with the test app id.&#x20;
{% endhint %}

{% hint style="danger" %}
Please use your own **app\_id** and generate your own **authorization token** when testing.
{% endhint %}