Sign in

v1

latestOpenAPI 3.1.12026-07-2452287575.4 KB
Payment Methods

Archive a Payment Method

Archives a PaymentMethod. Archived PaymentMethods cannot be used for transactions. This action cannot be performed while the PaymentMethod has Payables in non-final states.

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

Path parameters

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

The Company ID.

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

The ID for the resource being accessed.

Request body

acting_team_memberstring uuid required

The ID of the TeamMember performing this action.

Response

OK

OR
OR
OR

Example response

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