1. Home

Data as JSON Document

Valid Enumerations

Data Path Values

creditorInformation.creditor.addressType

STRUCTURED | COMBINED

ultimateDebtor.addressType

STRUCTURED | COMBINED

paymentAmountInformation.currency

CHF | EUR

paymentReference.referenceType

NON | QRR | SCOR

QR Reference

{
  "creditorInformation":{
    "iban":"CH4431999123000889012",
    "creditor":{
      "addressType":"STRUCTURED",
      "name":"Robert Schneider AG",
      "streetName":"Rue du Lac",
      "houseNumber":"1268",
      "postalCode":"2501",
      "city":"Biel",
      "country":"CH"
    }
  },
  "paymentAmountInformation":{
    "currency":"CHF",
    "amount":1949.75
  },
  "ultimateDebtor":{
    "addressType":"STRUCTURED",
    "name":"Pia-Maria Rutschmann-Schnyder",
    "streetName":"Grosse Marktgasse",
    "houseNumber":"28",
    "postalCode":"9400",
    "city":"Rorschach",
    "country":"CH"
  },
  "paymentReference":{
    "referenceType":"QRR",
    "reference":"210000000003139471430009017",
    "additionalInformation":{
      "unstructuredMessage":"Instruction of 03.04.2019"
    }
  },
  "alternativeSchemes":{
    "alternativeSchemeParameters":[
      "Name AV1: UV;UltraPay005;12345",
      "Name AV2: XY;XYService;54321"
    ]
  }
}

Creditor Reference

{
  "creditorInformation":{
    "iban":"CH3709000000304442225",
    "creditor":{
      "addressType":"STRUCTURED",
      "name":"Robert Schneider AG",
      "streetName":"Rue du Lac",
      "houseNumber":"1268",
      "postalCode":"2501",
      "city":"Biel",
      "country":"CH"
    }
  },
  "paymentAmountInformation":{
    "currency":"CHF",
    "amount":199.95,
  },
  "ultimateDebtor":{
    "addressType":"STRUCTURED",
    "name":"Pia-Maria Rutschmann-Schnyder",
    "streetName":"Grosse Marktgasse",
    "houseNumber":"28",
    "postalCode":"9400",
    "city":"Rorschach",
    "country":"CH"
  },
  "paymentReference":{
    "referenceType":"SCOR",
    "reference":"RF18539007547034"
  }
}

Without Reference

{
  "creditorInformation":{
    "iban":"CH3709000000304442225",
    "creditor":{
      "addressType":"STRUCTURED",
      "name":"Robert Schneider AG",
      "streetName":"Rue du Lac",
      "houseNumber":"1268",
      "postalCode":"2501",
      "city":"Biel",
      "country":"CH"
    }
  },
  "paymentAmountInformation":{
    "currency":"CHF",
    "amount":3949.75,
  },
  "ultimateDebtor":{
    "addressType":"STRUCTURED",
    "name":"Pia-Maria Rutschmann-Schnyder",
    "streetName":"Grosse Marktgasse",
    "houseNumber":"28",
    "postalCode":"9400",
    "city":"Rorschach",
    "country":"CH"
  },
  "paymentReference":{
    "referenceType":"NON",
    "additionalInformation":{
      "unstructuredMessage":"Bill no. 3139 for gardening work and disposal of waste material"
    }
  }
}

Blank

{
  "creditorInformation":{
    "iban":"CH3709000000304442225",
    "creditor":{
      "addressType":"STRUCTURED",
      "name":"Salvation Army Foundation Switzerland",
      "postalCode":"3000",
      "city":"Berne",
      "country":"CH"
    }
  },
  "paymentAmountInformation":{
    "currency":"CHF"
  },
  "paymentReference":{
    "referenceType":"NON",
    "additionalInformation":{
      "unstructuredMessage":"Donation to the Winterfest Campaign"
    }
  }
}

Without Amount

{
  "creditorInformation":{
    "iban":"CH4431999123000889012",
    "creditor":{
      "addressType":"STRUCTURED",
      "name":"Salvation Army Foundation Switzerland",
      "postalCode":"3000",
      "city":"Berne",
      "country":"CH"
    }
  },
  "paymentAmountInformation":{
    "amount":2949.75,
    "currency":"CHF"
  },
  "ultimateDebtor":{
    "addressType":"STRUCTURED",
    "name":"Pia-Maria Rutschmann-Schnyder",
    "streetName":"Grosse Marktgasse",
    "houseNumber":"28",
    "postalCode":"9400",
    "city":"Rorschach",
    "country":"CH"
  },
  "paymentReference":{
    "referenceType":"QRR",
    "reference":"210000000003139471430009017",
    "additionalInformation":{
      "unstructuredMessage":"Donation to the Winterfest Campaign"
    }
  }
}

Full Example

{
  "creditorInformation":{
    "iban":"CH4431999123000889012",
    "creditor":{
      "addressType":"STRUCTURED",
      "name":"Robert Schneider AG",
      "streetName":"Rue du Lac",
      "houseNumber":"1268",
      "postalCode":"2501",
      "city":"Biel",
      "country":"CH"
    }
  },
  "paymentAmountInformation":{
    "amount":2949.75,
    "currency":"CHF"
  },
  "ultimateDebtor":{
    "addressType":"STRUCTURED",
    "name":"Pia-Maria Rutschmann-Schnyder",
    "streetName":"Grosse Marktgasse",
    "houseNumber":"28",
    "postalCode":"9400",
    "city":"Rorschach",
    "country":"CH"
  },
  "paymentReference":{
    "referenceType":"QRR",
    "reference":"210000000003139471430009017",
    "additionalInformation":{
      "unstructuredMessage":"Instruction of 03.04.2019",
      "billInformation":"//S1/10/10201409/11/190512/20/1400.000-53/30/106017086/31/180508/32/7.7/40/2:10;0:30"
    }
  },
  "alternativeSchemes":{
    "alternativeSchemeParameters":[
      "Name AV1: UV;UltraPay005;12345",
      "Name AV2: XY;XYService;54321"
    ]
  }
}

Combined Address

{
  "creditorInformation":{
    "iban":"CH4431999123000889012",
    "creditor":{
      "addressType":"COMBINED",
      "name":"Robert Schneider AG",
      "addressLine1":"Rue du Lac 1268",
      "addressLine2":"2501 Biel",
      "country":"CH"
    }
  },
  "paymentAmountInformation":{
    "amount":2949.75,
    "currency":"CHF"
  },
  "ultimateDebtor":{
    "addressType":"COMBINED",
    "name":"Pia-Maria Rutschmann-Schnyder",
    "addressLine1":"Grosse Marktgasse28",
    "addressLine2":"9400 Rorschach",
    "country":"CH"
  },
  "paymentReference":{
    "referenceType":"QRR",
    "reference":"210000000003139471430009017",
    "additionalInformation":{
      "unstructuredMessage":"Instruction of 03.04.2019"
    }
  }
}