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 a payout

post

Creates a payout and sends it to Monnet for processing. If a Time Out response is received, resend the request after 30 seconds using the same orderId to verify if it was processed and avoid duplicate payments.

Body

application/json

countrystringRequired

ISO 3166-1 alpha-3 code of the country (e.g., MEX, PER)

Example: MEX

amountnumberRequired

The transaction amount

Example: 100000

currencystringRequired

Currency code in ISO 4217 format (e.g., MXN, PEN)

Example: MXN

orderIdstringRequired

Merchant payout ID (Purchase Order)

Example: R123456

descriptionstringOptional

Optional description for merchant use

Example: FreeTextFreeTextFreeText

Responses

201

OK

application/json

400

Missing or invalid data

application/json

401

Data validation error

application/json

post

/payouts

HTTPcURLJavaScriptPython

POST /api/v1/{merchantId}/payouts HTTP/1.1
Host: api.monnet.com/api/v1/undefined
Content-Type: application/json
Accept: */*
Content-Length: 796

{
  "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"
  }
}

{
  "payout": {
    "Id": 1,
    "country": "PER",
    "amount": 100000,
    "currency": "PEN",
    "orderId": "R123456"
  },
  "output": {
    "stage": "Processing",
    "status": "Completed",
    "statusChangeDateTime": "2024-01-01T12:00:00Z"
  }
}

{
	"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.