Create counterparties

Requisição

Create a new counterparty

Segurança

TokenAuth

Corpoapplication/jsonobrigatório

namestringobrigatório

The counterparty name

Exemplo:"Palisade"

descriptionstring

The counterparty description

Exemplo:"A counterparty used by the treasury department"

detailsobject(v2CounterpartyDetails)obrigatório

The counterparty details

curl -i -X POST \
  https://docs.ripple.com/_mock/pt-br/products/wallet/api-docs/palisade-api/palisade-api/v2/counterparties \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Palisade",
    "description": "A counterparty used by the treasury department",
    "details": {
      "type": "ORGANIZATION",
      "individual": {
        "firstName": "Joe",
        "lastName": "Bloggs",
        "address": {
          "address1": "Flat B",
          "address2": "10 Mayo Road",
          "city": "London",
          "state": "Greater London",
          "postCode": "W1 1AA",
          "country": "United Kingdom"
        }
      },
      "organization": {
        "legalName": "Palisade Financial",
        "address": {
          "address1": "Flat B",
          "address2": "10 Mayo Road",
          "city": "London",
          "state": "Greater London",
          "postCode": "W1 1AA",
          "country": "United Kingdom"
        }
      },
      "dApp": {}
    }
  }'

Respostas

Corpoapplication/json

idstringobrigatório

The counterparty ID

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"

createdBystringobrigatório

The ID of the user who created this counterparty

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"

createdAtstring, (date-time)obrigatório

The date and time the counterparty was created

Exemplo:"2022-03-29T10:22:22.420Z"

updatedBystringobrigatório

The ID of the user who updated this counterparty

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"

updatedAtstring, (date-time)obrigatório

The date and time the counterparty was updated

Exemplo:"2022-03-29T10:22:22.420Z"

namestringobrigatório

The counterparty name

Exemplo:"Palisade"

descriptionstring

The counterparty description

Exemplo:"A counterparty used by the treasury department"

detailsobject(v2CounterpartyDetails)obrigatório

The counterparty details

addressCountinteger, (int32)obrigatório

The number of addresses associated with the counterparty

Exemplo:5

Resposta

{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "name": "Palisade",
  "description": "A counterparty used by the treasury department",
  "details": {
    "type": "ORGANIZATION",
    "individual": { … },
    "organization": { … },
    "dApp": {}
  },
  "addressCount": 5
}