Back to resources

Exploring the Graviti api

Get api v1 organizations payment providers by organizations id

Get a list of the payment providers within the organization by using organization id


GET/api/v1/Organizations/{id}/paymentProviders

Get a list of the payment providers within the organization, by organization ID

REQUEST INFORMATION

Parameters

Name

Type

Additional information

Key

String

 

Entity Id

String

 

Page Size

Integer

 

Page

Integer

 

Id

String

Required

x-api-key

Header

Required

x-api-secret 

Header

Required

 

RESPONSE INFORMATION

  • Code: 200
  • Description: successful
  • Media type: text/plain; application/json; text/json
  • Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "baseUrl": "string",
      "confirmationEmailAddress": "string",
      "displayText": "string",
      "id": "string",
      "isActive": true,
      "active": "string",
      "isSystemDefault": true,
      "systemDefault": "string",
      "paymentProvider": "string",
      "merchantId": "string",
      "merchantKey": "string",
      "merchantPassPhrase": "string",
      "organizationId": "string",
      "paymentNotifyUrl": "string",
      "paymentProcessingUrl": "string",
      "paymentProviderId": 0
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field

Type

Description

Base url

String

Base link of the payment

Confirmation email address

String

Confirmation email address used for the payment

Display text

String

Payment display text

Id

String

Internal ID to identify payments

Is active

Boolean

Status of the payment provider

Active

String

Status of the payment provider

Is system default

Boolean

System default status of the payment provider

System default

String

System default status

Payment provider

String

Payment provider name

Merchant id

String

Merchant id to identify merchant

Merchant key

String

Merchant key to identify merchant

Merchant pass phrase

String

Merchant pass phrase

Organization id

String

Unique ID identifying the organization associated with the Payment

Payment notify url

String

Payment notify url

Payment processing url

String

Payment processing url

Payment provider id

Integer

Payment provider id to identify payment provider

 



Related topics