Create Payout

In this documentation you will be able to see all the especifications that are needed to create a payout.

This method consists of creating a payout and sending it to Monnet to be paid.

It is the use of an API with a POST method in which the information of the beneficiary used to make the corresponding dispersion will be sent to us.

Request example with all the fields:

Create Payout

POSTapi/v1/{merchantId}/payouts

Body

application/json

Información del pago a realizar

country*string

ISO 3166-1-alpha-3 MEX, etc.

Example: "MEX"

amount*number

The amount of the transaction. Without decimals

Example: 100000

currency*string

The currency of the payout, ISO-4217(MXN, etc).

Example: "MXN"

orderId*string

Merchant payout ID (Purchase Order)

Example: "R123456"

descriptionstring

Description for merchant use

Example: "FreeTextFreeTextFreeTextFreeText"

beneficiary*object

destination*object

subMerchantInfoobject

Response

200400401

OK

Body

application/json

payoutobject

outputobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('api/v1/{merchantId}/payouts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "country": "MEX",
      "amount": 100000,
      "currency": "MXN",
      "orderId": "R123456",
      "description": "FreeTextFreeTextFreeTextFreeText",
      "beneficiary": {
        "customerId": 12345,
        "userName": "Test",
        "name": "test",
        "lastName": "Test",
        "email": "[e-mail]",
        "phoneNumber": 5491128483579,
        "document": {
          "type": 1,
          "number": 33446836
        },
        "address": {
          "street": "Test",
          "houseNumber": 966,
          "additionalInfo": "TextTextTextTextTextTextTextTextTextTextT",
          "city": "test",
          "province": "test",
          "country": "MEX",
          "zipCode": 1408
        }
      },
      "destination": {
        "bankAccount": {
          "bankCode": 100,
          "accountType": 1,
          "accountNumber": 0,
          "clabe": "123456789112345678",
          "cbu": "002123456789123456",
          "location": {
            "street": "Test",
            "houseNumber": 966,
            "additionalInfo": "TextTextTextTextTextTextTextTe",
            "city": "test",
            "province": "test",
            "country": "MEX",
            "zipCode": 1408
          }
        }
      },
      "subMerchantInfo": {
        "code": 1111,
        "name": "Prueba",
        "url": "http://prueba.com"
      }
    }),
});
const data = await response.json();

Response

200400401

{
  "payout": {
    "Id": 123456,
    "country": "MEX",
    "amount": 10000,
    "currency": "MX",
    "orderId": "R123456"
  },
  "output": {
    "stage": "IN_PROGRESS",
    "status": "CREATED",
    "statusChangeDateTime": 20220110223001
  }
}

{
	"country": "PER",
	"amount": 100000,
	"currency": "PEN",
	"orderId": "R123456",
	"description": "Optional Description",
	"beneficiary": {
		"customerId": "12345",
		"userName": "test",
		"name": "Test",
		"lastName": "Test",
		"email": "[e-mail]",
		"phoneNumber": "5491128480000",
		"document": {
			"type": 1,
			"number": "12345678"
		},
		"address": {
			"street": "9 de Julio",
			"houseNumber": "123",
			"additionalInfo": "Extra information",
			"city": "Lima",
			"province": "Lima",
			"zipCode": "1408"
		}
	},
	"destination": {
		"bankAccount": {
			"bankCode": "001",
			"accountType": "1",
			"accountNumber": "00000000000",
			"alias": "",
			"cbu": "",
			"cci": "",
			"clabe":"",
			"location": {
				"street": "9 de Julio",
				"houseNumber": "123",
				"additionalInfo": "Extra information",
				"city": "",
				"province": "Lima",
				"country": "PER",
				"zipCode": "1408"
			}
		}
	},
	"subMerchantInfo": {
		"code": "1111",
		"name": "Prueba",
		"url": "http://prueba.com"
	}
}

When creating a Payout, there are optional fields that you can provide. Although not mandatory, including this information can improve the user's payment experience. Consider these fields if you wish to provide additional details.

Time Outs

In the case of receiving a Time Out as a response from this API we recommend resending the payout again after 30 seconds using the same orderId.

This way we will check if the payout was processed and avoid double payments.