Vastaanottajat ja kohteet

Käytä asiakastiliä, kun asiakas omistaa päätepisteen. Käytä vastaanottajaa ja kohdetta, kun toinen henkilö tai yritys vastaanottaa varat. Vastaanottaja kirjaa, kuka vastaanottaa varat. Kohde kirjaa, missä he saavat ne.

1. Luo vastaanottaja

Luo yksityishenkilö tai yritys POST /v3/customers/{customerId}/recipients -toiminnolla. Lähetä nämä otsakkeet:

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 kuvaa vastaanottajan suhdetta asiakkaaseesi. Valitse arvo POST /v3/customers/{customerId}/recipients -pyyntöskeemasta. Jos lähetät arvon other, älä lisää vapaamuotoista tekstikenttää. Swipelux ohittaa kentät, joita pyyntöskeema ei määrittele, joten tekstiä ei tallennettaisi. Sisällytä osoite ennen fiat-kohteen luomista. Tallenna palautettu vastaanottajan data.id muuttujaan RECIPIENT_ID ja säilytä sen nykyinen tila.

2. Lisää kohde

Luo päätepiste POST /v3/customers/{customerId}/recipients/{recipientId}/destinations -toiminnolla. Käytä uutta avainta tälle aiotulle kohteelle:

Request headers

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

Pankkikohde
Pix-kohde
Pix Safe -kohde
Lompakkokohde

{
  "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- ja Pix Safe -kohteet vastaanottavat BRL:ää ja edellyttävät asiakkaan valmista Pix-kykyä (pix_pooled). Pix-kohde maksaa Pix-avaimeen, joka on pelkkinä numeroina annettu CPF- tai CNPJ-numero, puhelinnumero muodossa +55 ja sen perässä 10 tai 11 numeroa, sähköpostiosoite tai satunnainen avain. Pix Safe -kohde maksaa brasilialaiselle pankkitilille, joka yksilöidään tilinhaltijan CPF- tai CNPJ-numerolla kentässä taxId, pankin 8-numeroisella ISPB-koodilla kentässä bankCode, konttorilla ja tilinumerolla tarkistenumeroineen. Vastaukset ja webhookit palauttavat taxId-arvon peitettynä neljää viimeistä numeroa lukuun ottamatta. Swipelux validoi pankkitunnisteet, kuten IBAN-, BIC- ja ABA-routing-numerot sekä CPF- tai CNPJ-numerot tarkistesummineen, kun luot pankkikohteen. Virheellisesti muotoillut arvot palauttavat 400 validation_error -virheen. Nämä tarkistukset vahvistavat vain muodon, eivät sitä, että tili on olemassa tai kuka sen omistaa. Käytä self_custodied-arvoa vain, kun vastaanottaja hallitsee lompakkoa. Seuraa nykyistä API-referenssin muunnelmaa, kun lompakko on toisen säilyttäjän hallussa. Tallenna palautettu kohteen data.id muuttujaan DESTINATION_ID ja säilytä sen nykyinen tila.

3. Odota kohteen valmiutta

Lue GET /v3/customers/{customerId}/recipients/{recipientId}/destinations/{destinationId} ennen tarjouksen luomista. Jatka vain, kun kohteen nykyinen tila sallii maksun ja sen valuutta, menetelmä ja verkko vastaavat aiottua liikkumista. Vastaanottajan ja kohteen tilat ovat itsenäisiä. Käytä dst_-kohteen ID:tä maksun tarjouksessa. rcp_-vastaanottajan ID tunnistaa omistajatietueen, eikä se ole tarjouskohde. Seuraavaksi vie valmis kohde kohtaan Lähetä varoja.

Aloita

Asiakkaiden käyttöönotto

Rakenna rahavirrat

Julkaisu

Vastaanottajat ja kohteet

1. Luo vastaanottaja

2. Lisää kohde

3. Odota kohteen valmiutta

​1. Luo vastaanottaja

​2. Lisää kohde

​3. Odota kohteen valmiutta

1. Luo vastaanottaja

2. Lisää kohde

3. Odota kohteen valmiutta