Register
POST {{host}}/payments/recurrency/register
Resumo
Esse endpoint registra um novo pagamento RECORRENTE para um Payer (parâmetro payer_id).
Veja as requisições de exemplo para mais detalhes de uso.
Observe que, se o método de pagamento não for boleto, será preciso adicionar um cartão no Payer antes de registrar o pagamento, usando o endpoint [Payer\Card\Save Credit Card]
Veja o exemplo de requisição Register Recurring Payment para mais detalhes de como fazer isso.
Request Body
{"payer_id"=>9, "name"=>"Recorrência {{$timestamp}}", "amount"=>9988, "card_payer_id"=>1, "is_boleto"=>false, "frequency"=>"monthly"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: Created
{"data":{"id":38,"name":"Pedido Recorrente 999 na EdyStore","amount":9988,"installments":6,"frequency":"bimonthly","is_boleto":false,"card":{"id":12,"business_id":1,"payer_id":16,"last_numbers":"4444","security_code":"123","active":true,"created_at":"2022-09-21T17:52:09.000000Z","updated_at":"2022-09-21T17:52:45.000000Z"},"active":true,"status":10,"status_label":"Disponível","start_date":"2022-09-22 13:40","created_at":"2022-09-22 13:40","updated_at":"2022-09-22 13:40"}}