show

Payment Method Management

Retrieve all payment methods of an organization

GET
/organizations/{id}/payment-methods

Returns all payment methods of an organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

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

Create a payment method for the given organization

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

GET
/payment-methods/{id}

Returns a payment method

  • Parameters
  • id
    string  (required) in path

    Payment Method UUID

    include
    string in query

    related attributes to include

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

Update the payment method

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

DELETE
/payment-methods/{id}

Deletes the payment method.

  • Parameters
  • id
    string  (required) in path

    Payment Method UUID