Get Payout Status
This method is used to verify the status of the payroll and the transactions that belong to it
Returns the Payout Status
Responses
200
CREATED
application/json
404
NOT-FOUND
application/json
get
GET /apiapi/v1/{merchantId}/payouts/{payoutid} HTTP/1.1
Host:
Accept: */*
{
"payout": {
"Id": 1,
"country": "text",
"amount": 1,
"currency": "text",
"orderId": "text",
"description": "text",
"beneficiary": {
"customerId": "text",
"userName": "text",
"name": "text",
"lastName": "text",
"email": "text",
"phoneNumber": "text",
"document": {
"type": 1,
"number": "text"
},
"address": {
"street": "text",
"houseNumber": "text",
"additionalInfo": "text",
"city": "text",
"province": "text",
"country": "text",
"zipCode": "text"
}
},
"destination": {
"bankAccount": {
"bankCode": "text",
"accountType": "text",
"accountNumber": "text",
"alias": "text",
"cbu": "text",
"cvu": "text",
"cci": "text",
"location": {
"street": "text",
"houseNumber": "text",
"additionalInfo": "text",
"city": "text",
"province": "text",
"country": "text",
"zipCode": "text"
}
}
},
"subMerchantInfo": {
"code": "text",
"name": "text",
"url": "text"
}
},
"output": {
"stage": "text",
"status": "text",
"statusChangeDateTime": "2025-07-02T01:59:16.897Z"
}
}
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": "[email protected]",
"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"
}
]
}
Last updated