Skip to content
Equnix Metal
show

Payment Methods copied!

Payment Method Management

Retrieve all payment methods of an organization copied!

GET
/organizations/{id}/payment-methods

Returns all payment methods of an organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create a payment method for the given organization copied!

POST
/organizations/{id}/payment-methods

Creates a payment method.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    payment_method
     (required) in body

    Payment Method to create

    name, nonce

    {
        "name": "string",
        "nonce": "string",
        "default": "boolean"
    }

Retrieve a payment method copied!

GET
/payment-methods/{id}

Returns a payment method

  • Parameters
  • id
    string  (required) in path

    Payment Method UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Update the payment method copied!

PUT
/payment-methods/{id}

Updates the payment method.

  • Parameters
  • id
    string  (required) in path

    Payment Method UUID

    payment_method
     (required) in body

    Payment Method to update

    {
        "name": "string",
        "default": "boolean",
        "cardholder_name": "string",
        "expiration_month": "string",
        "expiration_year": "integer",
        "billing_address": "object"
    }

Delete the payment method copied!

DELETE
/payment-methods/{id}

Deletes the payment method.

  • Parameters
  • id
    string  (required) in path

    Payment Method UUID