Move a customer's references to another wallet

Moves every reference the customer has on the connector to another of your own wallets.

PUT /onramp/references

Move a customer's references to another wallet

cURL

curl --request PUT \
  --url https://api.zeam.money/gw/v1/onramp/references \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-zeam-auth: <api-key>' \
  --data '
{
  "connectorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "<string>",
  "settlementAccount": "<string>"
}
'

200

{
  "reference": "9505612345678901",
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "relatedReferences": [
    {
      "reference": "<string>",
      "metadata": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

Access token issued by POST /v1/auth/token.

x-zeam-auth · string · header · required

Application secret (the apiKey issued at registration), required on every request.

Body

application/json

connectorId · string<uuid> · required

customerId · string · required

settlementAccount · string · required

Another of your own wallets' Stellar public keys, with a trustline for the connector's settlement asset.

Pattern: ^G[A-Z2-7]{55}$

Response

200

application/json

The moved references.

reference · string · required

The provider's reference, for example the EasyPay number the customer pays against.

Example:

"9505612345678901"

routeId · string<uuid> · required

The connector id.

metadata · object | null

Provider-specific payment instructions, for example the bank details a Noah customer pays to. Null on a rebind.

Show child attributes

relatedReferences · object[] | null

Further references the provider issued for the same customer; null or empty when there are none.

Show child attributes