Get a payment gateway | Payrexx Octri Demo

1 parameter

idintegerrequired

The integer identifier of the gateway to retrieve. Defaults to 0 when omitted.

Default:0

2 status codes

200Returns gateway data, including its amount, currency, identifier, payment link, and configuration.

dataarray<object>optional

statusstringoptional

404Returned when no gateway matches the supplied identifier.

errorobjectoptional

messagestringoptional

reasonstringoptional

statusstringoptional

Error handling

A 404 is returned when no gateway matches the id path parameter.

client := payrexxdemo.NewClient("https://api.payrexx.com/v1.16")

result, err := client.Gateway.Get(
	ctx,
	&GetGatewayParams{Id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21"},
)
if err != nil {
	log.Fatal(err)
}

{
  "data": [
    {
      "amount": 8925,
      "applicationFee": 0,
      "createdAt": 1475578052,
      "currency": "CHF",
      "fields": {
        "company": {
          "active": false,
          "mandatory": true
        },
        "country": {
          "active": false,
          "mandatory": true
        },
        "date_of_birth": {
          "active": false,
          "mandatory": true,
          "names": {
            "de": "",
            "en": "",
            "fr": "",
            "it": ""
          }
        },
        "email": {
          "active": false,
          "mandatory": true
        },
        "forename": {
          "active": false,
          "mandatory": true
        },
        "phone": {
          "active": false,
          "mandatory": true
        },
        "place": {
          "active": false,
          "mandatory": true
        },
        "postcode": {
          "active": false,
          "mandatory": true
        },
        "street": {
          "active": false,
          "mandatory": true
        },
        "surname": {
          "active": false,
          "mandatory": true
        },
        "text": {
          "active": false,
          "mandatory": true,
          "names": {
            "de": "Benutzerdefiniertes Feld (DE)",
            "en": "Benutzerdefiniertes Feld (EN)",
            "fr": "Benutzerdefiniertes Feld (FR)",
            "it": "Benutzerdefiniertes Feld (IT)"
          }
        },
        "title": {
          "active": false,
          "mandatory": true
        }
      },
      "hash": "db8c618c87dc91f100292f6ffd9c5044",
      "id": 1,
      "invoices": [],
      "link": "https://demo.payrexx.com/de/?payment=db8c618c87dc91f100292f6ffd9c5044",
      "pm": [],
      "preAuthorization": 0,
      "psp": [],
      "referenceId": "975382",
      "sku": "P01122000",
      "status": "(waiting|confirmed|authorized|reserved)",
      "vatRate": 7.7
    }
  ],
  "status": "success"
}

Request

Response

Errors