Structure for Add Merchant Partner Requests

GET 
/api/v1/partner-profiles/structure

Using your bearer token to authenticate, fetch the fields that you will need to complete an Add Merchant Partner request. (Note that these fields have been previously agreed upon between you and Splitit.) In addition, note that the response's RequestUrlEndpoint here includes the full URL (including profileID) that you will need to add new merchants using the Add Merchant Partner endpoint.

Request

Responses

200

Success

Response Headers

application/json

Schema

Schema

Errors

object[]

Array [

Codestring

Messagestring

AdditionalInfostring

]

StatusCodeint32required
TraceIdstring
IsSuccessbooleanrequired

MetaData

object[]

The fields in question.

Array [

Fields

object[]

required

Array [

AccountFieldNamestringrequired

AccountFieldTypestringrequired

AllowedOptionsstring[]required

IsMandatorybooleanrequired

]

Accountrequired

RequestUrlEndpointstringrequired

Descriptionstringrequired

Methodstringrequired

AuthorizationHeaderstringrequired

]

Example (from schema)

{
  "Errors": [
    {
      "Code": "string",
      "Message": "string",
      "AdditionalInfo": "string"
    }
  ],
  "StatusCode": 0,
  "TraceId": "string",
  "IsSuccess": true,
  "MetaData": [
    {
      "Fields": [
        {
          "AccountFieldName": "string",
          "AccountFieldType": "string",
          "AllowedOptions": [
            "string"
          ],
          "IsMandatory": true
        }
      ],
      "Account": {},
      "RequestUrlEndpoint": "string",
      "Description": "string",
      "Method": "string",
      "AuthorizationHeader": "string"
    }
  ]
}

404

Not Found

Response Headers

application/json

Schema

Schema

Errors

object[]

Array [

Codestring

Messagestring

AdditionalInfostring

]

StatusCodeint32required
TraceIdstring
IsSuccessbooleanrequired

Example (from schema)

{
  "Errors": [
    {
      "Code": "string",
      "Message": "string",
      "AdditionalInfo": "string"
    }
  ],
  "StatusCode": 0,
  "TraceId": "string",
  "IsSuccess": true
}

500

Internal Server Error

Response Headers

application/json

Schema

Schema

Errors

object[]

Array [

Codestring

Messagestring

AdditionalInfostring

]

StatusCodeint32required
TraceIdstring
IsSuccessbooleanrequired

Example (from schema)

{
  "Errors": [
    {
      "Code": "string",
      "Message": "string",
      "AdditionalInfo": "string"
    }
  ],
  "StatusCode": 0,
  "TraceId": "string",
  "IsSuccess": true
}