Get payment gateway

GET

/payment-gateways/{id}

const url = 'https://acme.mykreezalid.com/api/v1/payment-gateways/1';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://acme.mykreezalid.com/api/v1/payment-gateways/1 \
  --header 'Authorization: Basic <credentials>'

Retrieves a payment gateway from its unique identifier.

Authorizations

basic

Parameters

Path Parameters

required

integer

ID of the payment gateway

Responses

200

The payment gateway

application/json

A payment provider set up on your marketplace.

object

totalResultsCount

Number of results across all pages.

integer

currentPage

Number of the page returned, starting at 1.

integer

nextPage

Whether a next page exists.

boolean

prevPage

Whether a previous page exists.

boolean

resultOnPageCount

Number of results on this page.

integer

pageCount

Number of pages.

integer

object

Returned when you retrieve one gateway, not in the list

string

title

Name of the gateway

string

sandbox

Whether the gateway runs in test mode

boolean

nullable

status

string

nullable

currency

string

nullable

statement_descriptor

Text shown on the customers’ bank statements

string

nullable

min_transaction_size

Smallest amount accepted

number

nullable

max_transaction_size

Largest amount accepted

number

nullable

settings

Options of the gateway

object

created

string format: date-time

Example

{
  "totalResultsCount": 137,
  "currentPage": 1,
  "resultOnPageCount": 25,
  "pageCount": 6,
  "id": 432349,
  "object": "PaymentGateway",
  "currency": "EUR"
}

403

No payment gateway has this identifier.

application/json

Error body returned when the API refuses a request.

object

code

HTTP status code, repeated in the body.

integer

status

string

message

string

Example

{
  "code": 400,
  "status": "error",
  "message": "Some parameters are not correct"
}