Payment Methods

Create a Payment Method

Changed on

Create a new PaymentMethod attached to a Company.

Please note that there are four different creatable types of PaymentMethods: address, bank, international, and paypal. PaymentMethods of type card can only be created via the Invite a Company and Re-Invite a Company workflows.

Companies may have up to six bank and international PaymentMethods attached to them. This limit does not apply to other types of PaymentMethods.

post/v1/companies/{company_id}/payment-methods

Request

Path parameters

company_idstring uuid required
Example:8c581d79-bb84-4bc1-b1c5-8c073264a569

The Company ID.

Request body

OR
OR
OR

Example request

{
  "type_details": {
    "attention_line": "Attn: John Smith"
  }
}

Response

Created

OR
OR
OR
OR

Example response

{
  "type_details": {
    "attention_line": "Attn: John Smith"
  }
}

Changes

    • breaking

      added to the response body oneOf list for the response status

    • warning

      added the new GHS enum value to the /////// response property for the response status

    • warning

      added the new GHS enum value to the /////// response property for the response status

    • warning

      added the new MOP enum value to the /////// response property for the response status

    • warning

      added the new MOP enum value to the /////// response property for the response status

    • warning

      added the new card enum value to the ///// response property for the response status

    • warning

      added the new card enum value to the ///// response property for the response status

    • warning

      added the new card enum value to the ///// response property for the response status

    • warning

      added the new card enum value to the ///// response property for the response status

    • info

      added the new GHS enum value to the request property //////

    • info

      added the new MOP enum value to the request property //////

    • info

      added card mapping keys to the response discriminator for the response status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      the /// response's property pattern ^\d{18}$ was removed for the status