Get Payout Status

This method is used to verify the status of the payroll and the transactions that belong to it

Get Payout Status

Returns the Payout Status

GET/apiapi/v1/{merchantId}/payouts/{payoutid}

Response

200404

CREATED

Body

application/json

payoutobject

outputobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/apiapi/v1/{merchantId}/payouts/{payoutid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "payout": {
    "Id": 1111111111,
    "country": "MEX",
    "amount": 100000,
    "currency": "MX",
    "orderId": "R123456",
    "description": "<p>FreeText</p>",
    "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": "test",
        "city": "test",
        "province": "test",
        "country": "MEX",
        "zipCode": "1408"
      }
    },
    "destination": {
      "bankAccount": {
        "bankCode": "100",
        "accountType": "S",
        "accountNumber": "00000000000",
        "alias": "",
        "cbu": "",
        "cvu": "",
        "cci": "",
        "clave": "",
        "location": {
          "street": "Caranday",
          "houseNumber": "966",
          "additionalInfo": "TextTextTextTextTextTextTextTextTextTextText",
          "city": "test",
          "province": "test",
          "country": "MEX",
          "zipCode": "1408"
        }
      }
    },
    "subMerchantInfo": {
      "code": "1111",
      "name": "Prueba",
      "url": "http://prueba.com"
    }
  },
  "output": {
    "stage": "IN_PROGRESS",
    "status": "CREATED",
    "statusChangeDateTime": "20220110223001"
  }
}

Another option is to get a Rejected Status from a payout, in that case you will get the next body as response:

{
"payout":{
	"Id": 1111111111,
	"country": "PER",
	"amount": 100000,
	"currency": "PEN",
	"orderId": "R123456",
	"description": "Free Text Free Text",
	"beneficiary":{
		"customerId": "12345",
		"userName": "testUser",
		"name": "test",
		"lastName": "test",
		"email": "[e-mail]",
		"phoneNumber": "123456789",
		"document":{
			"type":	1,
			"number": "12345678"
		},
		"address":{
			"street": "9 de Julio",
			"houseNumber": "123",
			"additionalInfo": "Extra Information",
			"city": "LIMA",
			"province": "LIMA",
			"country": "PER",
			"zipCode": "1408"
		}
	},
	"destination": {
		"bankAccount": {
			"bankCode": "001",
			"accountType": "1",
			"location": {
				"street": "9 de Julio",
				"houseNumber": "123",
				"additionalInfo": "Extra Information",
				"city": "LIMA",
				"province": "LIMA",
				"country": "PER",
				"zipCode": "1408"
			}
		}
	},
	"subMerchantInfo":{
		"code": "1111",
		"name": "Prueba",
		"url": "http://prueba.com"
	}
},
"output":{
	"stage": "REJECTED",
	"status": "REJECTED_BANK",
	"statusChangeDateTime": "20220110223001"
},
"errors":[
	{
            "code" : "4001",
            "message" : "Bank Rejection - Beneficiary is not the Account Owner"
        }
]
}

In the Get Payout Status API edpoint, the {id} indicated is the one returned by monnet in the Create Payout response.