Recipients en destinations

Gebruik een klantrekening wanneer de klant het eindpunt bezit. Gebruik een recipient en destination wanneer een andere persoon of bedrijf het geld ontvangt. De recipient registreert wie het geld ontvangt. De destination registreert waar zij het ontvangen.

1. Maak de recipient aan

Maak een individu of bedrijf aan met POST /v3/customers/{customerId}/recipients. Verstuur deze headers:

Request headers

X-API-Key: ${SWIPELUX_API_KEY}
Idempotency-Key: recipient-create-001
Content-Type: application/json

Request body

{
  "type": "individual",
  "relationship": "contractor",
  "firstName": "Jason",
  "lastName": "Swipelux",
  "email": "jason@example.com",
  "phone": "+14155551234",
  "address": {
    "streetLine1": "1 Market Street",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94105",
    "country": "US"
  },
  "label": "Jason contractor"
}

relationship beschrijft de relatie van de recipient tot je klant. Kies een waarde uit het requestschema van POST /v3/customers/{customerId}/recipients. Voeg bij other geen vrij tekstveld toe. Swipelux negeert velden die het requestschema niet definieert, dus de tekst zou niet worden opgeslagen. Voeg het adres toe voordat je een fiat-destination aanmaakt. Bewaar de geretourneerde recipient data.id als RECIPIENT_ID en behoud de huidige status.

2. Voeg een destination toe

Maak het eindpunt aan met POST /v3/customers/{customerId}/recipients/{recipientId}/destinations. Gebruik een nieuwe key voor deze beoogde destination:

Request headers

X-API-Key: ${SWIPELUX_API_KEY}
Idempotency-Key: recipient-destination-create-001
Content-Type: application/json

Bank-destination
Pix-destination
Pix Safe-destination
Wallet-destination

{
  "type": "ach",
  "currency": "USD",
  "details": {
    "routingNumber": "021000021",
    "accountNumber": "123456789",
    "accountType": "checking",
    "bankName": "Example Bank",
    "accountHolderName": "Jason Swipelux",
    "country": "US"
  }
}

{
  "type": "pix",
  "currency": "BRL",
  "details": {
    "pixKey": "jason@example.com",
    "accountHolderName": "Jason Swipelux"
  }
}

{
  "type": "pix_safe",
  "currency": "BRL",
  "details": {
    "taxId": "52998224725",
    "bankCode": "00000208",
    "branchCode": "0001",
    "accountNumber": "123456-7",
    "accountType": "checking",
    "accountHolderName": "Jason Swipelux"
  }
}

{
  "type": "wallet",
  "currency": "USDC",
  "ownership": {
    "type": "self_custodied"
  },
  "details": {
    "network": "base",
    "address": "0x1111111111111111111111111111111111111111"
  }
}

Pix- en Pix Safe-destinations ontvangen BRL en hebben de ready Pix-capability van de klant nodig (pix_pooled). Een Pix-destination betaalt uit aan een Pix-sleutel: een CPF of CNPJ in alleen cijfers, een telefoonnummer als +55 gevolgd door 10 of 11 cijfers, een e-mailadres of een willekeurige sleutel. Een Pix Safe-destination betaalt uit aan een Braziliaanse bankrekening die wordt geïdentificeerd door de CPF of CNPJ van de houder in taxId, de 8-cijferige ISPB-code van de bank in bankCode, het filiaal en het rekeningnummer met het controlecijfer. Responses en webhooks retourneren taxId gemaskeerd tot de laatste vier cijfers. Swipelux valideert bankidentificaties zoals IBAN’s, BIC’s, ABA-routingnummers en CPF- of CNPJ-nummers, inclusief checksums, wanneer je een bank-destination aanmaakt. Onjuist opgemaakte waarden retourneren 400 validation_error. Deze controles bevestigen alleen het formaat, niet dat de rekening bestaat of wie de eigenaar is. Gebruik self_custodied alleen wanneer de recipient de wallet beheert. Volg de huidige API Reference-variant wanneer de wallet door een andere custodian wordt gehouden. Bewaar de geretourneerde destination data.id als DESTINATION_ID en behoud de huidige status.

3. Wacht op destination-readiness

Lees GET /v3/customers/{customerId}/recipients/{recipientId}/destinations/{destinationId} voordat je een quote aanmaakt. Ga alleen verder wanneer de huidige destination-status de uitbetaling toestaat en de valuta, methode en netwerk overeenkomen met de beoogde beweging. Recipient- en destination-statussen zijn onafhankelijk. Gebruik de dst_ destination-ID in de uitbetalingsquote. De rcp_ recipient-ID identificeert het eigenaarsrecord en is geen quote-destination. Neem de ready destination vervolgens mee naar Geld versturen.

Aan de slag

Klanten onboarden

Geldstromen bouwen

Live gaan

Recipients en destinations

1. Maak de recipient aan

2. Voeg een destination toe

3. Wacht op destination-readiness

​1. Maak de recipient aan

​2. Voeg een destination toe

​3. Wacht op destination-readiness

1. Maak de recipient aan

2. Voeg een destination toe

3. Wacht op destination-readiness