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

post
Body
countrystringRequired

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

Example: MEX
amountnumberRequired

The amount of the transaction. Without decimals

Example: 100000
currencystringRequired

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

Example: MXN
orderIdstringRequired

Merchant payout ID (Purchase Order)

Example: R123456
descriptionstringOptional

Description for merchant use

Example: FreeTextFreeTextFreeTextFreeText
Responses
200
OK
application/json
post
POST /v1/{merchantId}/payouts HTTP/1.1
Host: api
Content-Type: application/json
Accept: */*
Content-Length: 837

{
  "country": "MEX",
  "amount": 100000,
  "currency": "MXN",
  "orderId": "R123456",
  "description": "FreeTextFreeTextFreeTextFreeText",
  "beneficiary": {
    "customerId": 12345,
    "userName": "Test",
    "name": "test",
    "lastName": "Test",
    "email": "[email protected]",
    "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"
  }
}
{
  "payout": {
    "Id": 1,
    "country": "text",
    "amount": 1,
    "currency": "text",
    "orderId": "text"
  },
  "output": {
    "stage": "text",
    "status": "text",
    "statusChangeDateTime": "text"
  }
}
{
	"country": "PER",
	"amount": 100000,
	"currency": "PEN",
	"orderId": "R123456",
	"description": "Optional Description",
	"beneficiary": {
		"customerId": "12345",
		"userName": "test",
		"name": "Test",
		"lastName": "Test",
		"email": "[email protected]",
		"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.

Last updated