Skip to content

Payments config

If the request is made without query parameters, a response will be received with incomplete transaction information. The merchant needs to fill in this data independently for correct display to the user

GET- payments/config (1)

AUTHORIZATIONS (2)

  1. Sandbox server (uses test data)
    https://api.sandbox.payerly.tech/v1/payments/config
    Production server (uses live data)
    https://api.payerly.tech/v1/payments/config

  2. BearerAuth

QUERY PARAMETERS

Parameter Type Description
orderId string The ID of the order from which the amount and currency will be filled, if this ID is provided.
amount string Provide the amount and currency to fill in the transaction data without creating an order
currency string Required if the amount is provided
##### RESPONSE HEADERS:
Parameter Type Description
Date string(date-time) The Date header indicates the server time.

Responses

200
{
  "googlepay": {
    "environment": "TEST",
    "isReadyToPayRequest": {
      "apiVersion": 2,
      "apiVersionMinor": 0,
      "allowedPaymentMethods": [
        {
          "type": "CARD",
          "parameters": {
            "allowedAuthMethods": [
              [
                "PAN_ONLY",
                "CRYPTOGRAM_3DS"
              ]
            ],
            "allowedCardNetworks": [
              [
                "AMEX",
                "DISCOVER",
                "INTERAC",
                "JCB",
                "MASTERCARD",
                "VISA"
              ]
            ],
            "allowPrepaidCards": true,
            "allowCreditCards": true,
            "assuranceDetailsRequired": true,
            "billingAddressRequired": true,
            "billingAddressParameters": {
              "format": "MIN",
              "phoneNumberRequired": true
            }
          },
          "tokenizationSpecification": {
            "type": "PAYMENT_GATEWAY",
            "parameters": {
              "gateway": "simbasoft",
              "gatewayMerchantId": "exampleGatewayMerchantId"
            }
          }
        }
      ],
      "existingPaymentMethodRequired": true
    },
    "paymentDataRequest": {
      "apiVersion": 2,
      "apiVersionMinor": 0,
      "merchantInfo": {
        "merchantId": "01234567890123456789",
        "merchantName": "ExampleMerchant"
      },
      "allowedPaymentMethods": [
        {
          "type": "CARD",
          "parameters": {
            "allowedAuthMethods": [
              [
                "PAN_ONLY",
                "CRYPTOGRAM_3DS"
              ]
            ],
            "allowedCardNetworks": [
              [
                "AMEX",
                "DISCOVER",
                "INTERAC",
                "JCB",
                "MASTERCARD",
                "VISA"
              ]
            ],
            "allowPrepaidCards": true,
            "allowCreditCards": true,
            "assuranceDetailsRequired": true,
            "billingAddressRequired": true,
            "billingAddressParameters": {
              "format": "MIN",
              "phoneNumberRequired": true
            }
          },
          "tokenizationSpecification": {
            "type": "PAYMENT_GATEWAY",
            "parameters": {
              "gateway": "simbasoft",
              "gatewayMerchantId": "exampleGatewayMerchantId"
            }
          }
        }
      ],
      "transactionInfo": {
        "currencyCode": "",
        "transactionId": "null",
        "totalPriceStatus": "FINAL",
        "totalPrice": ""
      },
      "emailRequired": false,
      "shippingAddressRequired": false,
      "shippingOptionRequired": false
    }
  },
  "applepay": {
    "apiVersion": "6",
    "paymentRequest": {
      "merchantCapabilities": [
        "supports3DS"
      ],
      "supportedNetworks": [
        [
          "amex",
          "chinaUnionPay",
          "discover",
          "interac",
          "masterCard",
          "privateLabel",
          "visa",
          "jcb",
          "cartesBancaires",
          "eftpos",
          "electron",
          "maestro",
          "vPay",
          "elo",
          "mada"
        ]
      ],
      "countryCode": "US",
      "requiredBillingContactFields": [
        [
          "email",
          "name"
        ]
      ],
      "total": {
        "type": "final",
        "label": "Demo (Card is not charged)",
        "amount": ""
      },
      "currencyCode": ""
    }
  }
}
400
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
401
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
402
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
403
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
404
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
405
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
429
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
default
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }