FictorPay
  • Introdução
  • Setup
    • Login
    • Webhooks
  • Estrutura
    • Conta
    • Saldo
  • Transacional
    • QR Code Estático
    • PIX out
  • Referências de API
    • Account
    • Auth
    • Partner
    • Pix
Powered by GitBook
On this page
  1. Referências de API

Partner

Last updated 1 year ago

Get partner all user

get

Get partner all user

Header parameters
authorizationstringRequired

authorization

Responses
200
OK
application/json
get
GET /mobile-bff/v1/partner/user HTTP/1.1
Host: 
authorization: text
Accept: */*
200

OK

{
  "created_at": "text",
  "partner_id": "text",
  "user_id": "text",
  "users": [
    {
      "email": "text",
      "id": "text",
      "nickname": "text",
      "phone_number": "text",
      "status": "active",
      "tax_id": "text",
      "username": "text"
    }
  ]
}

Get partner user all customer

get

Get partner user all customer

Header parameters
authorizationstringRequired

authorization

Responses
200
OK
application/json
get
GET /mobile-bff/v1/partner/user/{user_id} HTTP/1.1
Host: 
authorization: text
Accept: */*
200

OK

{
  "created_at": "text",
  "customers": [
    {
      "account_branch": "text",
      "account_id": "text",
      "account_number": "text",
      "account_type": "text",
      "created_at": "text",
      "customer_type": "person",
      "deleted_at": "text",
      "id": "text",
      "ispb": "text",
      "metadata": null,
      "name": "text",
      "provider_id": "text",
      "referral_code": "text",
      "status": "active",
      "tax_id": "text",
      "updated_at": "text"
    }
  ],
  "partner_id": "text",
  "user": {
    "email": "text",
    "id": "text",
    "nickname": "text",
    "phone_number": "text",
    "status": "active",
    "tax_id": "text",
    "username": "text"
  },
  "user_id": "text"
}

List partner webhook

get

List partner webhook

Header parameters
authorizationstringRequired

authorization

Responses
200
OK
application/json
get
GET /mobile-bff/v1/partner/webhook/ HTTP/1.1
Host: 
authorization: text
Accept: */*
200

OK

{
  "data": [
    {
      "created_at": {
        "error": null
      },
      "deleted_at": {
        "error": null
      },
      "id": "text",
      "partner_id": "text",
      "status": "active",
      "type": "all",
      "updated_at": {
        "error": null
      },
      "url": "text"
    }
  ]
}

Get partner webhook

get

Get partner webhook

Path parameters
webhook_idstringRequired

webhook_id

Header parameters
authorizationstringRequired

authorization

Responses
200
OK
application/json
get
GET /mobile-bff/v1/partner/webhook/{webhook_id} HTTP/1.1
Host: 
authorization: text
Accept: */*
200

OK

{
  "created_at": {
    "error": null
  },
  "deleted_at": {
    "error": null
  },
  "id": "text",
  "partner_id": "text",
  "status": "active",
  "type": "all",
  "updated_at": {
    "error": null
  },
  "url": "text"
}

Delete partner webhook

delete

Delete partner webhook

Path parameters
webhook_idstringRequired

webhook_id

Header parameters
authorizationstringRequired

authorization

Responses
204
No Content
delete
DELETE /mobile-bff/v1/partner/webhook/{webhook_id} HTTP/1.1
Host: 
authorization: text
Accept: */*
204

No Content

No content

Generate partner webhook secret

patch

Generate partner webhook secret

Path parameters
webhook_idstringRequired

webhook_id

Header parameters
authorizationstringRequired

authorization

Responses
200
OK
application/json
patch
PATCH /mobile-bff/v1/partner/webhook/{webhook_id}/secret HTTP/1.1
Host: 
authorization: text
Accept: */*
200

OK

{
  "id": "text",
  "partner_id": "text",
  "secret": "text"
}
  • GETGet partner all user
  • GETGet partner user all customer
  • POSTCreate partner webhook
  • GETList partner webhook
  • GETGet partner webhook
  • DELETEDelete partner webhook
  • PATCHUpdate partner webhook
  • PATCHGenerate partner webhook secret

Create partner webhook

post

Create partner webhook

Header parameters
authorizationstringRequired

authorization

Body
typestring · enumRequiredPossible values:
urlstringRequired
Responses
201
Created
application/json
post
POST /mobile-bff/v1/partner/webhook HTTP/1.1
Host: 
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "type": "all",
  "url": "text"
}
201

Created

{
  "id": "text",
  "partner_id": "text",
  "secret": "text"
}

Update partner webhook

patch

Update partner webhook

Path parameters
webhook_idstringRequired

webhook_id

Header parameters
authorizationstringRequired

authorization

Body
statusstring · enumRequiredPossible values:
typestring · enumRequiredPossible values:
urlstringRequired
Responses
200
OK
application/json
patch
PATCH /mobile-bff/v1/partner/webhook/{webhook_id} HTTP/1.1
Host: 
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "status": "active",
  "type": "all",
  "url": "text"
}
200

OK

{
  "created_at": {
    "error": null
  },
  "deleted_at": {
    "error": null
  },
  "id": "text",
  "partner_id": "text",
  "status": "active",
  "type": "all",
  "updated_at": {
    "error": null
  },
  "url": "text"
}