Skip to main content
GET
List affiliations for a specific merchant

Authorizations

x-api-key
string
header
required

Company API key for authentication

Path Parameters

merchantId
string
required

The merchant ID

Query Parameters

provider
enum<string>

Filter by provider (accepts lowercase and uppercase, returns uppercase)

Available options:
CELCOIN,
RINNE,
CAPPTA
Example:

"CELCOIN"

status
enum<string>

Filter by status

Available options:
PENDING,
ACTIVE,
PROCESSING,
BLOCKED,
PENDING_APPROVAL,
WAITING_DOCUMENTS,
PROCESSING_DOCUMENTS,
REJECTED,
FAILED,
INVALID_SETTLEMENT_BANK_ACCOUNT,
CLOSED,
CANCELLED
enabled
boolean

Filter by enabled status

document_number
string

Filter by the merchant's CPF or CNPJ, formatted or not.

bank_account_operational_status
enum<string>

Filter by the operational status of the affiliation's bank account. Accepts lowercase and uppercase. Omit to return all affiliations.

Available options:
REGULAR,
JUDICIAL_BLOCK
page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100

Response

List of affiliations for the merchant

data
object[]
pagination
object