Collection

Partner Gateway API document

GetPaymentStatus

This operation is used to get the status of a Payment. X-Reference-Id that was passed in the post is used as reference to the request

Try it

Request

Request URL

https://proxy.momoapi.mtn.com/collection/v2_0/payment/{x-referenceId}

Request parameters

x-referenceId

string

UUID of transaction to get result. Reference id used when creating the Payment.

Request headers

Authorization

string

Bearer Authentication Token generated using CreateAccessToken API Call
X-Target-Environment

string

The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

OK. Note that a failed CreateInvoice will be returned with this status too. The 'status' of the CreateInvoice can be used to determine the outcome of the request. The 'errorReason' field can be used to retrieve a cause in case of failure.

Representations

{
  "type": "object",
  "properties": {
    "referenceId": {
      "type": "string",
      "description": "The reference id for this Payment."
    },
    "status": {
      "enum": [
        "CREATED",
        "PENDING",
        "SUCCESSFUL",
        "FAILED"
      ],
      "type": "string"
    },
    "financialTransactionId": {
      "type": "string",
      "description": "A transaction id associated with this payment."
    },
    "reason": {
      "type": "object",
      "properties": {
        "code": {
          "enum": [
            "PAYEE_NOT_FOUND",
            "PAYER_NOT_FOUND",
            "NOT_ALLOWED",
            "NOT_ALLOWED_TARGET_ENVIRONMENT",
            "INVALID_CALLBACK_URL_HOST",
            "INVALID_CURRENCY",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_PROCESSING_ERROR",
            "NOT_ENOUGH_FUNDS",
            "PAYER_LIMIT_REACHED",
            "PAYEE_NOT_ALLOWED_TO_RECEIVE",
            "PAYMENT_NOT_APPROVED",
            "RESOURCE_NOT_FOUND",
            "APPROVAL_REJECTED",
            "EXPIRED",
            "TRANSACTION_CANCELED.",
            "RESOURCE_ALREADY_EXIST",
            "TRANSACTION_NOT_COMPLETED",
            "TRANSACTION_NOT_FOUND",
            "INFORMATIONAL_SCOPE_INSTRUCTION",
            "MISSING_SCOPE_INSTRUCTION",
            "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
            "UNSUPPORTED_SCOPE_COMBINATION",
            "CONSENT_MISMATCH",
            "UNSUPPORTED_SCOPE",
            "NOT_FOUND"
          ],
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "referenceId": {
      "type": "string",
      "description": "The reference id for this Payment."
    },
    "status": {
      "enum": [
        "CREATED",
        "PENDING",
        "SUCCESSFUL",
        "FAILED"
      ],
      "type": "string"
    },
    "financialTransactionId": {
      "type": "string",
      "description": "A transaction id associated with this payment."
    },
    "reason": {
      "type": "object",
      "properties": {
        "code": {
          "enum": [
            "PAYEE_NOT_FOUND",
            "PAYER_NOT_FOUND",
            "NOT_ALLOWED",
            "NOT_ALLOWED_TARGET_ENVIRONMENT",
            "INVALID_CALLBACK_URL_HOST",
            "INVALID_CURRENCY",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_PROCESSING_ERROR",
            "NOT_ENOUGH_FUNDS",
            "PAYER_LIMIT_REACHED",
            "PAYEE_NOT_ALLOWED_TO_RECEIVE",
            "PAYMENT_NOT_APPROVED",
            "RESOURCE_NOT_FOUND",
            "APPROVAL_REJECTED",
            "EXPIRED",
            "TRANSACTION_CANCELED.",
            "RESOURCE_ALREADY_EXIST",
            "TRANSACTION_NOT_COMPLETED",
            "TRANSACTION_NOT_FOUND",
            "INFORMATIONAL_SCOPE_INSTRUCTION",
            "MISSING_SCOPE_INSTRUCTION",
            "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
            "UNSUPPORTED_SCOPE_COMBINATION",
            "CONSENT_MISMATCH",
            "UNSUPPORTED_SCOPE",
            "NOT_FOUND"
          ],
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      }
    }
  }
}

Sample
Schema

{
  "referenceId": "string",
  "status": "CREATED",
  "financialTransactionId": "string",
  "reason": {
    "code": "PAYEE_NOT_FOUND"
  }
}

{
  "type": "object",
  "properties": {
    "referenceId": {
      "type": "string",
      "description": "The reference id for this Payment."
    },
    "status": {
      "enum": [
        "CREATED",
        "PENDING",
        "SUCCESSFUL",
        "FAILED"
      ],
      "type": "string"
    },
    "financialTransactionId": {
      "type": "string",
      "description": "A transaction id associated with this payment."
    },
    "reason": {
      "type": "object",
      "properties": {
        "code": {
          "enum": [
            "PAYEE_NOT_FOUND",
            "PAYER_NOT_FOUND",
            "NOT_ALLOWED",
            "NOT_ALLOWED_TARGET_ENVIRONMENT",
            "INVALID_CALLBACK_URL_HOST",
            "INVALID_CURRENCY",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_PROCESSING_ERROR",
            "NOT_ENOUGH_FUNDS",
            "PAYER_LIMIT_REACHED",
            "PAYEE_NOT_ALLOWED_TO_RECEIVE",
            "PAYMENT_NOT_APPROVED",
            "RESOURCE_NOT_FOUND",
            "APPROVAL_REJECTED",
            "EXPIRED",
            "TRANSACTION_CANCELED.",
            "RESOURCE_ALREADY_EXIST",
            "TRANSACTION_NOT_COMPLETED",
            "TRANSACTION_NOT_FOUND",
            "INFORMATIONAL_SCOPE_INSTRUCTION",
            "MISSING_SCOPE_INSTRUCTION",
            "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
            "UNSUPPORTED_SCOPE_COMBINATION",
            "CONSENT_MISMATCH",
            "UNSUPPORTED_SCOPE",
            "NOT_FOUND"
          ],
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "referenceId": {
      "type": "string",
      "description": "The reference id for this Payment."
    },
    "status": {
      "enum": [
        "CREATED",
        "PENDING",
        "SUCCESSFUL",
        "FAILED"
      ],
      "type": "string"
    },
    "financialTransactionId": {
      "type": "string",
      "description": "A transaction id associated with this payment."
    },
    "reason": {
      "type": "object",
      "properties": {
        "code": {
          "enum": [
            "PAYEE_NOT_FOUND",
            "PAYER_NOT_FOUND",
            "NOT_ALLOWED",
            "NOT_ALLOWED_TARGET_ENVIRONMENT",
            "INVALID_CALLBACK_URL_HOST",
            "INVALID_CURRENCY",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_PROCESSING_ERROR",
            "NOT_ENOUGH_FUNDS",
            "PAYER_LIMIT_REACHED",
            "PAYEE_NOT_ALLOWED_TO_RECEIVE",
            "PAYMENT_NOT_APPROVED",
            "RESOURCE_NOT_FOUND",
            "APPROVAL_REJECTED",
            "EXPIRED",
            "TRANSACTION_CANCELED.",
            "RESOURCE_ALREADY_EXIST",
            "TRANSACTION_NOT_COMPLETED",
            "TRANSACTION_NOT_FOUND",
            "INFORMATIONAL_SCOPE_INSTRUCTION",
            "MISSING_SCOPE_INSTRUCTION",
            "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
            "UNSUPPORTED_SCOPE_COMBINATION",
            "CONSENT_MISMATCH",
            "UNSUPPORTED_SCOPE",
            "NOT_FOUND"
          ],
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "referenceId": {
      "type": "string",
      "description": "The reference id for this Payment."
    },
    "status": {
      "enum": [
        "CREATED",
        "PENDING",
        "SUCCESSFUL",
        "FAILED"
      ],
      "type": "string"
    },
    "financialTransactionId": {
      "type": "string",
      "description": "A transaction id associated with this payment."
    },
    "reason": {
      "type": "object",
      "properties": {
        "code": {
          "enum": [
            "PAYEE_NOT_FOUND",
            "PAYER_NOT_FOUND",
            "NOT_ALLOWED",
            "NOT_ALLOWED_TARGET_ENVIRONMENT",
            "INVALID_CALLBACK_URL_HOST",
            "INVALID_CURRENCY",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_PROCESSING_ERROR",
            "NOT_ENOUGH_FUNDS",
            "PAYER_LIMIT_REACHED",
            "PAYEE_NOT_ALLOWED_TO_RECEIVE",
            "PAYMENT_NOT_APPROVED",
            "RESOURCE_NOT_FOUND",
            "APPROVAL_REJECTED",
            "EXPIRED",
            "TRANSACTION_CANCELED.",
            "RESOURCE_ALREADY_EXIST",
            "TRANSACTION_NOT_COMPLETED",
            "TRANSACTION_NOT_FOUND",
            "INFORMATIONAL_SCOPE_INSTRUCTION",
            "MISSING_SCOPE_INSTRUCTION",
            "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
            "UNSUPPORTED_SCOPE_COMBINATION",
            "CONSENT_MISMATCH",
            "UNSUPPORTED_SCOPE",
            "NOT_FOUND"
          ],
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      }
    }
  }
}

400 Bad Request

Bad request, e.g. an incorrectly formatted reference id was provided.

Representations

404 Not Found

Resource not found.

{
  "code": "RESOURCE_NOT_FOUND",
  "message": "Requested resource was not found."
}

{
  "type": "object",
  "properties": {
    "code": {
      "enum": [
        "PAYEE_NOT_FOUND",
        "PAYER_NOT_FOUND",
        "NOT_ALLOWED",
        "NOT_ALLOWED_TARGET_ENVIRONMENT",
        "INVALID_CALLBACK_URL_HOST",
        "INVALID_CURRENCY",
        "SERVICE_UNAVAILABLE",
        "INTERNAL_PROCESSING_ERROR",
        "NOT_ENOUGH_FUNDS",
        "PAYER_LIMIT_REACHED",
        "PAYEE_NOT_ALLOWED_TO_RECEIVE",
        "PAYMENT_NOT_APPROVED",
        "RESOURCE_NOT_FOUND",
        "APPROVAL_REJECTED",
        "EXPIRED",
        "TRANSACTION_CANCELED.",
        "RESOURCE_ALREADY_EXIST",
        "TRANSACTION_NOT_COMPLETED",
        "TRANSACTION_NOT_FOUND",
        "INFORMATIONAL_SCOPE_INSTRUCTION",
        "MISSING_SCOPE_INSTRUCTION",
        "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
        "UNSUPPORTED_SCOPE_COMBINATION",
        "CONSENT_MISMATCH",
        "UNSUPPORTED_SCOPE",
        "NOT_FOUND"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "code": {
      "enum": [
        "PAYEE_NOT_FOUND",
        "PAYER_NOT_FOUND",
        "NOT_ALLOWED",
        "NOT_ALLOWED_TARGET_ENVIRONMENT",
        "INVALID_CALLBACK_URL_HOST",
        "INVALID_CURRENCY",
        "SERVICE_UNAVAILABLE",
        "INTERNAL_PROCESSING_ERROR",
        "NOT_ENOUGH_FUNDS",
        "PAYER_LIMIT_REACHED",
        "PAYEE_NOT_ALLOWED_TO_RECEIVE",
        "PAYMENT_NOT_APPROVED",
        "RESOURCE_NOT_FOUND",
        "APPROVAL_REJECTED",
        "EXPIRED",
        "TRANSACTION_CANCELED.",
        "RESOURCE_ALREADY_EXIST",
        "TRANSACTION_NOT_COMPLETED",
        "TRANSACTION_NOT_FOUND",
        "INFORMATIONAL_SCOPE_INSTRUCTION",
        "MISSING_SCOPE_INSTRUCTION",
        "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
        "UNSUPPORTED_SCOPE_COMBINATION",
        "CONSENT_MISMATCH",
        "UNSUPPORTED_SCOPE",
        "NOT_FOUND"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "code": {
      "enum": [
        "PAYEE_NOT_FOUND",
        "PAYER_NOT_FOUND",
        "NOT_ALLOWED",
        "NOT_ALLOWED_TARGET_ENVIRONMENT",
        "INVALID_CALLBACK_URL_HOST",
        "INVALID_CURRENCY",
        "SERVICE_UNAVAILABLE",
        "INTERNAL_PROCESSING_ERROR",
        "NOT_ENOUGH_FUNDS",
        "PAYER_LIMIT_REACHED",
        "PAYEE_NOT_ALLOWED_TO_RECEIVE",
        "PAYMENT_NOT_APPROVED",
        "RESOURCE_NOT_FOUND",
        "APPROVAL_REJECTED",
        "EXPIRED",
        "TRANSACTION_CANCELED.",
        "RESOURCE_ALREADY_EXIST",
        "TRANSACTION_NOT_COMPLETED",
        "TRANSACTION_NOT_FOUND",
        "INFORMATIONAL_SCOPE_INSTRUCTION",
        "MISSING_SCOPE_INSTRUCTION",
        "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
        "UNSUPPORTED_SCOPE_COMBINATION",
        "CONSENT_MISMATCH",
        "UNSUPPORTED_SCOPE",
        "NOT_FOUND"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "code": "PAYEE_NOT_FOUND",
  "message": "string"
}

{
  "type": "object",
  "properties": {
    "code": {
      "enum": [
        "PAYEE_NOT_FOUND",
        "PAYER_NOT_FOUND",
        "NOT_ALLOWED",
        "NOT_ALLOWED_TARGET_ENVIRONMENT",
        "INVALID_CALLBACK_URL_HOST",
        "INVALID_CURRENCY",
        "SERVICE_UNAVAILABLE",
        "INTERNAL_PROCESSING_ERROR",
        "NOT_ENOUGH_FUNDS",
        "PAYER_LIMIT_REACHED",
        "PAYEE_NOT_ALLOWED_TO_RECEIVE",
        "PAYMENT_NOT_APPROVED",
        "RESOURCE_NOT_FOUND",
        "APPROVAL_REJECTED",
        "EXPIRED",
        "TRANSACTION_CANCELED.",
        "RESOURCE_ALREADY_EXIST",
        "TRANSACTION_NOT_COMPLETED",
        "TRANSACTION_NOT_FOUND",
        "INFORMATIONAL_SCOPE_INSTRUCTION",
        "MISSING_SCOPE_INSTRUCTION",
        "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
        "UNSUPPORTED_SCOPE_COMBINATION",
        "CONSENT_MISMATCH",
        "UNSUPPORTED_SCOPE",
        "NOT_FOUND"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "code": {
      "enum": [
        "PAYEE_NOT_FOUND",
        "PAYER_NOT_FOUND",
        "NOT_ALLOWED",
        "NOT_ALLOWED_TARGET_ENVIRONMENT",
        "INVALID_CALLBACK_URL_HOST",
        "INVALID_CURRENCY",
        "SERVICE_UNAVAILABLE",
        "INTERNAL_PROCESSING_ERROR",
        "NOT_ENOUGH_FUNDS",
        "PAYER_LIMIT_REACHED",
        "PAYEE_NOT_ALLOWED_TO_RECEIVE",
        "PAYMENT_NOT_APPROVED",
        "RESOURCE_NOT_FOUND",
        "APPROVAL_REJECTED",
        "EXPIRED",
        "TRANSACTION_CANCELED.",
        "RESOURCE_ALREADY_EXIST",
        "TRANSACTION_NOT_COMPLETED",
        "TRANSACTION_NOT_FOUND",
        "INFORMATIONAL_SCOPE_INSTRUCTION",
        "MISSING_SCOPE_INSTRUCTION",
        "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
        "UNSUPPORTED_SCOPE_COMBINATION",
        "CONSENT_MISMATCH",
        "UNSUPPORTED_SCOPE",
        "NOT_FOUND"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

500 Internal Server Error

Internal Error. Note that if the retrieved request to pay has failed, it will not cause this status to be returned. This status is only returned if the GET request itself fails.

Representations

Sample
Schema

{
  "code": "INTERNAL_PROCESSING_ERROR",
  "message": "An internal error occurred while processing."
}

{
  "type": "object",
  "properties": {
    "code": {
      "enum": [
        "PAYEE_NOT_FOUND",
        "PAYER_NOT_FOUND",
        "NOT_ALLOWED",
        "NOT_ALLOWED_TARGET_ENVIRONMENT",
        "INVALID_CALLBACK_URL_HOST",
        "INVALID_CURRENCY",
        "SERVICE_UNAVAILABLE",
        "INTERNAL_PROCESSING_ERROR",
        "NOT_ENOUGH_FUNDS",
        "PAYER_LIMIT_REACHED",
        "PAYEE_NOT_ALLOWED_TO_RECEIVE",
        "PAYMENT_NOT_APPROVED",
        "RESOURCE_NOT_FOUND",
        "APPROVAL_REJECTED",
        "EXPIRED",
        "TRANSACTION_CANCELED.",
        "RESOURCE_ALREADY_EXIST",
        "TRANSACTION_NOT_COMPLETED",
        "TRANSACTION_NOT_FOUND",
        "INFORMATIONAL_SCOPE_INSTRUCTION",
        "MISSING_SCOPE_INSTRUCTION",
        "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
        "UNSUPPORTED_SCOPE_COMBINATION",
        "CONSENT_MISMATCH",
        "UNSUPPORTED_SCOPE",
        "NOT_FOUND"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "code": {
      "enum": [
        "PAYEE_NOT_FOUND",
        "PAYER_NOT_FOUND",
        "NOT_ALLOWED",
        "NOT_ALLOWED_TARGET_ENVIRONMENT",
        "INVALID_CALLBACK_URL_HOST",
        "INVALID_CURRENCY",
        "SERVICE_UNAVAILABLE",
        "INTERNAL_PROCESSING_ERROR",
        "NOT_ENOUGH_FUNDS",
        "PAYER_LIMIT_REACHED",
        "PAYEE_NOT_ALLOWED_TO_RECEIVE",
        "PAYMENT_NOT_APPROVED",
        "RESOURCE_NOT_FOUND",
        "APPROVAL_REJECTED",
        "EXPIRED",
        "TRANSACTION_CANCELED.",
        "RESOURCE_ALREADY_EXIST",
        "TRANSACTION_NOT_COMPLETED",
        "TRANSACTION_NOT_FOUND",
        "INFORMATIONAL_SCOPE_INSTRUCTION",
        "MISSING_SCOPE_INSTRUCTION",
        "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
        "UNSUPPORTED_SCOPE_COMBINATION",
        "CONSENT_MISMATCH",
        "UNSUPPORTED_SCOPE",
        "NOT_FOUND"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "code": {
      "enum": [
        "PAYEE_NOT_FOUND",
        "PAYER_NOT_FOUND",
        "NOT_ALLOWED",
        "NOT_ALLOWED_TARGET_ENVIRONMENT",
        "INVALID_CALLBACK_URL_HOST",
        "INVALID_CURRENCY",
        "SERVICE_UNAVAILABLE",
        "INTERNAL_PROCESSING_ERROR",
        "NOT_ENOUGH_FUNDS",
        "PAYER_LIMIT_REACHED",
        "PAYEE_NOT_ALLOWED_TO_RECEIVE",
        "PAYMENT_NOT_APPROVED",
        "RESOURCE_NOT_FOUND",
        "APPROVAL_REJECTED",
        "EXPIRED",
        "TRANSACTION_CANCELED.",
        "RESOURCE_ALREADY_EXIST",
        "TRANSACTION_NOT_COMPLETED",
        "TRANSACTION_NOT_FOUND",
        "INFORMATIONAL_SCOPE_INSTRUCTION",
        "MISSING_SCOPE_INSTRUCTION",
        "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
        "UNSUPPORTED_SCOPE_COMBINATION",
        "CONSENT_MISMATCH",
        "UNSUPPORTED_SCOPE",
        "NOT_FOUND"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "code": "PAYEE_NOT_FOUND",
  "message": "string"
}

{
  "type": "object",
  "properties": {
    "code": {
      "enum": [
        "PAYEE_NOT_FOUND",
        "PAYER_NOT_FOUND",
        "NOT_ALLOWED",
        "NOT_ALLOWED_TARGET_ENVIRONMENT",
        "INVALID_CALLBACK_URL_HOST",
        "INVALID_CURRENCY",
        "SERVICE_UNAVAILABLE",
        "INTERNAL_PROCESSING_ERROR",
        "NOT_ENOUGH_FUNDS",
        "PAYER_LIMIT_REACHED",
        "PAYEE_NOT_ALLOWED_TO_RECEIVE",
        "PAYMENT_NOT_APPROVED",
        "RESOURCE_NOT_FOUND",
        "APPROVAL_REJECTED",
        "EXPIRED",
        "TRANSACTION_CANCELED.",
        "RESOURCE_ALREADY_EXIST",
        "TRANSACTION_NOT_COMPLETED",
        "TRANSACTION_NOT_FOUND",
        "INFORMATIONAL_SCOPE_INSTRUCTION",
        "MISSING_SCOPE_INSTRUCTION",
        "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
        "UNSUPPORTED_SCOPE_COMBINATION",
        "CONSENT_MISMATCH",
        "UNSUPPORTED_SCOPE",
        "NOT_FOUND"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "code": {
      "enum": [
        "PAYEE_NOT_FOUND",
        "PAYER_NOT_FOUND",
        "NOT_ALLOWED",
        "NOT_ALLOWED_TARGET_ENVIRONMENT",
        "INVALID_CALLBACK_URL_HOST",
        "INVALID_CURRENCY",
        "SERVICE_UNAVAILABLE",
        "INTERNAL_PROCESSING_ERROR",
        "NOT_ENOUGH_FUNDS",
        "PAYER_LIMIT_REACHED",
        "PAYEE_NOT_ALLOWED_TO_RECEIVE",
        "PAYMENT_NOT_APPROVED",
        "RESOURCE_NOT_FOUND",
        "APPROVAL_REJECTED",
        "EXPIRED",
        "TRANSACTION_CANCELED.",
        "RESOURCE_ALREADY_EXIST",
        "TRANSACTION_NOT_COMPLETED",
        "TRANSACTION_NOT_FOUND",
        "INFORMATIONAL_SCOPE_INSTRUCTION",
        "MISSING_SCOPE_INSTRUCTION",
        "MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
        "UNSUPPORTED_SCOPE_COMBINATION",
        "CONSENT_MISMATCH",
        "UNSUPPORTED_SCOPE",
        "NOT_FOUND"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://proxy.momoapi.mtn.com/collection/v2_0/payment/{x-referenceId}"
-H "Authorization: "
-H "X-Target-Environment: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Authorization", "");
            client.DefaultRequestHeaders.Add("X-Target-Environment", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://proxy.momoapi.mtn.com/collection/v2_0/payment/{x-referenceId}?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://proxy.momoapi.mtn.com/collection/v2_0/payment/{x-referenceId}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Authorization", "");
            request.setHeader("X-Target-Environment", "");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://proxy.momoapi.mtn.com/collection/v2_0/payment/{x-referenceId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("X-Target-Environment","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://proxy.momoapi.mtn.com/collection/v2_0/payment/{x-referenceId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"" forHTTPHeaderField:@"X-Target-Environment"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://proxy.momoapi.mtn.com/collection/v2_0/payment/{x-referenceId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '',
    'X-Target-Environment' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Authorization': '',
    'X-Target-Environment': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('proxy.momoapi.mtn.com')
    conn.request("GET", "/collection/v2_0/payment/{x-referenceId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Authorization': '',
    'X-Target-Environment': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('proxy.momoapi.mtn.com')
    conn.request("GET", "/collection/v2_0/payment/{x-referenceId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://proxy.momoapi.mtn.com/collection/v2_0/payment/{x-referenceId}')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['X-Target-Environment'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body