Skip to main content
GET
Get a specific affiliation for a merchant

Authorizations

x-api-key
string
header
required

Company API key for authentication

Path Parameters

merchantId
string
required

The merchant ID

id
string
required

The affiliation ID

Query Parameters

include_company_snapshot
boolean
default:false

Include company_snapshot (point-in-time company data at affiliation creation) in the response

Response

Affiliation details retrieved successfully

Transformed affiliation data returned by the API

id
string
required
Example:

"123e4567-e89b-12d3-a456-426614174002"

provider
enum<string>
required

Payment provider name

Available options:
CELCOIN,
RINNE,
CAPPTA
Example:

"CELCOIN"

merchant_id
string
required

Merchant ID in provider

Example:

"12345678"

status
enum<string>
required

Current affiliation status. WAITING_DOCUMENTS means the company has something to complete before the provider can decide; CANCELLED means the attempt was cancelled while waiting (cancellation_reason says why) and is over, so a new affiliation can be created.

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

"ACTIVE"

enabled
boolean
required

Whether the affiliation is enabled

Example:

true

company_id
string
required

Associated company ID

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2793"

onboarding_url
string | null
required

Link where the company completes what the provider asked for. Returned only while status is WAITING_DOCUMENTS; null in every other status, including after a cancellation.

Example:

"https://provider.com/onboard/12345"

onboarding_url_expires_at
string<date-time> | null
required

When onboarding_url stops working. Null while no expiry applies to the link, and in every status other than WAITING_DOCUMENTS. Always null until the onboarding flow is released.

Example:

"2026-11-06T12:00:00.000Z"

cancellation_reason
enum<string> | null
required

Why the affiliation is CANCELLED, null in every other status. REQUESTED when the company cancelled it; EXPIRED when the deadline to complete the requirements passed.

Available options:
REQUESTED,
EXPIRED,
null
Example:

null

rejection_reviewed_at
string<date-time> | null
required

When the provider's rejection of this attempt was reviewed and translated into the actions the company has to take. Null until then, and on an attempt that was never rejected. Always null until the onboarding flow is released.

Example:

null

allowed_capture_methods
enum<string>[]
required

Allowed capture methods

Available options:
EMV,
MAGSTRIPE,
ECOMMERCE,
CONTACTLESS_ICC
Example:
allowed_payment_methods
enum<string>[]
required

Allowed payment methods

Available options:
CREDIT_CARD,
DEBIT_CARD,
PIX,
BOLEPIX
Example:
organization_id
string
required

Associated organization ID

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2793"

gateway_mode
boolean
required

Whether this is a gateway-mode affiliation (Rinne acts as a pure capture gateway; no settlement, splits, or ledger entries)

Example:

false

onboarding_documents
object[]
required

List of onboarding documents associated with this affiliation

created_at
string<date-time>
required

Creation timestamp in ISO 8601 format

Example:

"2023-01-01T12:00:00.000Z"

updated_at
string<date-time>
required

Last update timestamp in ISO 8601 format

Example:

"2023-01-01T12:00:00.000Z"

provider_id
string | null

ID in provider system

Example:

"prov_123456"

soft_descriptor
string | null

Soft descriptor for transactions

Example:

"MYSTORE"

mcc
string

Merchant Category Code

Example:

"5411"

cost_policy_id
string | null

Associated cost policy ID

Example:

"123e4567-e89b-12d3-a456-426614174003"

provider_status_code
string | null

Provider-specific status code

Example:

"200"

provider_status_message
string | null

Provider-specific status message. An onboarding status change that carries no reason keeps the previous text, so it may predate status, except a move into ACTIVE, which clears it; a block, closure or reactivation of the account behind the affiliation replaces it, with an empty string when it carries none.

Example:

"Merchant activated successfully"

provider_metadata
object | null

Provider-specific metadata

Example:
bank_account
object | null

Associated bank account information (created by provider)

settlement_bank_accounts
object[]

Settlement bank accounts for this affiliation.

anticipation_type
enum<string>

Anticipation type for the affiliation

Available options:
AUTOMATIC,
SPOT
Example:

"AUTOMATIC"

anticipation_days
integer

Number of days for anticipation

Required range: x >= 1
Example:

1

company_snapshot
object | null

Point-in-time snapshot of company data (with contact) at affiliation creation. Only included when include_company_snapshot=true query parameter is set.