Skip to main content

Register a payment method within a company

POST 
/v1/auth/consumer-users/company/:company_id/payment-methods

Request​

Path Parameters

    company_id stringrequired

    Unique ID of the company in scope.

Body

    id uuid

    The unique identifier of the object

    alias stringrequired

    User-friendly alias name

    external_id stringrequired

    Company id of the round up source

    provider stringrequired

    Possible values: [company, cents, stripe, mastercard]

    Provider of the payment method

    type stringrequired

    Possible values: [credit_card, debit_card, prepaid_card, main_account, saving_account]

    Type of the round up source

    default boolean

    If true this is the default payment method used if no payment is specified

Responses​

successful operation

Schema

    id uuid

    The unique identifier of the object

    alias stringrequired

    User-friendly alias name

    external_id stringrequired

    Company id of the round up source

    provider stringrequired

    Possible values: [company, cents, stripe, mastercard]

    Provider of the payment method

    type stringrequired

    Possible values: [credit_card, debit_card, prepaid_card, main_account, saving_account]

    Type of the round up source

    default boolean

    If true this is the default payment method used if no payment is specified

Loading...