Skip to main content
POST
/
v1
/
affiliations
Create new affiliation
curl --request POST \
  --url https://api-sandbox.rinne.com.br/core/v1/affiliations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "provider": "CELCOIN",
  "allowed_capture_methods": [
    "EMV",
    "CONTACTLESS_ICC",
    "ECOMMERCE"
  ],
  "allowed_payment_methods": [
    "CREDIT_CARD",
    "DEBIT_CARD",
    "PIX"
  ]
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174002",
  "provider": "CELCOIN",
  "merchant_id": "12345678",
  "status": "ACTIVE",
  "enabled": true,
  "company_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
  "allowed_capture_methods": [
    "ECOMMERCE"
  ],
  "allowed_payment_methods": [
    "PIX"
  ],
  "organization_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
  "onboarding_documents": [
    {
      "id": "c5fdf2e4-1b9b-6108-aece-69991d5h4905",
      "file_type": "CNH_FRONT",
      "file_name": "CNH_FRONT_a1b2c3d4.pdf",
      "created_at": "2023-06-15T14:30:00.000Z",
      "content_type": "application/pdf",
      "file_size_bytes": 125430
    }
  ],
  "created_at": "2023-01-01T12:00:00.000Z",
  "updated_at": "2023-01-01T12:00:00.000Z",
  "provider_id": "prov_123456",
  "soft_descriptor": "MYSTORE",
  "mcc": "5411",
  "cost_policy_id": "123e4567-e89b-12d3-a456-426614174003",
  "provider_status_code": "200",
  "provider_status_message": "Merchant activated successfully",
  "provider_metadata": {},
  "onboarding_url": "https://provider.com/onboard/12345",
  "bank_account": {
    "id": "a2da4238-bdc2-47f9-b866-246cc87212d5",
    "bank_code": "001",
    "branch_number": "1234",
    "account_number": "567890",
    "account_holder_name": "John Doe",
    "account_holder_document_number": "81146431023",
    "ispb": "00000000"
  },
  "settlement_bank_account": {
    "id": "b3eb5349-cec3-48fa-c977-357dd98323e6",
    "branch_number": "1234",
    "account_number": "567890",
    "account_type": "CHECKING",
    "account_holder_name": "John Doe",
    "account_holder_document_number": "81146431023",
    "ispb": "00000000"
  },
  "prepayment_type": "AUTOMATIC",
  "prepayment_days": 1,
  "company_snapshot": {}
}

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

Body

application/json

Schema for creating a new affiliation

​
provider
enum<string>
required

Payment provider name (accepts lowercase and uppercase, returns uppercase)

Available options:
CELCOIN,
RINNE
Example:

"CELCOIN"

​
allowed_capture_methods
enum<string>[]
required

Allowed capture methods (at least one required)

Minimum array length: 1
Available options:
EMV,
MAGSTRIPE,
ECOMMERCE,
CONTACTLESS_ICC
Example:
["EMV", "CONTACTLESS_ICC", "ECOMMERCE"]
​
allowed_payment_methods
enum<string>[]
required

Allowed payment methods (at least one required)

Minimum array length: 1
Available options:
CREDIT_CARD,
DEBIT_CARD,
PIX,
BOLEPIX
Example:
["CREDIT_CARD", "DEBIT_CARD", "PIX"]
​
settlement_bank_account
object

External bank account for fund settlements. Required for RINNE provider, not required for CELCOIN (managed internally). The account_holder_document_number must match the company document_number.

​
prepayment_type
enum<string>
default:AUTOMATIC

Prepayment type for the affiliation. Defaults to AUTOMATIC if not provided.

Available options:
AUTOMATIC,
SPOT
Example:

"AUTOMATIC"

​
prepayment_days
integer
default:1

Number of days for prepayment. Must be at least 1. Defaults to 1 if not provided.

Required range: x >= 1
Example:

1

Response

Affiliation created 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
Example:

"CELCOIN"

​
merchant_id
string
required

Merchant ID in provider

Example:

"12345678"

​
status
enum<string>
required

Current affiliation status

Available options:
PENDING,
ACTIVE,
PROCESSING,
BLOCKED,
PENDING_APPROVAL,
WAITING_DOCUMENTS,
PROCESSING_DOCUMENTS,
REJECTED,
FAILED
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"

​
allowed_capture_methods
enum<string>[]
required

Allowed capture methods

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

Allowed payment methods

Available options:
CREDIT_CARD,
DEBIT_CARD,
PIX,
BOLEPIX
Example:
["PIX"]
​
organization_id
string
required

Associated organization ID

Example:

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

​
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

Example:

"Merchant activated successfully"

​
provider_metadata
object

Provider-specific metadata

Example:
{}
​
onboarding_url
string | null

Onboarding URL (only shown when status is not ACTIVE)

Example:

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

​
bank_account
object

Associated bank account information (created by provider)

​
settlement_bank_account
object

External bank account for fund settlements (provided by merchant, required for RINNE provider)

​
prepayment_type
enum<string>

Prepayment type for the affiliation

Available options:
AUTOMATIC,
SPOT
Example:

"AUTOMATIC"

​
prepayment_days
integer

Number of days for prepayment

Required range: x >= 1
Example:

1

​
company_snapshot
object

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