v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB

payment_methods

Retorna um método de pagamento específico através do ID.

get/v1/payment_methods/{id}

idinteger required

ID do método de pagamento que deverá ser retornado.

Ok. Método de pagamento encontrado.

idinteger required

ID do método de pagamento

public_namestring required

Nome público do método de pagamento

namestring required

Nome interno do método de pagamento

codestring required

Código externo para referência via API

typestring required

Tipo do método de pagamento

status'active' | 'inactive' | 'deleted' required

Status do método de pagamento

settingsstring

Configurações específicas do método de pagamento

set_subscription_on_success'do_not_set' | 'set_without_authorization' | 'set_with_authorization' | 'legacy' required

Se configurado como "set_without_authorization", assinaturas pagas com sucesso através deste método serão automaticamente atribuídas ao mesmo

allow_as_alternativestring required

Indica se este método de pagamento será oferecido como alternativa para cobranças emitidas usando outros métodos

maximum_attemptsinteger

Número máximo de tentativas automáticas de cobrança para este método de pagamento

created_atstring required

Data e hora do cadastro do método de pagamento

updated_atstring required

Data e hora da última atualização do método de pagamento