Skip to content

Maintain OMNI Express

Overview

Create express transactions that combine User, Contract and single Instalment setup in one request.

Path

/v1/realpay/{merchant_number}/maintain/omni/express/{product}

Path Parameters

  • merchant_number (string, required)
  • product (string, required). Examples TJCARDZAR, ANYZAR

POST Create Express Transaction

Create Express Transaction.

Request Body Schema (POST)

ExpressPostRequest (object)

Request Example (POST)

Something to note

  • With "ANYZAR" product, ensure to include "TrackingCode": "ZZ00"
  • With "TJCARDZAR" product, ensure to include "TrackingCode": "TJ00"
{
    "ExpressTransactionPostRequest":
    [
        {
            "User":
            {
                "Name": "John",
                "Surname": "Smith",
                "DialCode": "+27",
                "Mobile": "823748818",
                "Email": "jsmith@ourcompany.com",
                "Country": "ZA",
                "ID": "8813053807087",
                "ClientId": "d90eedbda2514f6180c132c6018894a8",
                "Contract":
                {
                    "ContractNumber": "00110",
                    "InstalmentAmount": 99.99,
                    "NumberOfInstalments": 12,
                    "InstalmentStartDate": "2026-03-18",
                    "TrackingCode": "TJ00",
                    "FrequencyCode": "MNTH",
                    "CollectionDay": 18,
                    "UserDefinedField1": "44dda8be-0fca-46ba-a149-185722ab796d"
                }
            }
        }
    ]
}

Success Response (200) Schema (POST)

ExpressPostResponse

Response Example (POST)

{
    "ExpressTransactionPostResponse":
    [
        {
            "Successful":
            [
                {
                    "User":
                    {
                        "UserId": "ZA8813053807087",
                        "Name": "John",
                        "Surname": "Smith",
                        "DialCode": "+27",
                        "Mobile": "823748818",
                        "Email": "jsmith@ourcompany.com",
                        "Country": "ZA",
                        "ID": "8813053807087",
                        "ClientId": "d90eedbda2514f6180c132c6018894a8",
                        "Addresses": [],
                        "Contract":
                        {
                            "ContractSequence": 1000023034,
                            "ContractNumber": "00110",
                            "InstalmentStartDate": "2026-03-18 00:00",
                            "TrackingCode": "TJ00",
                            "NumberOfInstalments": 12,
                            "FrequencyCode": "MNTH",
                            "CollectionDay": 18,
                            "InstalmentAmount": 99.99,
                            "UserDefinedField1": "44dda8be-0fca-46ba-a149-185722ab796d",
                            "SubscriptionYN": "N",
                            "PaymentURL": "https://uat.realpaycollect.com/rpswitch/?data=F58C5B74C6195BA40B362200736926129:TJCARDZAR"
                        }
                    }
                }
            ],
            "Failed":
            []
        }
    ],
    "APIResponse":
    {
        "CallSequence": 36770453,
        "Status": "SUCCESS",
        "Version": "1.0.0",
        "Name": "RPWS_OMNI_EXPRESS_TRANS.ADD_EXPRESS_TRANSACTION_V2"
    }
}

Error Responses

  • 400 BadRequest
  • 401 Unauthorized
  • 404 NotFound
  • 409 Conflict
  • 500 InternalError
  • 503 ServiceUnavailable