GET PaymentMethods

Overview

Request

GET /PaymentMethods?agentId=[agentId]&currencyCode=[currencyCode]&salesModel=[salesModel]

Request Information

Request Parameters

Name
Type
Requirement
Description
agentId
String
Mandatory 
Agent ID
currencyCode
String
Mandatory 
Currency Code
salesModel
String
Mandatory 
Sales Model

Response Information

Response Properties

Name
Type
Description
methods
List<PaymentMethod>
List of available payment methods

Methods

Name
Type
Description
id
Integer
payment method identifier
name
String
payment method name
currencyCode
String
currency code
sellingAgentId
Integer
selling agent identifier
paymentCards
List<PaymentCard>
List of allowed payment cards
onlineFlag
Boolean
payment method is for online payments

Paymentcards

Name
Type
Description
id
Integer
payment method identifier
name
String
payment card name
uniquePaymentMethodCode
String
unique payment method code

Response Codes

HTTP status code
Description
200 OK
The resource was retrieved successfully
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
404 Not Found
The specified resource was not found
500 Internal Server Error
An unexpected error occurred on the API server

Response Example

{
  "methods": [
    {
      "id": "21",
      "name": "Payment Gate",
      "currencyCode": "AUD",
      "sellingAgentId": 12345,
      "paymentCards": [
        {
          "id": "21",
          "name": "Visa",
          "uniquePaymentMethodCode": "scheme"
        },
        {
          "id": "21",
          "name": "Visa",
          "uniquePaymentMethodCode": "scheme"
        }
      ],
      "onlineFlag": null
    },
    {
      "id": "21",
      "name": "Payment Gate",
      "currencyCode": "AUD",
      "sellingAgentId": 12345,
      "paymentCards": [
        {
          "id": "21",
          "name": "Visa",
          "uniquePaymentMethodCode": "scheme"
        },
        {
          "id": "21",
          "name": "Visa",
          "uniquePaymentMethodCode": "scheme"
        }
      ],
      "onlineFlag": null
    }
  ]
}