Příjemci a cíle

Účet zákazníka použijte, když zákazník vlastní koncový bod. Příjemce a cíl použijte, když prostředky přijímá jiná osoba nebo firma. Příjemce zaznamenává, kdo prostředky přijímá. Cíl zaznamenává, kde je přijímá.

1. Vytvořte příjemce

Vytvořte fyzickou osobu nebo firmu pomocí POST /v3/customers/{customerId}/recipients. Odešlete tyto hlavičky:

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 popisuje vztah příjemce k vašemu zákazníkovi. Vyberte hodnotu ze schématu požadavku POST /v3/customers/{customerId}/recipients. Při hodnotě other nepřidávejte doprovodné textové pole. Swipelux ignoruje pole, která schéma požadavku nedefinuje, takže by se text neuložil. Před vytvořením fiat cíle uveďte adresu. Uložte vrácené data.id příjemce jako RECIPIENT_ID a uchovejte jeho aktuální stav.

2. Přidejte cíl

Vytvořte koncový bod pomocí POST /v3/customers/{customerId}/recipients/{recipientId}/destinations. Pro tento zamýšlený cíl použijte nový klíč:

Request headers

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

Bankovní cíl
Cíl Pix
Cíl Pix Safe
Peněženkový cíl

{
  "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"
  }
}

Cíle Pix a Pix Safe přijímají BRL a vyžadují připravenou capability Pix zákazníka (pix_pooled). Cíl Pix platí na klíč Pix: CPF nebo CNPJ pouze v číslicích, telefonní číslo ve tvaru +55 následované 10 nebo 11 číslicemi, e-mail nebo náhodný klíč. Cíl Pix Safe platí na brazilský bankovní účet identifikovaný číslem CPF nebo CNPJ majitele v taxId, osmimístným kódem ISPB banky v bankCode, pobočkou a číslem účtu s kontrolní číslicí. Odpovědi a webhooky vracejí taxId maskované na poslední čtyři číslice. Swipelux při vytváření bankovního cíle ověřuje bankovní identifikátory, jako jsou IBAN, BIC, směrovací čísla ABA a čísla CPF nebo CNPJ, včetně kontrolních součtů. Chybně formátované hodnoty vrátí 400 validation_error. Tyto kontroly ověřují pouze formát, nikoli to, že účet existuje, ani kdo je jeho vlastníkem. self_custodied používejte pouze tehdy, když příjemce peněženku ovládá. Když peněženku drží jiný kustodián, postupujte podle aktuální varianty v API Reference. Uložte vrácené data.id cíle jako DESTINATION_ID a uchovejte jeho aktuální stav.

3. Počkejte na připravenost cíle

Přečtěte GET /v3/customers/{customerId}/recipients/{recipientId}/destinations/{destinationId} předtím, než vytvoříte quote. Pokračujte jen tehdy, když aktuální stav cíle umožňuje výplatu a jeho měna, metoda a síť odpovídají zamýšlenému přesunu. Stavy příjemce a cíle jsou nezávislé. Ve výplatním quote použijte ID cíle dst_. ID příjemce rcp_ identifikuje záznam vlastníka a není cílem quote. Dále vezměte připravený cíl do Odesílat prostředky.

Začínáme

Onboarding zákazníků

Vytvořte peněžní toky

Spuštění

Příjemci a cíle

1. Vytvořte příjemce

2. Přidejte cíl

3. Počkejte na připravenost cíle

​1. Vytvořte příjemce

​2. Přidejte cíl

​3. Počkejte na připravenost cíle

1. Vytvořte příjemce

2. Přidejte cíl

3. Počkejte na připravenost cíle