Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

GET Payments/[id] Function

Retrieves a single payment by its ID.


Syntax

GET https://api.commissionfactory.com/V1/Merchant/Payments/[id]?apiKey=[apiKey]

Parameters

Name Type Description
id
Required
Integer The ID of a single payment to retrieve.
apiKey
Required
String A valid API key that represents a merchant account.

Return Value

Type Description
Payment Represents a single payment.

Errors

Error Description
400 Bad Request One or more parameters could not be parsed correctly.
401 Unauthorised The API key is missing, invalid, or for a different account type; or the user account has been suspended or closed.
404 Not Found The requested item could not be found.
429 Too Many Requests The API call rate limit for the user account has been exceeded.
500 Internal Server Error An unexpected error occurred while processing your request.

JSON XML

Example

Request

GET /V1/Merchant/Payments/1?apiKey=ABC123 HTTP/1.1
Accept: application/json
Host: api.commissionfactory.com
GET /V1/Merchant/Payments/1?apiKey=ABC123 HTTP/1.1
Accept: application/xml
Host: api.commissionfactory.com

Response

{
    "Id": 1,
    "DateCreated": "2000-01-01T00:00:00.000",
    "Description": "Account Deposit",
    "Amount": 500.0000,
    "Balance": 500.0000
}
<Payment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <Id>1</Id>
    <DateCreated>2000-01-01T00:00:00.000</DateCreated>
    <Description>Account Deposit</Description>
    <Amount>500.0000</Amount>
    <Balance>500.0000</Balance>
</Payment>

Related Links