List Participants

2min
Use this endpoint to get participants for your end-user(debtor).
GET
Request
Query Parameters
id
optional
String
Participant identify
name
optional
String
Participant name
slug
optional
String
Participant slug
status
optional
String
Participant status
enum: ACTIVE, INACTIVE
schedule
optional
Boolean
Support scheduled PIX payment
Only true effective
instant
optional
Boolean
Support Instant payment
Only true effective
Header Parameters
Authorization
required
String
Bearer token
Curl
Node.js
JS
Python
Ruby
curl --location 'https://api-testing.klavi.ai/payment/customer/v1/participants' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location 'https://api-testing.klavi.ai/payment/customer/v1/participants' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
[
    {
        "id":"9326f9b2-ae57-42c4-a0d9-acc4ba434696",
        "name":"Mercado Pago",
        "description":"O Mercado Pago, maior fintech da América Latina, atua no Brasil desde 2004 e tem como missão democratizar o acesso aos serviços financeiros e de pagamentos, contribuindo para a inclusão financeira e fomentando o poder de empreender na região.",
        "personType":"PF|PJ",
        "status":"ACTIVE",
        "slug":"mercado-pago",
        "avatar":"https://storage.googleapis.com/inic-data/mercado-pago.svg",
        "outage":false,
        "outageReason":null,
        "instantPaymentApiVersion": "v2",
        "scheduledPaymentApiVersion": "v4",
        "instant": true,
        "schedule": true
    },
    {
        "id":"7a7a9a8d-f086-44b6-b81e-215d516c27c1",
        "name":"Midway",
        "description":"A Midway é uma plataforma de bem estar financeiro. Através da conta digital gratuita, os consumidores podem ter acesso a empréstimos facilitados, seguros e assistências, ter seu dinheiro rendendo todo dia, sorteios mensais de R$ 10.000 e muito mais!",
        "personType":"PF|PJ",
        "status":"ACTIVE",
        "slug":"midway",
        "avatar":"https://storage.googleapis.com/inic-data/midway.svg",
        "outage":false,
        "outageReason":null,
        "instantPaymentApiVersion": "v2",
        "scheduledPaymentApiVersion": "v4",
        "instant": true,
        "schedule": true
    },
    {
        "id":"3f15766b-4fc1-4d22-b6ee-5eb05d6cec8f",
        "name":"Neon",
        "description":"Authorisation Server Neon",
        "personType":"PF|PJ",
        "status":"ACTIVE",
        "slug":"neon",
        "avatar":"https://storage.googleapis.com/inic-data/neon.svg",
        "outage":false,
        "outageReason":null,
        "instantPaymentApiVersion": "v2",
        "scheduledPaymentApiVersion": "v4",
        "instant": true,
        "schedule": true
    },
    {
        "id":"ba185564-2e26-420e-b6bb-af5bc7102480",
        "name":"next",
        "description":"O next é um banco digital completo e gratuito, criado para facilitar a vida das pessoas e ajudá-las a conquistar seus objetivos. Além de conta-corrente e cartões, oferece investimentos, crédito, empréstimos, seguros e promoções com lojas parceiras.",
        "personType":"PF",
        "status":"ACTIVE",
        "slug":"next",
        "avatar":"https://storage.googleapis.com/inic-data/next.svg",
        "outage":false,
        "outageReason":null,
        "instantPaymentApiVersion": "v2",
        "scheduledPaymentApiVersion": "v4",
        "instant": true,
        "schedule": true
    },
    {
        "id":"06c19499-3412-4125-84b7-d0fbc98b5019",
        "name":"Nubank",
        "description":"Simples, transparente e seguro: o Nubank é a empresa líder em tecnologia financeira na América Latina que já reinventou a vida financeira de mais de 40 milhões de clientes com conta digital, cartão de crédito, empréstimo, investimentos, seguros e mais.",
        "personType":"PF|PJ",
        "status":"ACTIVE",
        "slug":"nubank",
        "avatar":"https://storage.googleapis.com/inic-data/nubank.svg",
        "outage":false,
        "outageReason":null,
        "instantPaymentApiVersion": "v2",
        "scheduledPaymentApiVersion": "v4",
        "instant": true,
        "schedule": true
    }
]
[
    {
        "id":"9326f9b2-ae57-42c4-a0d9-acc4ba434696",
        "name":"Mercado Pago",
        "description":"O Mercado Pago, maior fintech da América Latina, atua no Brasil desde 2004 e tem como missão democratizar o acesso aos serviços financeiros e de pagamentos, contribuindo para a inclusão financeira e fomentando o poder de empreender na região.",
        "personType":"PF|PJ",
        "status":"ACTIVE",
        "slug":"mercado-pago",
        "avatar":"https://storage.googleapis.com/inic-data/mercado-pago.svg",
        "outage":false,
        "outageReason":null,
        "instantPaymentApiVersion": "v2",
        "scheduledPaymentApiVersion": "v4",
        "instant": true,
        "schedule": true
    },
    {
        "id":"7a7a9a8d-f086-44b6-b81e-215d516c27c1",
        "name":"Midway",
        "description":"A Midway é uma plataforma de bem estar financeiro. Através da conta digital gratuita, os consumidores podem ter acesso a empréstimos facilitados, seguros e assistências, ter seu dinheiro rendendo todo dia, sorteios mensais de R$ 10.000 e muito mais!",
        "personType":"PF|PJ",
        "status":"ACTIVE",
        "slug":"midway",
        "avatar":"https://storage.googleapis.com/inic-data/midway.svg",
        "outage":false,
        "outageReason":null,
        "instantPaymentApiVersion": "v2",
        "scheduledPaymentApiVersion": "v4",
        "instant": true,
        "schedule": true
    },
    {
        "id":"3f15766b-4fc1-4d22-b6ee-5eb05d6cec8f",
        "name":"Neon",
        "description":"Authorisation Server Neon",
        "personType":"PF|PJ",
        "status":"ACTIVE",
        "slug":"neon",
        "avatar":"https://storage.googleapis.com/inic-data/neon.svg",
        "outage":false,
        "outageReason":null,
        "instantPaymentApiVersion": "v2",
        "scheduledPaymentApiVersion": "v4",
        "instant": true,
        "schedule": true
    },
    {
        "id":"ba185564-2e26-420e-b6bb-af5bc7102480",
        "name":"next",
        "description":"O next é um banco digital completo e gratuito, criado para facilitar a vida das pessoas e ajudá-las a conquistar seus objetivos. Além de conta-corrente e cartões, oferece investimentos, crédito, empréstimos, seguros e promoções com lojas parceiras.",
        "personType":"PF",
        "status":"ACTIVE",
        "slug":"next",
        "avatar":"https://storage.googleapis.com/inic-data/next.svg",
        "outage":false,
        "outageReason":null,
        "instantPaymentApiVersion": "v2",
        "scheduledPaymentApiVersion": "v4",
        "instant": true,
        "schedule": true
    },
    {
        "id":"06c19499-3412-4125-84b7-d0fbc98b5019",
        "name":"Nubank",
        "description":"Simples, transparente e seguro: o Nubank é a empresa líder em tecnologia financeira na América Latina que já reinventou a vida financeira de mais de 40 milhões de clientes com conta digital, cartão de crédito, empréstimo, investimentos, seguros e mais.",
        "personType":"PF|PJ",
        "status":"ACTIVE",
        "slug":"nubank",
        "avatar":"https://storage.googleapis.com/inic-data/nubank.svg",
        "outage":false,
        "outageReason":null,
        "instantPaymentApiVersion": "v2",
        "scheduledPaymentApiVersion": "v4",
        "instant": true,
        "schedule": true
    }
]
﻿
Response​﻿
Attribute
Type
Description
personType
String
Business types supported by the payer’s bank.
PJ - Only support CNPJ
PF - Only support CPF
PF|PJ - Support both CNPJ and CPF
N/A - Unknown
﻿​﻿
Attribute	Type	Description
personType	String	Business types supported by the payer’s bank. PJ - Only support CNPJ PF - Only support CPF PF\|PJ - Support both CNPJ and CPF N/A - Unknown
Updated 29 May 2024
Did this page help you?
Generate Access Token
Create a Payment Initiation
List Participants

Response​﻿

Response
