Cria um pedido de benefícios
POST
https://api.flashapp.services
/benefits/v1/orders
Headers
x-flash-authstring · required
Request Body
companyIdstring · requiredExample: jVZ0hM9pAXh5SPoqIzLxo
Responses
idstring · requiredExample: yvfSepYdwUI4SlUFkCAzQcompanyIdstring · requiredExample: BRzfhIEKnyOE4jopUAaXwstatusstring · enum · requiredEnum values:requestedbilledcanceledpaidavailablecreatedAtstring · date-time · requiredcreditTypestring · enum · requiredEnum values:accumulativedescriptionstringExample: Descrição para o pedidobillIdstringExample: UbZ8lwwN9i2OPcCbVGGuSpaymentMethodstring · enumEnum values:BILLETcreditDatestring · date-timetotalFeeintegerExample: 100totalAmountintegerExample: 10000
Busca um pedido pelo seu identificador
GET
https://api.flashapp.services
/benefits/v1/orders/{orderId}
path Parameters
orderIdstring · required
Headers
x-flash-authstring · required
Responses
idstring · requiredExample: yvfSepYdwUI4SlUFkCAzQcompanyIdstring · requiredExample: BRzfhIEKnyOE4jopUAaXwstatusstring · enum · requiredEnum values:requestedbilledcanceledpaidavailablewaiting_approvalcreatedAtstring · date-time · requiredcreditTypestring · enum · requiredEnum values:accumulativedescriptionstringExample: Descrição para o pedidonamestringExample: Nome do pedidobillIdstringExample: UbZ8lwwN9i2OPcCbVGGuSpaymentMethodstring · enumEnum values:BILLETBALANCEcreditDatestring · date-timetotalFeeintegerExample: 100totalAmountintegerExample: 10000
Adiciona um depósito de benefício à um colaborador
POST
https://api.flashapp.services
/benefits/v1/orders/{orderId}/deposits
path Parameters
orderIdstring · required
Headers
x-flash-authstring · required
Request Body
employeeIdstring · requiredExample: ZWB1x6jkPBI2Ac56FRJecemployeeNamestring · requiredExample: João da SilvaemployeeDocumentstring · requiredExample: 99999999999benefitIdstring · requiredExample: 6iKE5def3S3WF6XvE0FvLbenefitNamestring · requiredExample: Vale Refeiçãoamountinteger · requiredExample: 950
Responses
idstring · requiredExample: DjgJKJvYVBoMR_H94a9eborderIdstring · requiredExample: yvfSepYdwUI4SlUFkCAzQemployeeIdstring · requiredExample: ZWB1x6jkPBI2Ac56FRJecemployeeNamestring · requiredExample: João da SilvaemployeeDocumentstring · requiredExample: 99999999999benefitIdstring · requiredExample: 6iKE5def3S3WF6XvE0FvLbenefitNamestring · requiredExample: Vale Refeiçãoamountinteger · requiredExample: 950feeinteger · requiredstatusstring · enum · requiredEnum values:createdcanceledExample: createdcreatedAtstring · date-time · requiredExample: 2025-07-21T10:30:00.000Z
Cancela um depósito específico de um pedido
POST
https://api.flashapp.services
/benefits/v1/orders/{orderId}/deposits/{depositId}/cancel
path Parameters
orderIdstring · requireddepositIdstring · required
Headers
x-flash-authstring · required
Responses
idstring · requiredExample: DjgJKJvYVBoMR_H94a9eborderIdstring · requiredExample: yvfSepYdwUI4SlUFkCAzQemployeeIdstring · requiredExample: ZWB1x6jkPBI2Ac56FRJecemployeeNamestring · requiredExample: João da SilvaemployeeDocumentstring · requiredExample: 99999999999benefitIdstring · requiredExample: 6iKE5def3S3WF6XvE0FvLbenefitNamestring · requiredExample: Vale Refeiçãoamountinteger · requiredExample: 950feeinteger · requiredstatusstring · enum · requiredEnum values:createdcanceledExample: createdcreatedAtstring · date-time · requiredExample: 2025-07-21T10:30:00.000Z
Lista depósitos por colaborador
GET
https://api.flashapp.services
/benefits/v1/orders/deposits/employees/{employeeId}
path Parameters
employeeIdstring · required
query Parameters
statusstring · enumEnum values:pendingpageintegerDefault: 1limitinteger · min: 1Default: 100
Headers
x-flash-authstring · required
Request Body
companyIdstring · requiredExample: jVZ0hM9pAXh5SPoqIzLxo
Responses
dataobject[] · requiredpageinteger · requiredExample: 1limitinteger · requiredExample: 100countinteger · requiredExample: 2
Confirma um pedido finalizando a solicitação de depósitos
POST
https://api.flashapp.services
/benefits/v1/orders/{orderId}/confirm
path Parameters
orderIdstring · required
Headers
x-flash-authstring · required
Request Body
cnpjstring · requiredExample: 12345678901234paymentMethodstring · enum · requiredEnum values:BILLETBALANCEExample: BILLETadminEmailstring · requiredExample: admin@flashapp.com.brcreditDatestring · date-time · requiredExample: 2030-12-31T14:03:41.369Z
descriptionstringnamestring
Responses
idstring · requiredExample: yvfSepYdwUI4SlUFkCAzQcompanyIdstring · requiredExample: BRzfhIEKnyOE4jopUAaXwstatusstring · enum · requiredEnum values:requestedbilledcanceledpaidavailablewaiting_approvalcreatedAtstring · date-time · requiredcreditTypestring · enum · requiredEnum values:accumulativedescriptionstringExample: Descrição para o pedidonamestringExample: Nome do pedidobillIdstringExample: UbZ8lwwN9i2OPcCbVGGuSpaymentMethodstring · enumEnum values:BILLETBALANCEcreditDatestring · date-timetotalFeeintegerExample: 100totalAmountintegerExample: 10000
Cancela um pedido que ainda não tenha sido disponibilizado
POST
https://api.flashapp.services
/benefits/v1/orders/{orderId}/cancel
path Parameters
orderIdstring · required
Headers
x-flash-authstring · required
Request Body
cancelReasonstring · required
Responses
idstring · requiredExample: yvfSepYdwUI4SlUFkCAzQcompanyIdstring · requiredExample: BRzfhIEKnyOE4jopUAaXwstatusstring · enum · requiredEnum values:requestedbilledcanceledpaidavailablecreatedAtstring · date-time · requiredcreditTypestring · enum · requiredEnum values:accumulativedescriptionstringExample: Descrição para o pedidobillIdstringExample: UbZ8lwwN9i2OPcCbVGGuSpaymentMethodstring · enumEnum values:BILLETcreditDatestring · date-timetotalFeeintegerExample: 100totalAmountintegerExample: 10000
Busca Benefícios de uma empresa
GET
https://api.flashapp.services
/benefits/v1/benefits
query Parameters
companyIdstring · requiredstatusstringnamestring
Headers
x-flash-authstring · required
Responses
idstring · requiredcompanyIdstring · requiredstatusstring · enum · requiredEnum values:activeinactivenamestring · requiredemojistring · requireddescriptionstring · requireddescriptionAppstring · requireddescriptionDepositstring · requiredtransactionMethodsstring[] · requiredbilletCategoriesstring[] · requireddepositTimeUnitstring · enum · requiredEnum values:monthdaycreatedAtstring · requiredcategoriesobject[]depositFeesobject[]topupDepositEnabledboolean